---

Create your own Mario Forever game with Thunder Engine.

Thunder Engine is a definitive open platform for Mario Forever games.
It allows you to create games with previously unseen level of flexibility and stability.

---

Current state: PRODUCTION READY
Required game engine:
Godot 4.4.1

---

How to use the Engine

Preparation

1. Get started with the template (stable, Godot 4.4.1) to create a new repository for your game. Make sure to choose PRIVATE visibility if you don't want your game sources to be open for everyone.

• Use the unstable template to try out the latest features of the engine.

2. Install Git.
3. Install Godot Engine 4.4.1 (standard edition). If you are going to program with C#, please choose Mono edition.

Installation

1. Open a terminal or a command line in a directory where you want to store your project.
   
2. Clone your project template to your computer:

git clone https://github.com/your-github-username/your-project-name --recursive
(Replace the github link there with your own github project repository link that you made in Preparation stage)

3. After cloning the project, navigate to it:

cd your-project-name

4. Update the engine:

git submodule update --remote

• If it gives an error, then enter these commands one by one: cd engine, git reset --hard, cd ..

5. Import the project to Godot Engine.

Notes and Hints

• If you need to edit or add something to your project, do not edit the engine folder. Instead, duplicate the desired scenes/resources/scripts from the engine to your project repository. Everything outside of the engine folder is considered as your own project.

• To make a new level, add a new scene with "Level" class as the root node. All required elements for the level will be created automatically.

• To make a new map, copy the scene at "res://engine/scenes/map/template.tscn" to your project. Similarly, you can copy "complete_template.tscn".

• To replace the default save room, main menu and credits scenes, copy the corresponding template scenes to your project first (The templates already include them). To change references, open up Project Settings, turn on "Advanced Settings", go to the Application/Thunder Settings section and replace the paths to match your project.

• Please keep an eye whenever the engine receives a new update. You can press the Watch button in this repository to get notifications, or join our Discord server and follow the #github-updates channel. New updates provide more functions and stability. To update it in your project, see Step 4 in the Installation section of this README document. Note that any changes you make inside the engine folder will be reset, unless you fork it and update the fork instead. (Forks cannot be private)

• Join our Discord Server for assistance.

---

All of the assets and GFX are all courtesy of Nintendo. This project is free and is not created for any sort of profit. We also do not condone commercial use of our engine.