Welcome to the GitHub repository for Gooee, a Cities Skylines 2 mod designed to blend the conventions of Bootstrap with the game UI to provide a framework for modders to build rich UIs easily.
On top of that it also provides a framework of re-usable React components that are all custom made to try and fit into the game's UI whilst blending Bootstrap elements.
The mod provides an MVC (Model View Controller) system to easily setup your UI system, inject it and setup bindings for your model automatically.
Please note, this is a very early alpha and documentation is still WIP. Bugs are likely so it's not really recommended you use this in your mods just yet. But hopefully soon it will be in a useable state.
-- Bootstrap-like CSS classes -- Font Awesome 6 included -- Inject UI into various places in the game's UI -- Model View Controller paradigm -- Automatic binding setup -- Re-usable React components wrapping in the Bootstrap-like elements. -- Inject JS scripts and CSS stylesheets with your Plugin
- BepInEx v5: Gooee requires BepInEx version 5 to be installed in your Cities Skylines 2 game. Ensure you have this version before proceeding with the installation. Also install HookUI as this mod now depends on it.
To ensure you get the genuine Gooee mod, please download it from either of these two sources:
- This GitHub Repository
- ThunderStore.io
- Download the Gooee mod from either this GitHub repository or ThunderStore.io.
- Extract the downloaded file.
- Place the extracted files into the
BepInEx/pluginsfolder in your Cities Skylines 2 directory. - Launch Cities Skylines 2, and the mod should be active!
Feel free to contribute to the development of Gooee! If you have ideas or suggestions, please open an issue or a pull request in this repository.
Documentation is currently work in progress as the mod is in very early alpha stages. Please see the example mod in the mean-time.
If you encounter any issues or have questions, please open an issue in this repository. We'll do our best to assist you.
Gooee is a fan-made mod and is not affiliated with the official Cities Skylines game or its creators.
Gooee is released under the GNU General Public License v2.0. For more details, see the LICENSE file included in this repository.
A big thank you to the Cities Skylines modding community for their ongoing support and inspiration.
Enjoy building your city with a taste of nostalgia with Gooee! 🏙️🌉