alexemanuelol / rustplusplus

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.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

discord reddit donate on ko-fi

donate on ko-fi

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

Image of setup video

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 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!

About

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.

License:GNU General Public License v3.0


Languages

Language:JavaScript 99.5%Language:TypeScript 0.2%Language:Batchfile 0.1%Language:Shell 0.1%Language:Dockerfile 0.0%