Skip to content

Commit

Permalink
Add very basic seabird-minecraft-backend docs
Browse files Browse the repository at this point in the history
  • Loading branch information
belak committed Apr 8, 2024
1 parent 7a15f25 commit 5ef0a0b
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 1 deletion.
2 changes: 1 addition & 1 deletion src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
- [Chat Backends]()
- [seabird-discord-backend](admin/seabird-discord-backend.md)
- [seabird-irc-backend](admin/seabird-irc-backend.md)
- [seabird-minecraft-backend]()
- [seabird-minecraft-backend](admin/seabird-minecraft-backend.md)
- [Plugins]()
- [seabird-adventofcode-plugin]()
- [seabird-datadog-plugin]()
Expand Down
23 changes: 23 additions & 0 deletions src/admin/seabird-minecraft-backend.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# seabird-minecraft-backend

[![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)
<!-- [![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) -->

## Dependencies

- `seabird-core`
- a Fabric Minecraft server

## Configuration

### Config File

The config file is a json file located at
`config/seabird-minecraft-backend.json`, with the following properties:

- `seabirdHost` (optional, defaults to `seabird-core.elwert.cloud`)
- `seabirdPort` (optional, defaults to `443`)
- `seabirdToken` (required)
- `backendId` (optional, defaults to `minecraft`)
- `backendChannel` (optional, defaults to `minecraft`)
- `systemDisplayName` (optional, defaults to `Minecraft`)

0 comments on commit 5ef0a0b

Please sign in to comment.