Giter VIP home page Giter VIP logo

discord-rustserverstatus's Introduction

Rust discord bot that displayes online players and rcon support

Docker Automated build Docker Pulls Docker Build Status

Discord-bot

Bot

Updates activity status on discord bot and displays how many players are connect to your rust server from rest api and relay rcon commands to server.

Written in nodejs and requires npm and nodejs.

You can run it on windows, macOS, linux or docker, se the installation for more info.

  • Supported api sites:
  • rust-servers.info
  • rust-servers.net
  • battlemetrics.com
  • Bot update status every 3 minutes

Configuration

config.json

{ 
  "debug" : false,
  "token"  : "your token here",
  "apiSite" : 1,
  "apiUrl" : "https://full uri here",
  "enableRcon" : "0",
  "rconhost"   : "",
  "rconport"   : "",
  "rconpass"   : "",
  "prefix" : "!",
  "roles"  :  ["Administrator", "admins"]
}

Installation:

  1. Download it as zip or use git clone https://github.com/kennethrisa/discord-rustserverstatus.git
  2. Extract it and open folder, than open powershell in the same folder.
  3. Run command: npm install (This downloads the require modules from package.json)
  4. a: You can manualy do this with command: npm install discord.js request ws
  5. b: You should now see that you have a new folder node_modules.
  6. Open config.json and add your token from (Do not use client secret) https://discordapp.com/developers/applications/me/ Discord-bot-token
  7. Now we can start the bot with command: node app.js and you should see that the bot is started, wait 6 min, and the status should be updated.

Windows only: Install the app as a windows service.

  • Open powershell: npm install
  • npm install -g node-windows
  • npm link node-windows
  • node installSVC.js
  • You will get some prompt to allow it to install, press yes on all.
  • Open services.msc and see discord-rustserverstatus is started. now it will always start on bootup.
  • Uninstall:
    • node uninstallSVC.js
    • Press yes on all prompts

Linux only: Start bot always using forever

  • $ npm install forever -g
  • $ forever start /path/to/app.js
  • Someone named nimdasys on oxide reported it. Thanks

Create your discord-bot and invite it to your server:

Docker

docker run --name discord-rustserverstatus --restart=unless-stopped \
   -e token="your token here" \
   -e apiSite=1 \
   -e apiUrl="https://full uri here" \
   -e enableRcon=1 \
   -e rconhost=yourip \
   -e rconport=28016 \
   -e rconpass="yourpassword" \
   -e prefix="!" \
   -e roles="Administrator" \
   kenrisa/discord-rustserverstatus:latest
  • Using docker-compose
git clone https://github.com/kennethrisa/discord-rustserverstatus.git
docker-compose pull
docker-compose up -d
  • You can also build the image your self using the docker-compose
git clone https://github.com/kennethrisa/discord-rustserverstatus.git
docker-compose build
docker-compose up -d

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.