User guide¶

This guide covers installing, configuring, and playing OpenReliant.

Table of contents¶

• Installation: Requirements, installing from retail StarLancer discs or disc images, and running the game.
• Controllers and input: Setting up gamepads, flight sticks, and HOTAS hardware, default bindings, and settings.
• Configuration and options: Command-line options, graphics and sound settings, difficulty levels, and starlancer.ini.
• Modding: Mods that replace or add to the game's files: a first mod, where mods go, load order, the manifest, textures, interface pictures and fonts, new ships, guns, missiles and pilots with their own faces and voices, models from OBJ and glTF files, the game's models exported to glTF, and checking a mission.
• Scripting: Scripts in mods, step by step: changing the game's records, hooking the game's functions and events, object scripts, drawing on the display and the menus, a page of options on the mods screen, game modes and campaigns, and shaders.
• Scripting reference: Everything scripts can use: the engine handlers, the packages, objects, and the hooks with the fields each handler sees.

For technical information on file formats, reverse engineering, and engine architecture, see the developer documentation.