https://github.com/oreqr/fake-minecraft-server
🎮Lightweight Rust implementation of a fake Minecraft server
https://github.com/oreqr/fake-minecraft-server
fake-server game-server minecraft minecraft-protocol minecraft-server rust testing
Last synced: 9 months ago
JSON representation
🎮Lightweight Rust implementation of a fake Minecraft server
- Host: GitHub
- URL: https://github.com/oreqr/fake-minecraft-server
- Owner: OreQr
- License: mit
- Created: 2025-03-21T18:23:12.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-05-26T20:03:41.000Z (about 1 year ago)
- Last Synced: 2025-06-26T01:36:58.435Z (12 months ago)
- Topics: fake-server, game-server, minecraft, minecraft-protocol, minecraft-server, rust, testing
- Language: Rust
- Homepage:
- Size: 64.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Fake Minecraft Server
[](https://github.com/OreQr/fake-minecraft-server/actions/workflows/ci.yml)
Lightweight Rust implementation of a fake Minecraft server. It supports server list responses (status/ping) and connection attempts, useful for testing clients or as a placeholder server.
## Installation
### Pre-built binaries
You can download pre-built binaries for Windows, macOS, and Linux from the [Releases page](https://github.com/OreQr/fake-minecraft-server/releases).
### Docker
```bash
docker run --name fake-server -d -p 25565:25565 -v "$(pwd)/config.yml:/config.yml" ghcr.io/oreqr/fake-minecraft-server:latest
```
## Configuration
Server uses a YAML configuration file (`config.yml`). If no configuration is found, default values will be used.
You can specify a custom path to the configuration file by setting the `CONFIG_PATH` environment variable.
Example configuration file with comments is provided in [`config.example.yml`](https://github.com/OreQr/fake-minecraft-server/blob/master/config.example.yml).
### Default values:
```yaml
debug: false
host: 0.0.0.0
port: 25565
status:
version:
same: true
players:
max: 20
online: 0
motd: "§cFake Minecraft Server"
favicon: server-icon.png
kick_message: "§c§lThis is a fake server!\n§eIt only responds to ping requests."
```
## Debugging
To enable debug logging, you can either:
1. Set the environment variable:
```env
DEBUG=true
# or Rust lang
RUST_LOG="debug"
```
2. Or enable debug in the config file:
```yaml
debug: true
```
## License
[MIT](https://github.com/OreQr/fake-minecraft-server/blob/master/LICENSE)