📖 Design Document and Individual Reports

Design Document and all individual contribution reports can be found in the /docs folder of this repository.

👨‍💻 Development Setup

These instructions will get you a copy of the project up and running on your local machine for development and testing.

NOTE: This guide is meant for Windows users. If you are using Linux or macOS, please let me, Johnny, know!

✅ Prerequisites

• At least Godot 4, preferrably 4.4.1

  (There's a beta version of 4.5, but we should use the stable 4.4.1 release)

• Git installed on your machine. You can download it from git-scm.com.

  (You may need to restart your computer after installation.)

• Alternatively, you can use GitHub Desktop to clone the repository. Download it from desktop.github.com.

⚙️ Instructions

📥 VS Code extensions installation

Go to the Extensions tab in VS Code and put @recommended into the search bar. This will show you all the necessary extensions for this project.

📥 Download and Extract Godot

• Download Godot 4 Windows build from godotengine.org.

• IMPORTANT: Unzip Godot_v4.x.x-stable_win64.exe under C:\Godot.

  (This is important for running our setup script later on)

• Open Godot once for it to initialize the necessary directories, then close it.

🗃️ Clone the Repository

The most straightforward way is to use Git Bash CLI provided by Git

Open Git Bash where you want to clone the repository, then run:

git clone https://github.com/rmit-computing-technologies/assignment-2-tohardware.git

Alternatively, you can use GitHub Desktop to clone the repository and choose the destination folder.

🏗️ Run the Setup Script

The setup script will:

• Scan your system for your VS Code and Godot installations.
• Create the necessary VS Code settings file.
• Create a Godot addon script to toggle settings needed for VS Code integration.
• Register the project in the Godot config for it to show up on the launcher.

1. Go to the /setup folder in the cloned repository.
2. Run the setup.bat script
3. Wait for the script to finish running. It will prompt you to press any key when done.

NOTE: You will also notice that the Godot theme color is applied automatically afterwards.

🏁 Open the Project in Godot

After opening Godot again, you should see the project listed in the list. Click on it to open.

🌐 Conventions

To ensure development consistency across the project, please follow these conventions:

Coding and Structure

• Use snake_case for variables and functions; folder and file names.

• Use PascalCase for class names.

• Use UPPERCASE for constants.

• Group related stuff into separate folders and files.

• For code indentation, use tabs, not spaces.

• Try and have meaningful and descriptive comments, especially for functions, classes and other noteworthy sections of code. This helps others (and future you) understand the code better.

  • Ex: player.gd

    extends Node2D
    class_name Player
    # Handles player movement and interactions.
    
    const myConst = 200  # Constant for some purpose.
    var myVar = 0  # Variable for some purpose.
    
    # This function does something.
    func myFunc(param1: int, param2: String) -> void:
    	# This part does something
    	...some code
    
    	# This part does something else
    	...some more code

Workflow

• Before introducing any changes to the codebase:

  • Make sure to create a new branch from main
  • Branch name should try to follow the format type/short-description, where type can be:
    • assets (for adding or modifying assets)
    • docs (for documentation changes, like README or code comments)
    • refactor (for code refactoring)
    • feature (for new features)
    • fix (for fixing bugs)
    • Ex: feature/add-player-character
  • NOTES:
    • Branch names must NOT contain spaces. Use hyphens - to separate words instead.
    • You can do all the other stuff in a feature branch, but try to keep it minimal and focused on the main feature.

• When committing code:

  • Keep commit messages concise and descriptive.
  • Try your best to follow the format [type] message for commit messages, where type can be:
    • feat (for new features),
    • fix (for fixing bugs)
    • docs (for non code-related things like added code comments or README)
    • Ex: [feat] Added player assets

For other GDScript conventions, please refer to the Godot GDScript Style Guide.

🎮 How to Play

1. Simply download the file from the Release page, unzip the .exe and run it
2. To play the game:
   • Press Enter to start.
   • Pause the game by pressing Esc.
   • After losing, press Enter to go back to the Main Menu.
   • Use WASD or Arrow keys to move the player.
   • Use J or Z to shoot.
   • On the Main Menu, hold = in 3 seconds to reset the highscore

🛠️ How to Compile

To compile the game, follow these steps:

1. Open the project in Godot.
2. Go to the Project menu and select Export.
3. Choose the target platform (e.g., Windows).
4. (Optional) Configure rcedit: Go to Editor Settings > Export > Windows, then choose the included rcedit.exe file in /build_tools.
5. Click on Export Project and choose the destination folder.
6. Click Save to export the project.
7. Just run the .exe file in the destination folder to play the game.

📄 Licenses

This project uses MIT license for demo and educational purposes. See LICENSE for details.

However, audio assets are NOT covered by the MIT license and are subject to separate terms. See ASSETS_LICENSE for details.