From f6c5f631dbcfc749722fe1110401d4c6f5e6a067 Mon Sep 17 00:00:00 2001 From: hut Date: Fri, 26 Apr 2024 14:42:44 +0200 Subject: [PATCH] more doc for "dev_mode" feature --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a23810a..26deae0 100644 --- a/README.md +++ b/README.md @@ -209,7 +209,10 @@ cargo [run|build] --features dev This enables the following: - Mutes music by default (you can still unmute it) -- Enables "dev mode", which changes the game slightly, e.g. enables some debugging features and additional cheats. +- Enables "dev mode", which changes the game slightly: + - Enables additional cheats (see source code) + - Speeds up dialogs + - Adds additional debugging features - Enables dynamic linking for faster compile times. Note that this makes it harder to run the game directly with `./outfly`, please use `cargo run` instead. - Enables bevy's "file watcher" feature that auto-reloads changed assets while the game is running. This obviously works only if the assets are not embedded directly into the binary with the `embed_assets` feature. Since `embed_assets` is enabled by default, you must customize your compile features in order to use the file watcher feature, e.g. like: `--no-default-features --features "dev x11"`