Skip to main content

​
Prerequisites

Before you begin, ensure you have the following installed:
  • Unity Hub: Download from unity.com
  • Unity Editor 6000.3.2f1: The exact version specified in ProjectSettings/ProjectVersion.txt
  • Git: For cloning the repository
  • A code editor (Visual Studio, Visual Studio Code, or Rider recommended for C# development)
Using the exact Unity version (6000.3.2f1) is important to avoid potential compatibility issues with the project.

​
Installation

1

Clone the repository

Clone the PlatformerGame repository to your local machine:
git clone <repository-url>
cd PlatformerGame
2

Open Unity Hub

Launch Unity Hub on your computer.
3

Add project to Unity Hub

In Unity Hub:
  1. Click the Add button
  2. Navigate to the cloned repository folder
  3. Select the root folder containing the Assets and ProjectSettings directories
  4. Click Open
4

Verify Unity version

Unity Hub will display the required editor version (6000.3.2f1). If you don’t have this version installed:
  1. Click the Install Editor option
  2. Select version 6000.3.2f1 from the Unity Archive
  3. Wait for the installation to complete
5

Open the project

Click on the project in Unity Hub to open it with Unity Editor. The first open may take several minutes as Unity imports all assets.

​
Project structure

Once opened, you’ll find the following structure: 
Assets/
├── Animations/          # Character and sprite animations
├── Audio/              # Sound effects and background music
├── Fonts/              # UI fonts for menus and score display
├── InputSystem/        # Unity Input System configuration
├── Materials/          # Physics materials for player and surfaces
├── Prefabs/           # Reusable game objects
│   ├── Coins/         # Coin prefab variants
│   ├── Map/           # Level tile and platform prefabs
│   └── Sprites/       # Character and object sprite prefabs
├── Scenes/            # Unity scene files
│   ├── Title.unity    # Main menu scene
│   ├── Gameplay.unity # Main game level
│   └── Ending.unity   # End game scene
├── Scripts/           # C# source code
│   ├── Player/        # PlayerInput, PlayerJump, PlayerDeath, CollisionDetection
│   ├── Score/         # Coin, ScoreSystem, ScoreUpdate, ShowFinalScore
│   ├── SceneLogic/    # MainMenu, QuitGame, ResetGame, FinishGame
│   └── ScriptableObjectsScripts/  # PowerUp, JumpBoost, PowerUpPickUp
└── ScriptableObjects/ # PowerUp data assets

​
Running the game

1

Open the Title scene

In the Project window, navigate to Assets/Scenes/ and double-click Title.unity to open the main menu scene.
2

Enter Play mode

Click the Play button at the top center of the Unity Editor, or press Ctrl+P (Windows/Linux) or Cmd+P (Mac).
3

Start the game

Press Enter in the Game view to start playing from the Title scene.
4

Test gameplay

Use the controls (see Controls) to move, jump, and collect coins. Press Esc to exit Play mode.

​
Building the game

To create a standalone build:
  1. Go to File > Build Settings
  2. Ensure all three scenes are added in this order:
    • Title
    • Gameplay
    • Ending
  3. Select your target platform (PC, Mac & Linux Standalone)
  4. Click Build and choose an output directory
  5. Run the generated executable to play the game outside of Unity
The game uses Unity’s Input System package. If you encounter input-related errors, ensure the package is properly installed via Window > Package Manager.

​
Next steps

Now that your project is set up:
  • Learn the game controls to understand player input
  • Explore the codebase starting with the Player scripts in Assets/Scripts/Player/
  • Experiment with modifying power-up values in the ScriptableObjects folder
  • Try customizing level design in the Gameplay scene

Build docs developers (and LLMs) love

Get started for freeTalk to us