Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anatawa12/discord-rcon
The discord bot to control game servers via rcon.
https://github.com/anatawa12/discord-rcon
bot discord discord-bot minecraft
Last synced: 22 days ago
JSON representation
The discord bot to control game servers via rcon.
- Host: GitHub
- URL: https://github.com/anatawa12/discord-rcon
- Owner: anatawa12
- License: apache-2.0
- Created: 2021-08-28T02:02:00.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-01-20T23:18:35.000Z (almost 2 years ago)
- Last Synced: 2024-10-10T21:14:39.699Z (about 1 month ago)
- Topics: bot, discord, discord-bot, minecraft
- Language: Rust
- Homepage:
- Size: 123 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
discord-rcon
======
The discord bot to control game servers via rcon.
This bot supports Minecraft and Factorio by [rcon crate]
but other servers may work.
This bot is tested with minecraft 1.7.10.
[rcon crate]: https://crates.io/crates/rcon
## how to enable rcon for minecraft server
how to enable rcon for minecraft server
1. replace `enable-rcon=false` to `enable-rcon=true` in `server.properties`
2. add `rcon.password=PASSWORD` (please replace `PASSWORD` with password
you want to use) to `server.properties`
## how to use this bot
### via docker
First, please [create config.toml]
Then run following command to start the bot.
```bash
docker run ghcr.io/anatawa12/discord-rcon
```
### via docker-compose
You can configure docker-compose based on [docker-compose.yml].
### install via cargo
Run ``cargo install discord-rcon`` to install discord-rcon.
Then, please [create config.toml].
Finally, run ``discord-rcon`` to start bot.
## configuring this bot
This bot uses [TOML] to write configurations.
Please replace each values to the value you want to use.
Commented property means optional configuration.
```toml
# the discord bot token
token = ""
# the discord command prefix.
# if the value is "!", "!say hello" executes "say hello" in console
# If the value is empty, all messages posted to the channel by a person who has
# the role will be executed.
prefix = ""
# the control command prefix.
#command = ""
# The id of role the users this bot can be used.
# if not specified, all users can use this bot. it's dangerous
#role =
# The id of channel this bot will listen.
# if not specified, all channels on guild/server the bot connected will be watched.
#channel =
# The kind of your game server.
# This enables the some quirks for game servers.
# currently supports Minecraft and Factorio.
# If your game is not one of games above, you don't need to specify server_kind
#server_kind = ""
# The section about rcon connection
[rcon]
# the address of rcon server.
address = ":"
# the password of rcon server.
pass = ""
```
[create config.toml]: #configuring-this-bot
[docker-compose.yml]: docker-compose.yml