Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fulcanelly/mctg-bridge
Chat bridge between telegram group and minecraft chat
https://github.com/fulcanelly/mctg-bridge
bot bridge minecraft telegram telegram-bot
Last synced: about 1 month ago
JSON representation
Chat bridge between telegram group and minecraft chat
- Host: GitHub
- URL: https://github.com/fulcanelly/mctg-bridge
- Owner: fulcanelly
- License: mit
- Created: 2020-04-28T20:06:53.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-08-27T23:57:22.000Z (4 months ago)
- Last Synced: 2024-08-28T01:06:29.918Z (4 months ago)
- Topics: bot, bridge, minecraft, telegram, telegram-bot
- Language: Java
- Homepage:
- Size: 2.3 MB
- Stars: 10
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# MCTG-bridge
MCTG-bridge is a standalone working out of box plugin that creates a chat bridge between Telegram group and Minecraft chat.
### How to use
- [Get jar file](#get-jar-file)
- [Setup telegram bot](#setup-telegram-bot)
- [Configure plugin](#configure-plugin)
- Configure additional modules
- ngrok proxy tunnel
- LoginSecurity plugin
- Invite system
### Get jar file
- Download stable version - you can download compiled package from releases [page](https://github.com/fulcanelly/mctg-bridge/releases)
- Download experimental-automatiacly-built version from [github actions](https://github.com/fulcanelly/mctg-bridge/actions)
- Build by yourself - `mvn clean install`
### Setup telegram bot
- Head to https://t.me/BotFather
- Use command `/newbot` and follow instructions
- Use `/setprivacy` and set it to `DISABLED` if you want bot to see messages in chats
- Remember API token
### Configure plugin
- Copy jar file to server's `plugins` folder
- Start server to generate config for plugins
- Put bot's API token to ```plugins/tg-bridge/config.yml``` at `api_token` column
- Restart server - at startup you should see message like this
```log
[17:10:59 WARN]: [tg-bridge] chat_id is null, use /attach to pin one
[17:10:59 WARN]: [tg-bridge] secretTempCode is set to -72683
```
After that add bot to target chat and execute that command in it:
```
/attach secretTempCode
```
Now you need to make final restart and plugin is ready to use
- Adjust other config options by your needs
### Preview
### Telegram bot commands
Base command set
```
memory - show allocated memory
list - list online players
ping - pong
uptime - show uptime
stats - player stats
top - get top stats
kickme - kicks you...
```
From ivite system
```
invite - invite person to server (optional)
```
From login security
```
removepass - remove account password
changepass - change account password
```
For now all they by default enabled (except last ones since they depedns from corresponding plugin presence)
todo: add configurability and scripting
### How to setup ngrok (`/tunnel` command)
To setup ngrok or telegram `/tunnel` command you need to put you ngrok auth to config file field `ngrok_auth`
you can get one from https://ngrok.com
### What's Left to be Added/Fixed
- The Following Ideas
- [x] Message reduction
- [x] Message merging
- [x] Login via telegram
- [x] Hook with existing login plugin
- [x] Flexible configurtation
- [x] Ingore switch
- [ ] Custom localization
- [ ] Config editor
- [ ] Reply by click