The Setup Utility - coldrockgames/gml-raptor GitHub Wiki

Most people develop on the windows platform. For those, we created a full project management tool for your raptor project:

image

The tool contains the same functionality for raptor-free and raptor-pro. There's no difference.
Let's take a look at the different sections of the tool:

Account & Project

image

  • The tool detects your Yoyo Account name. This is needed to provide layout files when setting up the project. If the account shown, is not your main account, use the dropdown to select the account, where you want the raptor project to be anchored.
  • The Project dropdown lists all the .yyp files found in the game directory of the current repository. Select the one, you want to modify.
  • And finally, the Upstream list shows the possible upstream repositories, if you created your project through a fork of raptor. You can completely ignore this, if you created your project through the "Use this template" button on the github page of the raptor repository.|

Project Data

image

  • Choose the name of the yyp project file. You do not have to rename it, but if you want to, do it here.
  • The Game Display Name is the string in the header of the game window (or the browser tab, if you do html). Provide the english default name here. You can translate it into other languages through the LG files.
  • Automatic Build Numbers. Raptor offers a pre_project_step.bat shell script, which will automatically count up on every build (F5/F6 press) during development. By default, this is on for game projects. Klick the ? help icon to get more information.

Supported Languages

image

Check all the languages, you want to support in your game. The list contains the top 10 gaming markets.

[!NOTE] You can start the setup utility any time during development or close to release, to add more languages! You do not have to decide this now!
When you create a new language, the english file will be copied to the new locale folder. So, the later you do this, the better!

Legal Data

image

These are the default strings from the LG system, that identify your game. You can change them here or simply adapt the locale.json files for each language directly.

HTML/Browser Settings

image

If you plan to run your game on the HTML target, you can tell the setup utility to prepare the index.html file to contain the correct javascript file name, as well as resizing your room to the default browser aspect ratio (which is not 1080p 16:9! because the browser has a toolbar and a favorites bar).

Rooms

image

Now this is the most important section! The tool offers some standard rooms names like Intro and Settings and also allows you to add up to five rooms per run of the utility directly into your yyp project!

You can add new rooms any time during development. Using the setup utility saves you from using the _room_template yymps package provided with a raptor release. You can add rooms with a few clicks directly in the yyp here.