Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
shirok1 committed Feb 3, 2024
1 parent 32d25fc commit 9fdd67e
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 9 deletions.
26 changes: 17 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# PalBoard

[![Build Frontend](https://github.com/shirok1/palboard/actions/workflows/frontend.yml/badge.svg)](https://github.com/shirok1/palboard/actions/workflows/frontend.yml) [![Build Gateway](https://github.com/shirok1/palboard/actions/workflows/gateway.yml/badge.svg)](https://github.com/shirok1/palboard/actions/workflows/gateway.yml)
[![Build Frontend](https://github.com/shirok1/palboard/actions/workflows/frontend.yml/badge.svg)](https://github.com/shirok1/palboard/actions/workflows/frontend.yml) [![Build Gateway](https://github.com/shirok1/palboard/actions/workflows/gateway.yml/badge.svg)](https://github.com/shirok1/palboard/actions/workflows/gateway.yml) [![Build Docker Image](https://github.com/shirok1/palboard/actions/workflows/docker-image.yml/badge.svg)](https://github.com/shirok1/palboard/actions/workflows/docker-image.yml)

A [Palworld](https://www.pocketpair.jp/palworld) dashboard, built with [Nuxt](https://nuxtjs.org/) and [Axum](https://github.com/tokio-rs/axum).

Expand Down Expand Up @@ -36,10 +36,24 @@ RUST_LOG=debug cargo run

## Features

![Screenshot of "Player List"](./assets/player_list.webp)
### SteamCMD Integration

If you are using the provided Docker compose file, installing or updating the game server is as simple as clicking a button on the web interface.

![Screenshot of updating](./assets/updating.gif)

There are also options to skip verification or updating only Steam itself if you are in a hurry.

### Configuration Editor

A [Monaco Editor](https://microsoft.github.io/monaco-editor/) is embedded to edit `PalWorldSettings.ini` on the web interface.

![Screenshot of "Config Editor"](./assets/config_editor.webp)

### RCON Commands

![Screenshot of "Player List"](./assets/player_list.webp)

See description on <https://tech.palworldgame.com/server-commands>.

Following table is corresponding to v0.1.2.0.
Expand All @@ -61,18 +75,12 @@ Symbols: ✔️(Complete), 🚧 (Work in Progress), ❌ (Incomplete), 🚫 (Impo

Teleport commands are not available because they need player context. If further update allows teleporting players from RCON context, they would be implemented.

### Docker API

Unimplemented. Possibly will be implemented with [bollard](https://lib.rs/crates/bollard).

### Future Plans

- SteamCMD integration (enabling server update)
- Container management (enabling server start/restart)
- Configuration management
- Parsing `DefaultPalWorldSettings.ini` is implemented (see `gateway/src/unreal_struct.rs`)
- The approach to control the content of `PalWorldSettings.ini` needs to be setteled before editing/generating (or unbanning, since it is not implemented on RCON interface for now) can be implemented
- If above is done, the management can be implemented as either a web editor (like [Monaco Editor](https://microsoft.github.io/monaco-editor/)) or a form (harder to maintain)
- A form-based editor for `PalWorldSettings.ini` is planned

## License

Expand Down
Binary file added assets/config_editor.webp
Binary file not shown.
Binary file added assets/updating.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9fdd67e

Please sign in to comment.