Skip to content

syusui-s/mcnotify-rust

Repository files navigation

mcnotify-rust: Minecraft status notifier written in Rust

LICENSE BuildStatus

Overview

This app sends notifications when someone joins / leaves your Minecraft server (Java version).

Supported notifications:

  • Server stopped / recovered
  • Player join / left
  • Current players and the number of players

Supported notifiers:

Download

Please refer Releases to download binaries.

Currently, ONLY Linux x86_64 binary is available on Releases.

If you need a binary for another platforms such as macOS, Windows and RaspberryPi (armhf Linux), please build it by yourself.

How to build

$ cargo build --release

How to create the configuration file

The default path is ~/.config/mcnotify/config.toml.

Please take a look at config.example.toml.

How to run

Normal execution

You can run the binary after the build.

$ ./target/release/mcnotify

If you want to see a help message, use --help options.

$ mcnotify --help

Run in background

mcnotify is NOT daemon process.

You can use nohup, tmux or systemd service to run mcnotify in background.

Systemd service example:

[Unit]
Description=Minecraft Notifier

[Service]
WorkingDirectory=/
User=minecraft
ExecStart=/usr/local/bin/mcnotify -c /home/minecraft/mcnotify.server_a.toml
Restart=always
RestartSec=30
Environment=RUST_BACKTRACE=1

[Install]
WantedBy=multi-user.target

About

Minecraft status notifier

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •