Skip to content

Latest commit

 

History

History
64 lines (43 loc) · 2.44 KB

README.md

File metadata and controls

64 lines (43 loc) · 2.44 KB
Raw

TeMiCross

This is a Minecraft-to-Telegram chat bridge

Minecraft example Telegram example

Setup

Prerequisites

  1. Install Node.js
  2. Install temicross: npm i -g temicross

Easy mode (bot + minecraft server)

  1. Download the Minecraft server jar and put it in a folder if you haven't.
  2. Open a terminal.
  3. cd to your Minecraft server folder.
  4. Run tmc botwrap to set up your server and bot.
    • You will be asked to fill in some values.
    • Get a bot token from @BotFather.
  5. The server and bot will start.
  6. Test it in-game and from your Telegram-chat to make sure it works!
  7. Report any bugs you find on the Issues page here!

Unattended mode

This mode enables updating the bot without restarting the Minecraft server.

Setup server

  1. Follow steps 1-3 from above.
  2. Run tmc wrap to start the server.
    • You will be asked to fill in some values.
  3. The server will start.

Setup bot

  1. Open a new terminal and cd to any folder (Your bot config will be stored here, if you don't know which folder to pick, the same folder as above is a good choice).
  2. Run tmc bot (make sure the Minecraft server is started using tmc wrap first, see above).
    • You will be asked to fill in some more values.
    • Use the token you got from @BotFather.
    • Make sure to use the same port and IP as you did before (the defaults are the same).
  3. The bot will start.

Setup client

The client allows remote control of a server that has been properly set up with port and IP.

MAKE SURE YOU KNOW THE SECURITY IMPLICATIONS OF ALLOWING REMOTE UNAUTHENTICATED ACCESS TO YOUR SERVER CONSOLE

  1. Open a new terminal and cd to any folder (your client config will be stored here)
  2. Run tmc client (make sure the Minecraft server is started using tmc wrap first, see above).
    • You will be asked to fill in even more values.
  3. The client will start, and you can type commands into it to run commands on the server console.

Tips

Reconfigure

You can reconfigure the bot at any time by running: tmc <command> config

Example: tmc botwrap config will load values from botwrapper.json and ask you the configuration questions again. You may or may not need to do this after updating.