Overview
Thank you for your interest in contributing to PlatformerGame! This guide will help you get started with setting up the project and understanding our development workflow.Project Setup
Prerequisites
- Unity (compatible version as specified in the project)
- Git for version control
- A code editor (Visual Studio, VS Code, or Rider recommended)
Getting Started
- Clone the repository:
-
Open the project in Unity:
- Launch Unity Hub
- Click “Open” and select the project directory
- Wait for Unity to import all assets
-
Verify the setup:
- Open the main scene
- Press Play to ensure the game runs correctly
Development Guidelines
Following Coding Conventions
This project follows strict coding conventions to maintain code quality and consistency. Please review and follow these guidelines:Coding Conventions
C# coding standards, naming conventions, and formatting rules
Assets Organization
Asset management and directory structure conventions
Key Conventions to Remember
- Use TitleCase for classes, public fields, and methods
- Use lowerCase for private fields and method parameters
- Always initialize fields when declaring them
- Use 4 spaces for indentation (no tabs)
- Follow the established directory structure for assets
- Use descriptive file names with TitleCase (no spaces or special characters)
Testing the Game
Controls
When testing gameplay, use the following controls:Keyboard
- Move: WASD and arrow keys
- Jump: Space and up arrow
- Start: Enter
- Quit: Esc
Features to Test
Make sure to test all core features:Submitting Changes
Before Submitting
Commit Guidelines
- Write clear, descriptive commit messages
- Keep commits focused on a single change or feature
- Reference issue numbers when applicable
Developers
PlatformerGame is developed by:- Alexia Martínez - Programmer, Animator
- Arnau Badenas - Programmer
- Carla Pallés - Programmer, Designer
License
Source Code
This game’s source code is licensed under the MIT License. This means:- You are free to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the software
- The software is provided “as is”, without warranty of any kind
Assets
Art and music assets have separate licenses. See LICENSES.txt for details on asset licenses.PlatformerGame © 2026 by Arnau Badenas, Alexia Martínez, Carla Pallés
Questions or Issues?
If you have questions or encounter issues:- Check existing documentation
- Review the coding conventions and asset organization guides
- Contact the development team