diff --git a/README.md b/README.md index 92a6ed3..b3ea1ec 100644 --- a/README.md +++ b/README.md @@ -98,15 +98,36 @@ No releases for these operating systems exist yet. For MacOS, you can build OutF # Troubleshooting ## My GPU doesn't support Vulkan! -Try running outfly with the "--gl" option, with one of these commands: +Try running outfly with the command-line option "--gl", with one of these commands: ``` ./outfly --gl -cargo run --release -- --gl +cargo run -- --gl ``` This will result in some visual glitches, reduced performance, as well as a lot of error messages about CubeArrays which you can safely ignore. Internally, this option sets `WGPU_BACKEND` to `gl`. +## The game instantly crashes! + +Try changing the full screen mode with the command line option "--fs-legacy": + +``` +./outfly --fs-legacy +cargo run -- --fs-legacy +``` + +If this doesn't work, please open an issue on https://codeberg.org/hut/outfly and provide as many details as you can, including the crash log. + +## Crash with "error while loading shared libraries" + +If you build with `--features dev`, then you must not run the game `./outfly`. Use `cargo run` instead. + +## I'm on Windows. How do I use command-line options? + +Create a shortcut, change the target from `[...]outfly.exe` to e.g. `[...]outfly.exe --gl`. + +See https://superuser.com/questions/1202989/how-to-you-add-a-parameter-to-an-executable-in-windows-10 + # Building If there is no package for the version or operating system that you need, or if you wish to tinker on the game, you can also build outfly yourself.