Skip to content

Commit 4d16dac

Browse files
committed
Update readme.md, add openrct2.d.ts to repository
1 parent fae88ab commit 4d16dac

File tree

8 files changed

+5671
-10
lines changed

8 files changed

+5671
-10
lines changed

.gitignore

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
# OpenRCT2 TypeScript API declaration file
2-
lib/openrct2.d.ts
3-
41
# Logs
52
logs
63
*.log

README.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,15 @@ This plugin lets you edit vehicles on any ride in your park on the fly.
1515
- [**Copy** and **paste**](#copy--paste-vehicles) the settings of a vehicle over other completely unrelated vehicles.
1616
- Easily **[apply your changes to all vehicles](#apply-or-copy-and-paste-changes-to-multiple-vehicles)** on the train or the ride, or **[update multiple vehicles](#sychronize-changes-to-multiple-vehicles)** at the same time.
1717
- **Edit** and **freeze** the ride's excitement, intensity or nausea ratings.
18+
- Speed up your editing with various **[configurable shortcuts](#keyboard-shortcuts)**.
19+
- Supports **[multiplayer](#multiplayer-how-to-setup)**!
1820

1921
### Planned features
2022
- Please submit any ideas under [Issues](https://github.com/Basssiiie/OpenRCT2-RideVehicleEditor/issues).
2123

2224
## Installation
2325

24-
1. This plugin requires at least OpenRCT2 version v0.4.4.
26+
1. This plugin requires at least OpenRCT2 version v0.4.14.
2527
2. Download the latest version of the plugin from the [Releases page](https://github.com/Basssiiie/OpenRCT2-RideVehicleEditor/releases).
2628
3. To install it, put the downloaded `*.js` file into your `/OpenRCT2/plugin` folder.
2729
- Easiest way to find the OpenRCT2-folder is by launching the OpenRCT2 game, click and hold on the red toolbox in the main menu, and select "Open custom content folder".
@@ -126,6 +128,22 @@ For more detailed placement, it is recommended to use the X, Y and Z position se
126128

127129
![How to move a vehicle to another location](https://raw.githubusercontent.com/Basssiiie/OpenRCT2-RideVehicleEditor/main/img/tutorials/drag-vehicle.gif)
128130

131+
### Keyboard shortcuts
132+
133+
The plugin supports various keyboard shortcuts to speed up working with the plugin. Some shortcuts already have a default key, but for most it's recommended to pick your own, to avoid any collisions!
134+
135+
![Keyboard shortcuts for RideVehicleEditor](https://raw.githubusercontent.com/Basssiiie/OpenRCT2-RideVehicleEditor/main/img/tutorials/shortcuts.png)
136+
137+
To configure the keyboard shortcut keys:
138+
139+
1. Open a **park** or **scenario**.
140+
- Due to OpenRCT2 limitations, it's not possible to edit them in the main menu or the scenario editor.
141+
2. Open the **options** window under the **diskette** ![Diskette button](https://raw.githubusercontent.com/Basssiiie/OpenRCT2-RideVehicleEditor/main/img/icons/diskette.png) icon in the top toolbar.
142+
3. Go to the **gears** ![Gears tab](https://raw.githubusercontent.com/Basssiiie/OpenRCT2-RideVehicleEditor/main/img/icons/gears.png) tab.
143+
4. Click the **Shortcut keys...** button.
144+
5. Go to the **wrench** ![Wrench tab](https://raw.githubusercontent.com/Basssiiie/OpenRCT2-RideVehicleEditor/main/img/icons/wrench.png) tab.
145+
6. Find the shortcut keys marked with **[RVE]** and configure them to your desire!
146+
129147

130148
### Multiplayer! (How to setup)
131149

@@ -167,9 +185,7 @@ This plugin supports multiplayer! A few key points to note:
167185
1. Install latest version of [Node](https://nodejs.org/en/) and make sure to include NPM in the installation options.
168186
2. Clone the project to a location of your choice on your PC.
169187
3. Open command prompt, use `cd` to change your current directory to the root folder of this project and run `npm install`.
170-
4. Find `openrct2.d.ts` TypeScript API declaration file in OpenRCT2 files and copy it to `lib` folder (this file can usually be found in `C:/Users/<YOUR NAME>/Documents/OpenRCT2/bin/` or `C:/Program Files/OpenRCT2/`).
171-
- Alternatively, you can make a symbolic link instead of copying the file, which will keep the file up to date whenever you install new versions of OpenRCT2.
172-
5. Run `npm run build` (release build) or `npm run build:dev` (develop build) to build the project.
188+
4. Run `npm run build` (release build) or `npm run build:dev` (develop build) to build the project.
173189
- For the release build, the default output folder is `(project directory)/dist`.
174190
- For the develop build, the project tries to put the plugin into your game's plugin directory.
175191
- These output paths can be changed in `rollup.config.js`.

img/icons/diskette.png

998 Bytes
Loading

img/icons/gears.png

1.3 KB
Loading

img/icons/wrench.png

1.19 KB
Loading

img/tutorials/shortcuts.png

7.05 KB
Loading

lib/README.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)