README.md

openrct2-dynamicdashboard

A dynamic dashboard for OpenRCT2 scenarios including all the statistics.

Tip

This plugin is under rapid development. Check for updates regularly for the latest features, bug fixes and performance optimisations.

Note

Some features of this page are only supported by GitHub. If you're not on GitHub, you can go here for a better experience.

Contents

• Overview

• Installation

• Usage

  • Update Mode

  • Sync Now

  • Show Progress Bar / Value

  • Indicators

  • Advanced Options

  • Colour Scheme

• Contributing

  • Bug Report / Feature Request

  • Build from Source

Overview

Feature Preview

Screenshot v1.0.0-pre.8

Installation

1. Download the latest release here.

2. Drag dynamicdashboard.js into the plugin folder of OpenRCT2.

3. Enjoy the stats!

Usage

Shortcut Key: Press SHIFT+D to open dynamic dashboard. Customisable in OpenRCT2 game options.

Update Mode

With each click of the button, dynamic dashboard iterates through the following modes.

Mode	Description
	All statistics will update automatically, or Sync Now at any time.
	Statistics that are obtained by reading map values (e.g. entity count, guest stats, park ratings) will be paused. Statistics based on detecting game events (e.g. player action, guest generation, ride crashes) will continue to update. Manually update by pressing Sync Now.
	All statistics will cease to update.

Sync Now

Use this button to update statistics manually. Disabled when Update Mode is set to Paused.

Show Progress Bar / Value

Toggles progress bar / exact value display for applicable statistics.

Tip

If your progress bar looks weird, try changing your render mode to OpenGL in the options menu.

Indicators

Seen when Update Mode is set to Running. Statistics are updated when all lights turn green (at least it is intended to do so).

Seen when Update Mode is set to Manual. All lights flash yellow when Sync Now is pressed.

Seen when Update Mode is set to Paused.

Advanced Options

Since v1.0.0-pre.8, the plugin has been updated to include advanced options. Advanced options can be accessed via the toolbox menu or the dashboard itself.

Colour Scheme

Since v1.0.0-pre.8, you can customise the colours of the dashboard to your liking.

Contributing

We're excited to have you here and appreciate your interest in contributing to our OpenRCT2 plugin project!

Bug Report / Feature Request

Feel free to open an Issue! We will address the problem as soon as possible.

Build from Source

1. Install latest version of Node and make sure to include NPM in the installation options.

2. Clone the project to a location of your choice on your PC.

3. Open command prompt, use cd to change your current directory to the root folder of this project and run npm install.

4. Copy the openrct2.d.ts TypeScript API declaration file to lib folder.

5. Run npm run build (release build) or npm run build:dev (develop build) to build the project.

   • For the release build, the default output folder is (project directory)/dist.

   • For the develop build, the project tries to put the plugin into your game's plugin directory.

---

Special thanks to OpenRCT2, the OpenRCT2 Community, Basssiiie's wonderful typescript plugin template and OpenRCT2-FlexUI! This wouldn't be possible without them.

🌟 Support us by starring the repo and spreading the word!