Giter VIP home page Giter VIP logo

enderbro's Introduction

Enderbro

Your Minecraft-Discord chat connection


Enderbro is heavily inspired by shulker, and operates in much the same way. This package is built primarily on top of Discord.js and modern-icon. Many thanks to the authors of all of those packages.


Usage

If everything is working correctly, Enderbro should work like so:

discord-irc

Installing

Clone this repository and run npm install to set things up.

Configuring

Enderbro requires a configuration file called config.json in the same directory as index.js. An example configuration file might look like this:

{
    "port": "3000",
    "token": "YOUR-TOKEN-HERE",
    "channelId": "YOUR-CHANNEL-ID-HERE",
    "endpoint": "http://your-endbro-installation.com/your/post/route",
    "postRoute": "/minecraft/hook",
    "src": "/path/to/your/minecraft/server/logs",
    "chatRegExp": "\\[Server thread/INFO\\]: <([^>]*)> (.*)",
    "ignoreRegExp": "packets too frequently",
    "rcon": {
        "host": "localhost",
        "port": 25575,
        "password": "hunter2",
        "timeout": 5000
    },
    "playerMap": {
        "minecraftPlayer1": "123456789101112131",
        "minecraftPlayer2": "123456789101112132",
        "minecraftPlayer3": "123456789101112133"
    }
}

Running

Once everything is installed and your config.json is ready to go, then you can run the application from the cloned directory with node index.js. It is strongly recommended that you use a process manager like pm2 to run Enderbro as a background process.


Contributing

Pull requests, bug reports, and feature requests are all welcome! To contribute to Enderbro, please fork this repository, create a new feature branch and submit a pull request to the master branch.

enderbro's People

Watchers

 avatar  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.