Giter Club home page Giter Club logo

disngraft's Introduction

disngraft

License: GPL v3 Python: 3.8

disngraft is discord bot based MineCraft server manager.

It allows you to get logs and share chats between Minecraft and Discord without any plugins.

Also it contains ngrok tunnel connection so that you don't have to open the router port.

日本語版はこちら

Requirements

  • Python3.8.x
  • Java

Start Guide

  1. Clone this repository.

     git clone https://github.com/mafusuke/disngraft.git
     cd disngraft
     pip install -r requirements.txt
  2. Create your Discord BOT.

    Go to Discord Developer Portal and create by clicking New Application. Then click Add Bot on Bot tab.

    Turn on SERVER MEMBERS INTENT and copy TOKEN.

    Next open Oauth2 tab, click bot on SCOPE and Administrator on BOT PERMISSIONS. After that Copy your bot's invite url and add them into your server.

  3. Get the TOKEN of Ngrok.

    SignUp on Ngrok Dashboard and you will see your TOKEN on Authentication tab.

  4. Setup chat channel and console channel.

    Before this, you have to enable developer mode of Discord.

    Copy the ID of chanel that you want to receive console logs and ID of channel you want to receive chats.

  5. Customize settings.

    Copy your TOKEN of ngrok and Discord BOT, channel ID of console channel and chat channel into settings.py

    Also you can customize settings by editing them. Descriptions are provided to each one as comment.

  6. Prepare server jar file.

    Since it doesn't depends on MineCraft server's version, it doesn't contain server file.

    So you have to manually place your server files inside server directory.

    Here is sample directory structure:

    ./disngraft
    ├── LICENSE
    ├── ProcManager.py
    ├── README.md
    ├── disngraft.png
    ├── enums.py
    ├── main.py
    ├── regex_data.py
    ├── requirements.txt
    ├── server
    │   ├── banned-ips.json
    │   ├── banned-players.json
    │   ├── bukkit.yml
    │   ├── commands.yml
    │   ├── connect.json
    │   ├── eula.txt
    │   ├── help.yml
    │   ├── logs
    │   │   └── latest.log
    │   ├── ops.json
    │   ├── permissions.yml
    │   ├── server-icon.png
    │   ├── server.jar
    │   ├── server.properties
    │   ├── usercache.json
    │   ├── whitelist.json
    │   ├── world
    │   │   └── (Abbreviated)
    ├── server.py
    └── settings.py
    
  7. Now ready to start!

     python3 main.py

    If it says Now Discord bot is ready to use! you succeeded.

    Type d?help on your server to check usage of each command.

Basic Usage

You can change BOT's prefix (default d?) on settings.py

d?start ... Start the MineCraft server

d?stop ... Stop the server

d?status ... Current status of the server

d?connect <your MineCraft name> ... Connect your account with MineCraft account

disngraft's People

Contributors

m4fn3 avatar

Watchers

 avatar

Forkers

saya2029

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.