Skip to content

Commit 5ef0a0b

Browse files
committed
Add very basic seabird-minecraft-backend docs
1 parent 7a15f25 commit 5ef0a0b

2 files changed

Lines changed: 24 additions & 1 deletion

File tree

src/SUMMARY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
- [Chat Backends]()
1313
- [seabird-discord-backend](admin/seabird-discord-backend.md)
1414
- [seabird-irc-backend](admin/seabird-irc-backend.md)
15-
- [seabird-minecraft-backend]()
15+
- [seabird-minecraft-backend](admin/seabird-minecraft-backend.md)
1616
- [Plugins]()
1717
- [seabird-adventofcode-plugin]()
1818
- [seabird-datadog-plugin]()
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# seabird-minecraft-backend
2+
3+
[![Static Badge](https://img.shields.io/badge/repository-blue?logo=git&label=%20&labelColor=grey&color=blue)](https://github.com/seabird-chat/seabird-minecraft-backend)
4+
<!-- [![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/seabird-chat/seabird-core/docker-publish.yml)](https://github.com/seabird-chat/seabird-minecraft-backend/actions/workflows/docker-publish.yml) -->
5+
6+
## Dependencies
7+
8+
- `seabird-core`
9+
- a Fabric Minecraft server
10+
11+
## Configuration
12+
13+
### Config File
14+
15+
The config file is a json file located at
16+
`config/seabird-minecraft-backend.json`, with the following properties:
17+
18+
- `seabirdHost` (optional, defaults to `seabird-core.elwert.cloud`)
19+
- `seabirdPort` (optional, defaults to `443`)
20+
- `seabirdToken` (required)
21+
- `backendId` (optional, defaults to `minecraft`)
22+
- `backendChannel` (optional, defaults to `minecraft`)
23+
- `systemDisplayName` (optional, defaults to `Minecraft`)

0 commit comments

Comments
 (0)