Godot 4 - 2D Platformer Template

A simple template for a 2D platformer to help kickstart any Godot project
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

This project is designed to help jumpstart your game with minimal fuss. It has many options to help you dial in the movement so it's perfect for your needs.

Built With

• Godot 4.1.1
• Kenny's Assets

General Information

This template includes the following features:

• Movement Controls:
  • Max Speed - Maximum speed reachable by player
  • Min Speed - Minimum speed reachable by player
  • Acceleration - Acceleration while on the ground (how quickly the player reaches max speed)
  • Friction - Friction while on group (how quickly the player slows down)
  • Air Acceleration - Acceleration while in the air (how quickly the player reaches max speed)
  • Air Resistance - Air friction while in the air (how quickly the player slows down)
  • Is Variable Max Speed - Sets a variable max speed depending on how far the joystick is pushed (for analog controls)
  • Is Variable Min Speed - sets a minimum speed based on min_speed
• Jump Settings:
  • Jump Height - The height a jump will reach at its peak
  • Jump Time To Peak - Amount of time it takes the player to reach the peak of their jump
  • Jump Time To Descent - Amount of time it takes the player to fall from the peak of their jump to the ground
  • Variable Jump Height - Determains if a player jump highet changes depending on how long they held the action
  • Minimum Jump Height - Determains the minumum jump heighet a player can reach if they barely tap the jump button (and variable_jump_height is true)
• Jump Assist:
  • Coyote Timer Value - Max amount of time allowed after leaving the ground while still being able to jump
  • Jump Buffer Timer Value - Max amount of time the game holds on to the player's input to execute when viable
• A simple level to play around in and test out the capabilities

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This template is designed to work with Godot 4.1.1+. You'll need to go download Godot from their offical website to use this template.

Usage

• Go to the Repo and click "Use this template"
• Or download the source, unzip it, and you're good to go!

Set Your Game Up

1. Launch Godot and select the import option. Locat the folder you downloaded and select it.
2. ...
3. Profit?

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Project Link: https://github.com/eladkarni/godot4-2d-platformer-template

Acknowledgements

• GDQuest
• Godot Community
• The One & Only - KENNY
• Odinn1984 Godot 4 C# Template