Skip to content

Latest commit

 

History

History
45 lines (30 loc) · 1.35 KB

README.md

File metadata and controls

45 lines (30 loc) · 1.35 KB
Raw

mcping

See mcping/ for the library

Discord bot written in Rust that pings a Java Minecraft server with a custom command and displays the status information in chat.

screenshot

Config

Create a config file called config.toml in the root directory of the project with the following:

token = ""
address = ""
command = ""

Where

  • token is the discord bot token
  • address is the Minecraft server address
  • command is the command that will trigger the ping, for example ~ping or ~minecraft

Running

In order to run the project you'll need Rust installed. Once you have it installed and have created the config file you can run the project with cargo run --release.

Library

The Discord bot is built on top of the mcping library, which can be integrated into your own application. It supports both Java and Bedrock servers and has an async implementation.

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.