initial commit

2026-07-31 18:33:44 +02:00
commit f3dce4f08a
5 changed files with 228 additions and 0 deletions
@@ -0,0 +1,52 @@
+# bevy-tools
+
+CI/CD templates for [Bevy](https://bevyengine.org) (Rust) game
+projects, in the same spirit as
+[ebitengine-tools](../ebitengine-tools) and
+[godot-tools](../godot-tools).
+
+- `example-makefile.make` — project Makefile: local dev targets
+  (`build`, `run`, `wasm`, `export`, `watch`, `clean`) plus the
+  Woodpecker pipeline targets (`ci-version`, `ci-export`, `ci-upload`,
+  `ci-update`).
+- `example-woodpecker.yaml` — Woodpecker pipeline: version → build
+  (Rust, `wasm32-unknown-unknown` target + `wasm-bindgen` in the
+  `rust:1-alpine` image) → upload (scp to the droparea) → update
+  (calls the teletypegames `/update` endpoint with `platform=bevy`).
+- `example-tasks.json` — VS Code `.vscode/tasks.json` with the common
+  dev tasks: **Run** (`cargo run`, default build task, `Cmd+Shift+B`),
+  **Build & Run**, **Build WASM** and **Make build**.
+- `web/index.html` — the HTML shell downloaded by `make export` and
+  packaged next to the `wasm-bindgen` output (`game.js` +
+  `game_bg.wasm`).
+
+## Usage in a game repo
+
+1. Copy `example-makefile.make` to `Makefile` and set `PROJECT`
+   (must match the crate name in `Cargo.toml`; the native binary is
+   built to `bin/$(PROJECT)`).
+2. Pin the `wasm-bindgen` crate in `Cargo.toml` to the exact version
+   in `WASM_BINDGEN_VERSION`:
+
+   ```toml
+   [target.'cfg(target_arch = "wasm32")'.dependencies]
+   wasm-bindgen = "=0.2.100"
+   ```
+
+   The `wasm-bindgen` CLI and the crate **must be the same version**,
+   otherwise the generated JS glue refuses to load. The pipeline
+   installs the CLI version parsed from the Makefile.
+3. Copy `example-woodpecker.yaml` to `.woodpecker.yaml` and add the
+   `droparea_ssh_password` / `update_secret_key` secrets in Woodpecker.
+4. Copy `example-tasks.json` to `.vscode/tasks.json` and replace the
+   binary name (`bevydemo`) with `$(PROJECT)`.
+
+Local WASM builds additionally need
+`rustup target add wasm32-unknown-unknown` and the `wasm-bindgen` CLI
+(`cargo install wasm-bindgen-cli --version 0.2.100`).
+
+The pipeline uploads `$(PROJECT)-$(VERSION).html.zip` to the droparea,
+then triggers
+`/update?platform=bevy&name=$(PROJECT)&version=$(VERSION)`.
+
+Detailed documentation lives on the wiki: `/development/bevy`.