Git Product home page Git Product logo

mc-status-discord-bot's Introduction

mcstatusbot

A simple Discord.js bot that pings Minecraft servers using the mc-ping-updated node module.

This bot is currently compatible with post-1.8 vanilla, Spigot, Waterfall, and Bungeecord servers. Other types of servers are partially supported with varying degrees of comaptbility.

Setup & Configuration

  • First install Node.js from here if not already installed.
  • Then open your OS's terminal emulator in the folder in which the bot is in and run npm i

Edit the config.json file to provide your bot token, preferred command prefix, Minecraft server IP address & port, and ping interval:

  • Replace "YOUR BOT TOKEN HERE" with your bot token.
  • Replace "/" with your preferred command prefix. Defaults to /.
  • Replace "YOUR SERVER IP HERE" with the IP address of the Minecraft server you want to poll. Domains that redirect to IP addresses ("play.exampleserver.net") will also work.
  • Replace "25565" with the port number of the Minecraft server you want to poll. Defaults to port 25565.
  • Replace "30" with the frequency, in seconds, at which you want the bot to ping the server. Defaults to pinging every 30 seconds.
  • Replace "7289DA" with the hex color code you prefer the bot's richEmbed messages to use.
  • Start the bot by running start.sh (Linux) or start.bat (Windows). The bot should connect and begin polling the server.

Default Commands

  • /help (aliases: /commands, /list, /bot) - List the other commands
  • /status (aliases: /server, /online) - Manually poll the Minecraft server whose IP address and port are listed in config.json, returning the server's version and a list of any online players
  • /crash - Stop the bot. If you're using a looping start.sh script like the one provided, this effectively restarts the bot.

mc-status-discord-bot's People

Contributors

nanorithm avatar

Watchers

 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.