Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/basssiiie/openrct2-flexui
Flexible library for creating user interfaces for OpenRCT2 plugins.
https://github.com/basssiiie/openrct2-flexui
flexible framework hacktoberfest openrct2 openrct2-plugin ui
Last synced: about 1 month ago
JSON representation
Flexible library for creating user interfaces for OpenRCT2 plugins.
- Host: GitHub
- URL: https://github.com/basssiiie/openrct2-flexui
- Owner: Basssiiie
- License: mit
- Created: 2021-08-15T17:50:27.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-24T12:57:18.000Z (3 months ago)
- Last Synced: 2024-12-26T08:34:44.460Z (about 2 months ago)
- Topics: flexible, framework, hacktoberfest, openrct2, openrct2-plugin, ui
- Language: TypeScript
- Homepage:
- Size: 1.64 MB
- Stars: 10
- Watchers: 1
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FlexUI for OpenRCT2 plugins
A flexible no-nonsense user interface library for creating windows for OpenRCT2 plugins.
- Simple declarative approach to designing your windows;
- Bind models to your interface components using reactive MVVM-like bindings;
- Your UI will automatically update when the values in your models change.
- Automatically resize parts of your UI when users resize your window;
- Percentile or weighted sizing of widgets;
- Put your widgets in columns or rows, sized to 10% or 2/3 of the size of the parent, or something like that.
- Nested widgets, widgets in widgets, or widget-inception;
- New widgets like toggle buttons, dropdown-spinners and dropdown-buttons;
- Supports both tabbed and regular window.
- Easily extendable by implementing your own `WidgetCreator`-implementations;
- Tree-shakable and minifiable;
- If you use a tree-shaker then code from the library that you don't use will not be shipped with your plugin.
- Fully unit-tested.
Designed with a focus on ease of use, performance, light-weighted and flexibility.
For examples see the [examples folder](https://github.com/Basssiiie/OpenRCT2-FlexUI/tree/main/examples).
## Plugins using FlexUI
Various plugins have already adopted FlexUI as their UI-library:
- **[RideVehicleEditor](https://openrct2plugins.org/plugin/MDEwOlJlcG9zaXRvcnkzMTI2MjQ1MjY=/OpenRCT2-RideVehicleEditor)**, by Basssiiie
- **[ParkRatingInspector](https://openrct2plugins.org/plugin/MDEwOlJlcG9zaXRvcnkzOTY0NTM0NjA=/OpenRCT2-ParkRatingInspector)**, by Basssiiie
- **[RCTris (Tetris)](https://openrct2plugins.org/plugin/R_kgDOLBRY8A/openrct2-rctris)**, by Sadret
- **[Consistent Guest Stats](https://openrct2plugins.org/plugin/R_kgDOK8S5TQ/consistent-guest-stats)**, by ItsSmitty
- **[Ride Painter](https://openrct2plugins.org/plugin/R_kgDOGuBtxQ/OpenRCT-Ride-Painter)**, by ItsSmitty
- **[Wet Paint Plugin](https://openrct2plugins.org/plugin/R_kgDOIOX2DQ/Wet-Paint-Plugin)**, by ItsSmitty
- **[Guest Teleporter](https://github.com/ltsSmitty/guest-teleporter)**, by ItsSmitty
- **[Force Visualiser](https://openrct2plugins.org/plugin/R_kgDOLhm8Bg/OpenRCT2-Force-Visualiser)**, by Alfinch
- **[Soft Guest Cap Inspector](https://openrct2plugins.org/plugin/R_kgDOJUjXiA/openrct2-soft-guest-cap-inspector)**, by Beam41
- **[Maze Generator](https://openrct2plugins.org/plugin/R_kgDOJVzaYg/openrct2-maze-generator)**, by Beam41
- **[RemoteHandymen](https://openrct2plugins.org/plugin/R_kgDOJeMV7Q/openrct2-remotehandymen)**, by mrmagic2020
- **[Dynamic Dashboard](https://github.com/mrmagic2020/openrct2-dynamicdashboard)**, by mrmagic2020
- **[Plugin Manager](https://openrct2plugins.org/plugin/R_kgDOLerpYQ/openrct2-plugin-manager)**, by Harry-Hopkinson
- **[Variable Editor](https://github.com/Harry-Hopkinson/openrct2-variable-editor)**, by Harry-Hopkinson
- **[OpenRCT2 Statistics](https://openrct2plugins.org/plugin/R_kgDOK7U8Bw/openrct2-statistics)**, by KatieZeldaKat
---
## Installing a pre-release
> **This library is still in development. It may contain bugs or missing features. There may be breaking changes.**
>
> If you find a bug or have a feature request, please report it under [Issues](https://github.com/Basssiiie/OpenRCT2-FlexUI/issues) or find me on Discord in the [OpenRCT2 server](https://github.com/OpenRCT2/OpenRCT2#chat).
Install the latest pre-release directly from the NPM registry with:
```
npm install openrct2-flexui@next
```
---
## Building the source code
Requirements: [Node](https://nodejs.org/en/), NPM.
1. Open command prompt, use `cd` to change your current directory to the root folder of this project and run `npm install`.
2. Run `npm run build` (production build) or `npm run build:dev` (development build) to build the project.
- The output folder for the packaged library is `(project directory)/dist`.
### Using a development build
To publish a local version of FlexUI for use in your own plugins;
1. Make a local build using `npm run build` or `npm run build:dev`.
2. Run `npm run publish:local` to install a local build into your global npm packages directory.
3. In the main folder of your new plugin; run `npm link openrct2-flexui` to temporarily link the local FlexUI build to your new plugin.
### Unit tests
The unit tests are written using AVA.js and can be run outside the game. First run `npm run install:test-setup` in the main folder to ensure the test dependencies are installed, and then `npm run build` to get a build for the included integration tests. Then simply run `npm test` to run all tests.