Getting Started

Advanced configuration will be written as soon as possible!

Installation and Setup

Installing the Plugin

1. Download the latest version of the plugin from Modrinth
2. Place the downloaded file into your server's plugins folder
3. Start the server. You will likely see 2 errors in the console; these indicate that Discord and Telegram bot tokens are not set
4. Stop the server to make configuration changes

Plugin Configuration

Configuring config.yml

# Whether to store messages in a database for cross-platform message replies
enableMessageStorage: true # recommended true, default false
# Interval to update channel info in chat, in seconds
serverInfoUpdateTime: 603
# Default text displayed in the channel description
defaultServerInfoFormat: 'Online: {online} Total players: {total} Uptime: {uptime}'
# Format used to display server uptime in Discord channel description
timeFormat: '{d} days {h} hours {m} minutes' # placeholder {uptime} in defaultServerInfoFormat
# Whether to translate achievements and death messages from English
translateMessages: true
# Whether to repeat all player messages in the console
sendMessagesToConsole: true
# Platforms to be used. If [] is specified, all will be enabled
enabledReceivers:
  - Minecraft
  - Discord
  - Telegram
imageHosting:
  # Which image hosting to use; currently only freeimage is available
  type: freeimage
heads:
  # Configure display of player heads (e.g., in join/leave messages)
  # For SkinsRestorer https://mc-heads.net/avatar/%skinsrestorer_texture_id_or_steve%.png#%username% 
  url: https://crafthead.net/helm/%nickname%
  provider: default
# Whether to include your server in metrics
metrics: true

Discord Bot Setup

For detailed information, see wiki

1. Create a bot and get its token, make sure to enable message intent
2. Configure Discord.yml

   bot:
     # Enter your bot token here
     token: 'paste token here'
     # Enter your server's Guild ID
     guild: 1234567890123456789
     channels:
       messages:
         type: main_text
         id: 1234567890123456789 # ID of the player messages channel
         # Channel description, leave '' to use default description
         description: 'Online: {online} | Registered: {total} | Uptime: {uptime}'
       console:
         type: console
         id: 1234567890123456789 # ID of the console channel
         description: ' '
     # Whether to require a prefix for commands in the console channel
     commandsShouldStartsWithPrefix: true
     commandPrefix: '!/'
   
   # Configuration for displayed messages, see wiki for details
   messages: # ...
   
   # Phrase filter for @everyone, @here mentions
   phraseFilter:
     filterMessages: true
     filters:
       '@everyone': '[everyone]'
       '@here': '[here]'

Telegram Bot Setup

For detailed information, see wiki

1. Go to BotFather and create a bot
2. Configure bot permissions if using a group
3. Add the bot to your group, or use private messages
4. Copy the token
5. Add your token to Telegram.yml

   bot:
     token: 'Your Bot Token'

6. Start the server and wait for full load
7. Send a message to the bot (private or group) to get identifiers. You will see something like this in the console:

   [00:19:57 INFO]: [MMB] Preconfigure debug enabled! Please, disable it in Telegram.yml after setting it up!
   [00:19:57 INFO]: [MMB]     ChatId: 7109693268 ThreadId: 123 Message: ?? ????
   [00:19:57 INFO]: [MMB] [Telegram] Azimkindev -> ?? ????
   

8. Configure Telegram.yml

   bot:
     token: 'Your Bot Token'
     mainChat: 7109693268 # ChatId from console message
     mainThread: -1 # Thread ID in group, leave -1 if no threads or using private chat
     #...
   messages: {} #... see wiki for message setup
   
   debug:
     # !!!!! Be sure to set this to false after configuring channel and thread IDs
     preConfiguredDebug: false

Final Steps

You are now ready to proudly launch your server. If errors occur, you can always contact tech support.