Updated documentation and removed redundant steps in scripts (#2)

Author: LukeBrownYoYoGames

docs/HowToBuild.md

@@ -19,6 +19,7 @@ Before you begin, ensure you have the following installed and configured:
 
 - **Node.js 22+** - Download from [nodejs.org](https://nodejs.org/)
 - **GameMaker** - Any recent 2024.1400.3 Beta release (or newer), which you can download from [the release notes site](https://releases.gamemaker.io/) and must have also configured already for GX.games YYC development by following [its setup guide](https://github.com/YoYoGames/GameMaker-Bugs/wiki#platform-setup-guides)
+    - You may use older versions of GameMaker but will need to use the [GMEXT-Reddit Extension](https://github.com/YoYoGames/GMEXT-Reddit/) which includes the example project and requires you to build your game with the gx.games target rather than the reddit target. Further details can be found in the extension repository.
 - **Reddit Developer Account** - Sign up at [developers.reddit.com](https://developers.reddit.com/)
 
 ---
@@ -163,6 +164,9 @@ When you're ready to test your changes:
 
 ![Screenshot: GameMaker Run button highlighted](_screenshots/gamemaker-run-button.png)
 
+> [!IMPORTANT]
+> If not running on Windows, ensure that execute permissions are enabled on the `setup-gamemaker-devvit.sh` script within your devvit project
+
 GameMaker will:
 - Build your game to WebAssembly
 - Automatically copy the necessary files to your Devvit project directory (specified in Game Options)
@@ -308,6 +312,13 @@ export type SaveScoreRequest = {
 - Run `node --version` to check your version
 - Update Node.js if necessary: [Download latest version](https://nodejs.org/)
 
+### setup-gamemaker-devvit.sh Permissions Issue
+
+**Solution**
+- Ensure that execute permissions are enabled on the `setup-gamemaker-devvit.sh` script
+    - Run `ls -l setup-gamemaker-devvit.sh` to verify permissions
+- Run `chmod +x setup-gamemaker-devvit.sh` to grant execute permissions
+
 ---
 
 ## Additional Resources
@@ -319,6 +330,7 @@ export type SaveScoreRequest = {
 - [GameMaker Manual](https://manual.gamemaker.io/)
 - [GameMaker Reddit Template Repository](https://github.com/YoYoGames/GameMakerRedditTemplate)
 - [GameMaker Reddit Demo Project](https://github.com/YoYoGames/GM-RedditDemo)
+- [GameMaker Reddit Extension - For older versions of GameMaker](https://github.com/YoYoGames/GMEXT-Reddit)
 
 ---
 

docs/_screenshots/gamemaker-template.png

@@ -53,42 +53,17 @@ echo Devvit project: %cd%
 echo Copying GameMaker files to game directory...
 xcopy "%RUNNER_DIR%\*" "%CLIENT_PUBLIC%\" /Y /Q
 
-:: Replace template placeholders with project name
-echo Replacing template placeholders...
-
-:: Replace in package.json
-if exist "package.json" (
-    echo Updating package.json...
-    powershell -Command "(Get-Content 'package.json') -replace '<%%\s*name\s*%%>', '%PROJECT_NAME%' | Set-Content 'package.json'"
-)
-
-:: Replace in devvit.json
-if exist "devvit.json" (
-    echo Updating devvit.json...
-    powershell -Command "(Get-Content 'devvit.json') -replace '<%%\s*name\s*%%>', '%PROJECT_NAME%' | Set-Content 'devvit.json'"
-    powershell -Command "(Get-Content 'devvit.json') -replace '<%%\s*subreddit\s*%%>', '%SUBREDDIT_NAME%' | Set-Content 'devvit.json'"
-)
-
-:: Replace in server post.ts
-if exist "src\server\core\post.ts" (
-    echo Updating post.ts...
-    powershell -Command "(Get-Content 'src\server\core\post.ts') -replace '<%%\s*name\s*%%>', '%PROJECT_NAME%' | Set-Content 'src\server\core\post.ts'"
-)
-
 echo.
 echo GameMaker game setup complete!
 echo.
 echo Project configured:
 echo - Name: %PROJECT_NAME%
 echo - GameMaker files: Copied
-echo - Template placeholders: Replaced
 echo.
 echo Next steps:
-echo 1. Run "npm install" if you haven't already
-echo 2. Run "npm run dev" to start the development server
-echo 3. Your GameMaker game should now load in the Devvit app
+echo 1. Run "npm run dev" to start the development server
+echo 2. Your GameMaker game should now load in the Devvit app
 echo.
 echo Files copied:
-echo - All GameMaker files → src\client\public\game\
 echo - Core runtime files → src\client\public\ (root level)
 echo.

setup-gamemaker-devvit.bat

@@ -47,50 +47,17 @@ echo "Devvit project: $(pwd)"
 echo "Copying GameMaker files to game directory..."
 cp -r "$RUNNER_DIR"/* "$CLIENT_PUBLIC/"
 
-# Replace template placeholders with project name
-echo "Replacing template placeholders..."
-
-# Function to replace template placeholders
-replace_template() {
-    local file="$1"
-    if [ -f "$file" ]; then
-        echo "Updating $file..."
-        # Use sed with backup for compatibility across platforms
-        if [[ "$OSTYPE" == "darwin"* ]]; then
-            # macOS
-            sed -i '' "s/<% *name *%>/$PROJECT_NAME/g" "$file"
-            sed -i '' "s/<% *subreddit *%>/$SUBREDDIT_NAME/g" "$file"
-        else
-            # Linux
-            sed -i "s/<% *name *%>/$PROJECT_NAME/g" "$file"
-            sed -i "s/<% *subreddit *%>/$SUBREDDIT_NAME/g" "$file"
-        fi
-    fi
-}
-
-# Replace in package.json
-replace_template "package.json"
-
-# Replace in devvit.json
-replace_template "devvit.json"
-
-# Replace in server post.ts
-replace_template "src/server/core/post.ts"
-
 echo ""
 echo "GameMaker game setup complete!"
 echo ""
 echo "Project configured:"
 echo "- Name: $PROJECT_NAME"
 echo "- GameMaker files: Copied"
-echo "- Template placeholders: Replaced"
 echo ""
 echo "Next steps:"
-echo "1. Run \"npm install\" if you haven't already"
-echo "2. Run \"npm run dev\" to start the development server"
-echo "3. Your GameMaker game should now load in the Devvit app"
+echo "1. Run \"npm run dev\" to start the development server"
+echo "2. Your GameMaker game should now load in the Devvit app"
 echo ""
 echo "Files copied:"
-echo "- All GameMaker files → src/client/public/game/"
 echo "- Core runtime files → src/client/public/ (root level)"
 echo ""