The home for SCPUI core development!
SCPUI, or Source Code Project User Interface, is a Lua-based interface framework designed to completely replace the original interface in the FreespaceOpen game engine. This project not only modernizes the interface with a more resource-efficient design but also introduces significant enhancements:
- Unlimited Custom Screen States: Unlock limitless possibilities for menu design in your space game.
- Utility Features: Includes simple data saving, dialog boxes, and other tools for script-driven enhancements.
- Custom Options: Easily hook into arbitrary Lua scripts to extend functionality and user configuration.
SCPUI provides a powerful, flexible platform to reimagine the UI in FreespaceOpen.
Main documentation is available at: https://wiki.hard-light.net/index.php/Scpui
In FreespaceOpen, when an SCPUI document is active, you can use the following controls:
- Ctrl+Shift+R: Reload the document.
- Ctrl+Shift+D: Show the debug menu.
The style guide for this project can be found in .vscode/style_guide.lua. The environment is set up with the Lua Language Server in mind, providing type-checking and IntelliSense for improved development experience.
For more details, refer to the style guide file directly.
Contributions and feedback are welcome