Skip to content

Commit

Permalink
docs(readme): add docker info
Browse files Browse the repository at this point in the history
  • Loading branch information
anweisen committed Oct 21, 2023
1 parent 621e489 commit 2a39666
Showing 1 changed file with 49 additions and 16 deletions.
65 changes: 49 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,75 @@
# JustMotd
A configurable socket server written in rust responding to packets via the minecraft protocol, providing a motd and disconnect information - for discontinued server projects

A configurable socket server written in rust responding to packets via the minecraft protocol, providing a motd and disconnect information - for discontinued server projects

## Setup

### Docker Run

```shell
docker run -d -p 25565:25565 -v /your/path/to/conf:/app/conf -e CONFIG=conf/config.json --name just_motd anweisen/just_motd:latest
```

### Docker Compose

```yaml
version: "3"

services:
server:
image: anweisen/just_motd:latest
ports:
- "25565:25565"
volumes:
- "./volume:/app/conf"
environment:
- CONFIG=conf/config.json
```
#### Start
```shell
docker compose up
```

#### Stop

```shell
docker compose down
```

## Configuration

### Config File

```json5
{
// the local address to bind the listener to
"bind": "0.0.0.0:25565",

"bind": "0.0.0.0:25565",
// the path to the favicon file as png, must be exactly 64x64! (ignored if not existent)
"favicon": "path.png",

"motd": {
// the motd text for pre1.16 clients, line separation with \n, colors with §
"text": "pre 1.16 text",
// the motd text for pre1.16 clients, line separation with \n, colors with §
"text": "pre 1.16 text",

// 1.16 & older support custom rgb colors, fallback to "text" above if not set
"component": {
// generated with tools like https://colorize.fun/en/minecraft & https://minecraft.tools/en/json_text.php
}
// 1.16 & older support custom rgb colors, fallback to "text" above if not set
"component": {
// generated with tools like https://colorize.fun/en/minecraft & https://minecraft.tools/en/json_text.php
}
},

"version": {
// the version name, colors with §
"text": "version text instead of player count",
// the version name, colors with §
"text": "version text instead of player count",

// text shown when hovering over version text, colors with §
"hover": "hover text through sample players"
// text shown when hovering over version text, colors with §
"hover": "hover text through sample players"
},

"disconnect": {
// the disconnect text for pre1.16 clients, line separation with \n, colors with §
"text": "pre 1.16 text",

// 1.16 & older support custom rgb colors, fallback to "text" above if not set
"component": {
// generated with tools like https://colorize.fun/en/minecraft & https://minecraft.tools/en/json_text.php
Expand Down

0 comments on commit 2a39666

Please sign in to comment.