FlappyBirdUnityTutorial

Following the Game Makers Toolkit tutorial (https://www.youtube.com/watch?v=XtQMytORBmM) to learn Unity and game development.

Assets

Sound Assets

• RPG Essentals SFX Free
  • On flap: 30_Jump_03.wav
  • On death: 52_Dive_02.wav
  • On gain point: 001_Hover_01.wav
  • On break record: 013_Confirm_03.wav

Background music

• Beach - by Sakura Girl

Building and Running locally

Requirements

• Unity v2022.3.21f1
• Visual Studio v17.9.2
  • With "Game development with Unity" extension
• Python v3.12.2
• Nuke v8.0.0 (Installed from commandline: dotnet tool install Nuke.GlobalTool --global)

Configuring Github release capabilities

In the .nuke/parameters.secrets.json the GitHubPersonalAccessToken parameter is defined. https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token describes how to define one for the Build Script. The token requires the following grants:

• Read+Write to contents (needed for creating Releases and uploading files to a release)

To generate the .nuke/parameters.secrets.json file:

1. Open commandline in repository root.
2. Run nuke :secrets secrets
3. Provide a password (Save this to something like a Password Safe, as you'll require to provide it for build targets that depend on secrets)
4. Navigate the menu to GitHubPersonalAccessToken and provide a value.
5. Navigate the menu to <Save and Exit>.

Building a Github Release (build script)

1. Open commandline in repository root.
2. Run nuke --target CreateReleaseOnGithub --profile secrets --Version x.y.z
   • The Version parameter can optionally be post-fixed with -alpha or -beta
   • Not specifying the Version parameter causes the script to ask you interactively in the commandline
3. Provide the password for the secrets file

Building a Windows Release (build script)

32bit

1. Open commandline in repository root.
2. Run nuke --target BuildWin32BitReleaseZipFile --Version x.y.z
   • The Version parameter can optionally be post-fixed with -alpha or -beta
   • Not specifying the Version parameter causes the script to ask you interactively in the commandline
3. The zip-file can be found in <repo root>\Builds\winx86

64bit

1. Open commandline in repository root.
2. Run nuke --target BuildWin64BitReleaseZipFile --Version x.y.z
   • The Version parameter can optionally be post-fixed with -alpha or -beta
   • Not specifying the Version parameter causes the script to ask you interactively in the commandline
3. The zip-file can be found in <repo root>\Builds\winx64

Creating Release Commit

1. Open commandline in repository root.
2. Run nuke --target CreateReleaseCommitAndPush --Version x.y.z
   • The Version parameter can optionally be post-fixed with -alpha or -beta
   • Not specifying the Version parameter causes the script to ask you interactively in the commandline

Windows (build script)

32bit

1. Open commandline in repository root.
2. Run nuke --target BuildAppAsWin32bit.
3. Build can be found in <repo root>\Builds\winx86.

64bit

1. Open commandline in repository root.
2. Run nuke --target BuildAppAsWin64bit.
3. Build can be found in <repo root>\Builds\winx64.

Windows (manual)

1. From repository root, open GameMakersToolkitFlappyBirdTutorial folder.
2. File > Build Settings
3. Ensure Platform Windows, Mac, Linux is active.
   • If not, click the Switch Platform button in the lower right corner and wait for the switch to finish.
4. Click the 'Build and Run' button.
5. When asked, determine the location to build
   • Recommendation 32 bit: <repo root>\Builds\winx86 for an Windows target platform and Intel 32-bit architecture
   • Recommendation 64 bit: <repo root>\Builds\winx64 for an Windows target platform and Intel 64-bit architecture
6. Wait for the build to complete. The game will start automatically after.

HTML 5 (manual)

1. From repository root, open GameMakersToolkitFlappyBirdTutorial folder.
2. File > Build Settings
3. Ensure Platform WebGL is active.
   • If not, click the Switch Platform button in the lower right corner and wait for the switch to finish.
4. Click the 'Build' button.
5. When asked, determine the location to build
   • Recommendation: <repo root>\Builds\html5
6. Wait for the build to complete.
7. Navigate into the build folder.
8. Open a command line in that folder.
9. Run the command: python -m http.server
10. Open a browser. Naviate to localhost:8000 (assuming 8000 portnumber; Specific port number is mentioned in the command line window). Game is now started.