Game Settings

the settings file

Located in config/settings.xml, this file contains settings regarding window dimensions, volumes, and world-related stuff. This file is read in on engine initialization, and volume levels are updated with each game save/exit.

A sample settings file is located at config/settings.xml.example, and can be used as a template when first setting up the engine.

---

settable values

<screen width="1024" height="800" fullscreen="false" />

width: The desired width of the window, in pixels.
height: The desired height of the window, in pixels.
fullscreen: Whether or not to run the game in fullscreen mode (currently not toggleable otherwise).

<world start="xml/" />

start: The folder to look in for XML files. XML files that reference others will not need this prefixed to the filename, as this is appended when loading them. The slash is most likely necessary.

<font path="ttf/FreePixel.ttf" />

path: The location of the desired font to use for text. MUST be a TrueType font.

<hline size="5" />

size: The size of an HLINE. HLINEs are the main 'unit' of measurement within the engine, textures and things like collision detection are based on HLINEs. This is sort of like a dpi setting, smaller values get smaller everythings.

<volume>
    <master volume="50" />
    <music volume="100" />
    <sfx volume="100" />
</volume>

volume: The volume level for the given channel. A decimal number from 0 to 100.
The master channel sets the maximum the other channels can reach. That is, if master is at 50 and another channel is at 100, that 100 will only sound half as loud.
The 'music' volume controls background music volume. The 'sfx' volume controls sound effects volume.