anakanano / link2telegram

Connect to Telegram Bot via plugin

Link2Telegram

English | 简体中文

Introduce

Connect to Telegram Bot via plugin

How to use

• Download the latest version of the jar package from the Release interface

• Put it to /plugins directory

• If you already have a Telegram Bot, skip this step. If you dont, then create a Bot by @BotFather

• Run your server once or create config.yml in /plugins/link2telegram directory

PluginConfiguration

#  Link2Telegram v1.3.1
#  Created by Crystal-Moling
#  GitHub page:https://github.com/Crystal-Moling/link2telegram

# BotToken obtained from @BotFather
BotToken: '123456:qwertyuiopASDFGHJKL'
# Chat ID of this server owner
OwnerChatId: 1234567890
# Send message to other chats,groups or channels
# - When you need to send message to channel you should use like "@ChannelName"
# - but the "@" couldn't write in config so use "AT:" to show that this is an "@"
# - You needn't write owner's chat id here again
SendMsgToChatID:
  - 987654321
  - 'AT:Channel-name'
Proxy:
  #Proxy server address, if not filled, no proxy will be used
  Hostname: '127.0.0.1'
  # proxy server port
  Port: 7890

# Plugin function
ServerStart/StopMessage:
  # Whether to enable Server Start Message
  Enabled: true
TPSMonitor:
  # Whether to enable TPS monitor
  Enabled: true
  # TPS monitoring interval, in seconds
  TPSCheckTimeout: 5
  # TPS max threshold
  MaxTPSThreshold: 22
  # TPS minimum threshold
  MinTPSThreshold: 18
PlayerLoginLogout:
  # Whether to enable Player login/logout Listener
  Enabled: true

# Plugin Messages
Messages:
  # Server starts message
  PluginOnEnableMsg: 'Server started'
  # Server shuts down message
  PluginOnDisableMsg: 'Server down'
  # TPS high warning message
  TPSTooHighMsg: 'TPS is too high, current TPS:%TPS%'
  # TPS low warning message
  TPSTooLowMsg: 'TPS is too low, current TPS:%TPS%'
  # Player Login Message
  PlayerLoginMsg: 'Player %player% login!'
  # Player Logout Message
  PlayerLogoutMsg: 'Player %player% logout!'
  # Not owner message
  NotOwnerCommand: 'You do not have owner permission!'

Development

• Download the latest version of the jar package from the Release interface

• Copy the jar package to the project root directory

• maven

  • Add the following to pom.xml

      <dependency>
        <groupId>org.crystal.link2telegram</groupId>
        <artifactId>link2telegram</artifactId>
        <version>1.3.1</version>
        <scope>system</scope>
        <systemPath>${project.basedir}/link2telegram-1.3.1.jar</systemPath>
      </dependency>
    

• Gradle

  • Add the following to build.gradle

      dependencies {
        compile files('link2telegram-1.3.1.jar')
      }
    

• Add a reference to the project

  import org.crystal.link2telegram.Link2telegram;

Documentation

Send Message

Get Message

TPS Monitoring

Get Server Basic Data

Get Server players list

Plugin Variable

Bot Command

SendMessage

Send a message using a bot

Link2telegram.L2tAPI().sendMsg("<message to be sent>", ["<message type>"]);

Currently supported message types are Status/Warn/Info, other characters will be formatted as unprefixed information

GetMessage

Get the last message received by the bot

Instructions

• Add implements Listener to the main plugin class

• Register the listener in onEnable

  getServer().getPluginManager().registerEvents(this, this);

• Use the following code to monitor the get message event

  @EventHandler(priority = EventPriority.MONITOR)
  private void GetUpdateListener(GetUpdateEvent event){
  }

• Use event.GetMessage() to get the received message

Return value type: String

get command

Get the command obtained by the robot (starting with "/")

Instructions

• Add implements Listener to the main plugin class

• Register the listener in onEnable

  getServer().getPluginManager().registerEvents(this, this);

• Use the following code to listen for command events

  @EventHandler(priority = EventPriority.MONITOR)
  private void GetCommandListener(OnCommandEvent event){
  }

• Use event.GetCommand() to get the received command text (without "/")

/status,/sudo and /list are built-in commands and cannot be monitored. For details, see BotCommands

Return value type: String[]

TPSMonitoring

This method can send a warning message when the server TPS exceeds or falls below a set threshold

The set threshold can be modified in config.yml

Get TPS

Link2telegram.L2tAPI().getServerTPS();

Return value type: double[]

GetServerBasicData

This method can return the current CPU and memory usage of the server

Link2telegram.L2tAPI().getServerStatus();

Return value type: Object[OS Type, CPU Usage, Memory Usage, Used Disk Space, Total Disk Space]

This method can also use the built-in Bot command /status to get

GetServerPlayersList

Used to get player list

Link2telegram.L2tAPI().getOnlinePlayers();

Return value type：String[在线玩家列表, 在线玩家人数]

This method can also use the built-in Bot command /list to get

See BotCommands

PluginVariable

%TPS%Server TPS

%player%Logged in player

BotCommands

The default built-in commands of the plugin are listed here, and these commands cannot be monitored by OnCommandEvent

/status

Get the basic information of the current server,return the message format:

ℹ️[Info] 12:34:56
CPU: [█░░░░░░░░░]10%
Memory: [████▌░░░░░]45%
Disk:
   Root Path:/
   Used Disk:14G / 49G

/sudo

for executing commands

Example: To execute the command /say test, send the command /sudo say test

/list

Used to get player list,return the message format:

ℹ️[Info] 12 : 34 : 56
Online players:[1]
Crystal_Moling

dependencies

okhttp

java-telegram-bot-api

License

Apache-2.0