Giter VIP home page Giter VIP logo

minegram's Introduction

Minegram

Minegram is a Minecraft-Telegram bridge. Read ahead for more examples and usage guide.

Other Types

What can it do?

  1. Minegram can connect your Minecraft Java server with your Telegram chat. This means that whenever a player joins, leaves, makes an advancement, dies, or sends a chat message, a bot will notify the Telegram chat of it by sending a message. Messages sent on Telegram will also be displayed to players in Minecraft, allowing them to chat with people on Telegram through Minecraft or vice-versa.

  2. Minegram has general user-experience improvements. It colors the logs that the server produces, making it more readable. It also sends a stop command to the server instead of a SIGINT (which happens when you use systemctl stop or CTRL+C), which ensures that everything is properly saved before exiting. Administrators can also execute commands using /cli command without having to log on to the server, for example /cli time set night.

  3. Minegram can show the list of players online using /list on Telegram. It can also display the time in the Minecraft world by using /time.

  4. Minegram comes with a toggleable Auth module. When the Auth module is enabled, players will have to link their Telegram accounts with their Minecraft IGN(In Game Name)s using the command /link player_ign_here. When a player joins the server, the gamemode for that player will automatically be switched to spectator mode, the player will be given blindness, and will be prevented from moving unless the linked Telegram account sends /auth on Telegram. This prevents people from logging on to offline-mode/cracked servers with other player's IGN(In Game Name)s and stealing their items/misbehaving with their identity.

How to use

Grab the binary from https://github.com/uditkarode/Minegram/releases. Place it in the same folder as your Minecraft server JAR, and also create a config file in the same directory with the filename config.ini. Sample contents of the config file are given in the config file in this repository. Then just execute the binary: ./Minegram and you're set!

Compiling from source

Compiling from source is very easy:

git clone https://github.com/uditkarode/Minegram.git
cd Minegram
go get -u
go build

More Examples

Reply Telegram Authentication

IMPORTANT: make sure that bot privacy is turned off using BotFather so that non-command messages can be read by the bot!

minegram's People

Contributors

icodelifee avatar uditkarode avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

minegram's Issues

One-time auth?

Hi, big fan of this tool, it works great!

I'm wondering about the /auth command. I run a private server that is linked to a private telegram group so authing every time feels redundant. Is it possible to bypass it in some way? If, for example, /link <username> just added the user in question to the server whitelist, it intuitively feels like /auth wouldn't be required, and it would just plain prevent people from joining rather than having to blind and move them.

For my use case, having the bot also keep track of which linked accounts that are still in the group and unlinking them if they leave would also be helpful, but i know that there's no way for bots to see channel members so that would require more effort.

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.