Git Product home page Git Product logo

flanqr / rustplusplus Goto Github PK

View Code? Open in Web Editor NEW

This project forked from alexemanuelol/rustplusplus

0.0 0.0 0.0 9.6 MB

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

Shell 0.19% JavaScript 99.25% TypeScript 0.32% Batchfile 0.20% Dockerfile 0.04%

rustplusplus's Introduction

discord reddit 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

  • Receive notifications for In-Game Events (Patrol Helicopter, Bradley APC, Cargo Ship, Chinook 47, Oil Rigs triggered and Locked Crate dropped).
  • 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!

rustplusplus's People

Contributors

alexemanuelol avatar psykzz avatar jacubrstnc avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.