Interested in becoming part of FreeRPG's development? Great! FreeRPG thrives off the contributions of its enthusiastic community, and we always welcome new members. Here's a few things you'll need to know before you dive in.

Branches

There are two main branches: freerpgmaster and freerpgdev. The freerpgmaster branch contains the current stable version of FreeRPG-Torque 3D. The freerpgdev branch is where all work is done prior to it being tested and moved to the freerpgmaster branch as determined by the developers.

Using the development branch

To start using the freerpgdev branch you will need to create your own fork of the repository:

  1. Create your own fork of the FreeRPG-Torque 3D repository by using the Fork button on Gitlab.
  2. Clone your FreeRPG-Torque 3D fork to your computer.
  3. Check out the freerpgdev branch from the Git command line: git checkout freerpgdev
  4. Add an upstream remote: git remote add upstream https://gitlab.com/FreeRPG/FreeRPG-Torque3D.git

To pull changes from the FreeRPG/FreeRPG-Torque3D freerpgdev branch into your developer fork: git pull upstream freerpgdev

To submit your changes back to the FreeRPG/FreeRPG-Torque3D freerpgdev branch, use the Pull Request page from Gitlab to make a request from your fork into the freerpgdev branch. Note that we highly recommend you not make any changes in the freerpgdev branch, but create a new branch for features you'd like to pull request, and a branch for all changes you don't want to contribute back to the main engine (for example a my-game branch). This makes it easier to contribute, and also easier to get the latest changes from the main repo!

How To Submit A Pull Request

The How To Submit A Pull Request Tutorial page is designed to give a quick look at the basics of how to properly prepare and submit a Pull Request

Code style guidelines

Please refer to the Code Style Guidelines if you want to contribute code back to the main engine. A consistent codebase is good for everyone!