Skip to content

Commit

Permalink
update readme!
Browse files Browse the repository at this point in the history
  • Loading branch information
mgovea committed Apr 1, 2021
1 parent d1a1971 commit 66222e1
Showing 1 changed file with 30 additions and 5 deletions.
35 changes: 30 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Your troubles are long gone with ***Ride Price Manager***!

## Using the Plugin
- First, follow the installation instructions below
- Once installed, the plugin should work automatically in game. It will _automagically_ update the prices of all your rides.
- Once installed, the plugin should work automatically in game. It will _automagically_ update the prices of all your rides every in-game day.
- By default, the plugin chooses the highest price that guests are willing to pay for a ride.
- That number is determined by ride rating, ride age, and other factors.
- You can configure the plugin via the "Ride Price Manager" _control panel_, which is available **under the Map Dropdown** on the top bar. There, you can:
Expand All @@ -18,6 +18,9 @@ Your troubles are long gone with ***Ride Price Manager***!
- add a "Lazy Tax" to decrease ride prices. This is for people that think this plugin is overpowered or just want to re-balance the game a little bit.
- allow prices greater than $20.00 for high value rides.
- Guests are willing to pay more than $20 for some rides, but you can't set a price to more than $20 via the UI. This allows the plugin to bypass that check.
- There are also two buttons in the _control panel_:
- "Make ALL Rides FREE" which does just that. This may be useful in conjunction with the "Ignore free rides" option.
- "Force Recalculate ALL Prices Now" also does what it says on the tin. Note that it doesn't use the "Ignore free rides" option, and recalculates free rides.

## Installation
1. Install a compatible version of OpenRCT2 (requires [`0.3.0-develop-bc33ef3`](https://openrct2.org/downloads/develop/v0.3.0-bc33ef3) released 2020/09/03 or [newer](https://openrct2.org/downloads/develop/latest))
Expand All @@ -29,9 +32,30 @@ Your troubles are long gone with ***Ride Price Manager***!
4. Run OpenRCT2!
5. Once in a scenario, open the options window via the Map dropdown to configure the plugin.

## Multiplayer
This plugin is now updated to work in Multiplayer! However, there are some things to know...

- The plugin must be installed on the server to automatically update prices every in-game day.
- When the prices are updated daily, only the config on the server is used.
- Any player with the plugin can still use the "Force recalculate" and "Make rides free" buttons. There are no permissions. File an issue if you are dealing with griefers.
- For the recalculate button, the client's config is used, but will be bulldozed when server recalculates prices on the next in-game day.

To set the server config, you will need to edit the `plugin.store.json` file (typically in `C:\Users\{User}\Documents\OpenRCT2`). If that file doesn't exist, use the following as the file contents. If some keys already exist, just add the `RidePriceManager` block to what's already there. And don't mess up the commas!

```
{
"RidePriceManager": {
"pluginEnabled": true,
"ignoreFreeRidesEnabled": true,
"goodValueEnabled": false,
"lazyTaxFactor": 0,
"unboundPriceEnabled": false
}
}
```

## Possible Future Plans
- Check if this works with server play
- And make it work with server play
- Have better tools for managing the price of transport rides.
- Automatically set park prices & allow configuration of a max admission price.
- This would help early-game ramp-up.
- Manage shop prices
Expand All @@ -52,14 +76,15 @@ If you want to request a feature or find a bug, open an issue on GitHub (as long
- Run a Command Prompt as Administrator
- `cd` to the repository
- `mklink .\lib\openrct2.d.ts "C:\Program Files\OpenRCT2\openrct2.d.ts"`
- Edit `ride-price-manager\rollup.config.dev.js` so that it puts the build in your plugin folder.
- Edit `ride-price-manager\rollup.config.dev.js` so that it puts the build in your plugin folder. Sorry that this is custom to me :O
- Run `npm run watch`
- Make your changes.
- Make sure to update the version number in `package.json` and in `index.js`.
- Commit your changes (without including the rollup config) and Make a Pull Request.

## Thanks
- Thanks to [OpenRCT2](https://github.com/OpenRCT2/OpenRCT2) for revitalizing a sweet game & releasing the plugin API.
- Thanks to **oli414** for the [boilerplate template](https://github.com/oli414/openrct2-plugin-boilerplate). I adapted it to fit TypeScript for this project initally, before **wisnia74** came out with [a very well made and comprehensive TypeScript plugin template](https://github.com/wisnia74/openrct2-typescript-mod-template), which I now use for this plugin. You should definitely use that one if you want to make your own plugin.
- This plugin is powered by **wisnia74**'s [very well made and comprehensive TypeScript plugin template](https://github.com/wisnia74/openrct2-typescript-mod-template). I highly recommend you use that one if you want to make your own plugin. So thank you, wisnia!
- Originally, this plugin was powered by **oli414**'s [boilerplate template](https://github.com/oli414/openrct2-plugin-boilerplate) (which I adapted to support TypeScript, but it still wasn't as nice as the new plugin template). Thanks oli for helping me get the ball rolling :)
- Thanks to [Marcel Vos](https://www.youtube.com/channel/UCBlXovStrlQkVA2xJEROUNg) for getting me back into RCT2.
- And many many thanks to [IntelOrca](https://github.com/IntelOrca) for all of the Plugin support. The Plugin API is super fun, and I can't wait to see what all people make for it.

0 comments on commit 66222e1

Please sign in to comment.