Project Setup - coldrockgames/gml-raptor GitHub Wiki

Raptor Project Setup

gml-raptor is not "just a library". It is a complete framework for professional game development.
This means, you start a "raptor-project", you do not "just include raptor into your game".

You have several choices, when setting up a raptor project:

  • Use the GameMaker project template that comes with the release of raptor (the classic way)

  • Create a repository on github and select gml-raptor as repository template. This will give you a perfectly set up project directly in your new repo. This is the recommended way.

  • Create a fork of the raptor repository. This is similar to creating from the repository template, but it also allows you to simply merge raptor updates by updating your fork! Be aware, that forking on Github does not allow you to change the visibility of a repository! This means, forking from the public gml-raptor repository, will make your repository also public and you can't change it. Recommended for open source games or game jams.

Did you fork? Important: Set your upstream!

After cloning the repository, as your first action, run the RaptorSetup Utility, if you are on Windows or execute the ux-set-upstream.sh script, when on Linux or MacOS.!
In the Setup Utility, make sure, you select gml-raptor as the Upstream for your fork.

[!NOTE] To run the setup utility, you need the Microsoft .net framework 9 or higher installed on your machine.

This will configure your fork to have the gml-raptor repository as upstream, thus allowing you to update your fork anytime.

[!NOTE] The Setup Utility is available for Windows only.

After creating or forking raptor, just start it and configure your project.

It will rename the project, create locale files, adapt encryption settings (if you are using raptor-pro), even does the setup of the index.html file for you, if you are planning a browser game. You may start the utility any time, even midway through development, to add a locale or change some of the settings.