rustplusplus ~ Rust+ Discord Bot
A NodeJS Discord Bot that uses the rustplus.js library to utilize the power of the Rust+ Companion App with additional Quality-of-Life features.
How-to Setup Video
Features
- Receive notifications for In-Game Events (Patrol Helicopter, Cargo Ship, Chinook 47, Oil Rigs triggered).
- Control Smart Switches or Groups of Smart Switches via Discord or In-Game Team Chat.
- Setup Smart Alarms to notify in Discord or In-Game Team Chat whenever they are triggered.
- Use Storage Monitors to keep track of Tool Cupboard Upkeep or Large Wooden Box/Vending Machine content.
- Head over to the Information Text Channel to see all sorts of information about the server, ongoing events and team member status.
- Communicate with teammates from Discord to In-Game and vice versa.
- Keep track of other teams on the server with the Battlemetrics Player Tracker.
- Alot of QoL Commands that can be used In-Game or from Discord.
- View the Full list of features.
Documentation
Documentation can be found here. The documentation explains the features as well as
how to setup the bot
, so make sure to take a look at it ๐
Credentials
You can get your credentials by running the
rustplusplus FCM Credential Application
. Download it here
How to run the bot
To run the bot, simply open the terminal of your choice and run the following from repository root:
$ npm start run
How to update the repository
Depending on your OS / choice of terminal you can run:
$ update.bat
or
$ ./update.sh
Running via docker
$ docker run --rm -it -v ${pwd}/credentials:/app/credentials -v ${pwd}/instances:/app/instances -v ${pwd}/logs:/app/logs -e RPP_DISCORD_CLIENT_ID=111....1111 -e RPP_DISCORD_TOKEN=token --name rpp ghcr.io/alexemanuelol/rustplusplus
or
$ docker-compose up -d
Make sure you use the correct values for DISCORD_CLIENT_ID as well as DISCORD_TOKEN in the docker command/docker-compose.yml
Thanks to
liamcottle@GitHub - for the rustplus.js library.
.Vegas.#4844@Discord - for the awesome icons!