This plugin spices up the multiplayer aspect of OpenRCT2.
- WIP
- Please submit any ideas under Issues.
- This plugin requires at least OpenRCT2 version v0.4.4.
- Download the latest version of the plugin from the Releases page.
- To install it, put the downloaded
*.js
file into your/OpenRCT2/plugin
folder.- 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".
- Otherwise this folder is commonly found in
C:/Users/<YOUR NAME>/Documents/OpenRCT2/plugin
on Windows. - If you already had this plugin installed before, you can safely overwrite the old file.
- Once the file is there, it should show a special message when a server instance is started.
This plugin only works in multiplayer and also only when ran as the server! A few key points to note:
- For the plugin to work in multiplayer, it needs to be installed on the server. Make sure it is installed in the plugin's folder of the server's user directory.
- When the server is started, the plugin will be loaded in the server. Players do not need to install the plugin for themselves.
- When the plugin is installed in single-player, it will do nothing.
Answer: No, this plugin only works when installed on the server client. It does nothing in single-player.
Answer: All the data in regards to the players, rides, and economy is saved in the .park
file.
This project is based on wisnia74's Typescript modding template and uses Nodemon, ESLint and TypeScript from this template.
- Install latest version of Node and make sure to include NPM in the installation options.
- Clone the project to a location of your choice on your PC.
- Open command prompt, use
cd
to change your current directory to the root folder of this project and runnpm install
oryarn install
. - Run
npm run gettypes
oryarn gettypes
to get the types of OpenRCT2;openrct2.d.ts
, directly from the git of OpenRCT2. - Run
npm run build
oryarn build
(release build) ornpm run build:dev
oryanr 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.
- These output paths can be changed in
rollup.config.js
.
- For the release build, the default output folder is
This project supports the OpenRCT2 hot reload feature for development.
- Make sure you've enabled it by setting
enable_hot_reloading = true
in your/OpenRCT2/config.ini
. - Open
rollup.config.dev.js
and change the output file path to your plugin folder.- Example:
C:/Users/<YOUR NAME>/Documents/OpenRCT2/plugin/CompetitiveMultiplayer.js
. - Make sure this path uses
/
instead of\
slashes!
- Example:
- Open command prompt and use
cd
to change your current directory to the root folder of this project. - Run
npm start
oryarn start
to start the hot reload server. - Use the
/OpenRCT2/bin/openrct2.com
executable to start OpenRCT2 with console and load a save or start new game. - Each time you save any of the files in
./src/
, the server will compile./src/registerPlugin.ts
and place compiled plugin file inside your local OpenRCT2 plugin directory. - OpenRCT2 will notice file changes and it will reload the plugin.
For convenience, it is possible to include a shell file, to start the server from the repository itself, but because install paths and config paths are different on each machine, this server.sh
is ignored for the git.
There is however a npm run server
and yarn server
command available in the package, which runs the shell file, if it exists. An example shell file is included, but needs modification to work on a system.
Thanks to wisnia74 for providing the template for this plugin and parts of the readme. Also a special thanks to Basssiiie for providing help and inspiration when needed!