https://github.com/tubbo/openrct2-benchwarmer
An OpenRCT2 plugin that adds alternating benches and bins to your park's footpaths with a single click.
https://github.com/tubbo/openrct2-benchwarmer
openrct2 plugin
Last synced: 18 days ago
JSON representation
An OpenRCT2 plugin that adds alternating benches and bins to your park's footpaths with a single click.
- Host: GitHub
- URL: https://github.com/tubbo/openrct2-benchwarmer
- Owner: tubbo
- License: mit
- Created: 2020-08-16T20:00:18.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-04-08T03:32:09.000Z (19 days ago)
- Last Synced: 2025-04-08T04:27:09.191Z (19 days ago)
- Topics: openrct2, plugin
- Language: TypeScript
- Homepage:
- Size: 3.76 GB
- Stars: 43
- Watchers: 4
- Forks: 10
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Benchwarmer
A plugin for [OpenRCT2][] that quickly builds benches and litter bins on
each alternating footpath tile. This is generally the best way to ensure
your park value stays high, and is a very tedious part of playing
RollerCoaster Tycoon 2.
## Installation
Download the [latest release][] from GitHub. Then, place the `.js` file
in your [OpenRCT2 plugin folder][].
- On macOS, this is `~/Library/Application Support/OpenRCT2/plugin`.
- On Windows, this is `%USERPROFILE%\Documents\OpenRCT2\plugin`.
- On Linux, this is `$XDG_CONFIG_HOME/OpenRCT2/plugin`.
(`$XDG_CONFIG_HOME` is typically set to `~/.config`)
## Usage
This plugin adds a new dialog window to the "Map" menu, where all other
plugins are located, allowing you to choose which two pieces of
bench/bin scenery you wish to add to the map.
After selecting the two pieces of scenery, click the "Add" button to
automatically add each bin and bench to your footpaths. Benches are
added to footpaths with an even index, and bins are added to footpaths
with an odd index. Sloped footpaths and ride queues are ignored.
## Development
If you wish to contribute to this project, make sure it builds locally
before pushing your changes.
To do this, install dependencies with Yarn:
```bash
yarn
```
Make sure you have `$OPENRCT2_BIN` set to your OpenRCT2 CLI, and
`$OPENRCT2_DIR` set to the directory in which OpenRCT2 keeps all its
user content.
Then, build the project to the local **build/** folder. There should be
no errors.
```bash
yarn build
```
Also, make sure to run ESLint before pushing your changes:
```bash
yarn test
```
## Releasing
Releases occur automatically when pull requests are merged to the default
branch. This project uses the [Yarn Release Workflow][] to automatically bump
versions when new changes occur. Pull requests are required to have new `.yarn/ versions` files defined, and we have a workflow that will assign the version
if the pull request is labeled as such. Version numbers follow the [semantic
versioning][] format to allow for easy communication of changes:
- **major** version upgrades are for `breaking` changes
- **minor** version upgrades are for `enhancement` and new features
- **patch** version upgrades are for `bug` fixes and other minor improvements
The `.yarn/versions` file is written automatically whenever a pull request is
labeled as such.
[latest release]: https://github.com/tubbo/openrct2-benchwarmer/releases
[openrct2]: https://openrct2.org/
[openrct2 plugin folder]: https://www.pcgamingwiki.com/wiki/OpenRCT2#Configuration_file.28s.29_location
[yarn release workflow]: https://yarnpkg.com/features/release-workflow
[semantic versioning]: https://semver.org