Refresh documentation and add test script
CI / build-and-test (pull_request) Successful in 1m12s

This commit is contained in:
2026-09-17 17:02:52 +02:00
parent c390f4945f
commit 3877e36777
2 changed files with 10 additions and 19 deletions
+2 -19
View File
@@ -1,22 +1,9 @@
# Game Test
# Shinespark
A Bevy game, editable in the [jackdaw](https://github.com/jbuehler23/jackdaw) editor.
- `cargo run` plays the game standalone; no editor required.
- Open the folder in jackdaw to author scenes, then hit Play. The
editor builds its own artifacts into `.jackdaw/` (gitignored) and
never modifies your manifest or lockfile.
- Gameplay lives in `src/lib.rs` (`GamePlugin`); authored scenes live
in `assets/*.bsn`.
- Components you derive `Reflect` on appear in the editor's inspector
automatically; no registration code is needed.
Fancy heavily advanced platform fighting game
## Direct P2P Debugging
The debug match can be run as two processes over UDP. Each process uses a
different local port, and remote player declarations are keyed by the GGRS
player handle:
```text
# Process 1 owns player 0 and listens on 7000.
cargo run -- --debug-match --players 2 --local-port 7000 \
@@ -26,7 +13,3 @@ cargo run -- --debug-match --players 2 --local-port 7000 \
cargo run -- --debug-match --players 2 --local-port 7001 \
--net-player 0=127.0.0.1:7000 --net-player 1=local
```
Without `--net-player`, all requested players are local. This direct UDP
configuration is intentionally separate from match selection so a future
lobby provider can supply the same player roles and addresses.