summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorammar sadaoui <ammar.gcb@proton.me>2025-07-09 20:06:16 +0100
committerGitHub <noreply@github.com>2025-07-09 15:06:16 -0400
commitc30597249ff82d75b98edcd3bdf382ca99a13e61 (patch)
tree65b8019ab7f69e8332e9cacae1426d70ed071b26 /README.md
parent5b86f5a50de135e691ad6a2c65622a7d719f0942 (diff)
Fix incorrect backend ID for OpenGL in README.md (#1197)
Correct backend ID values in README.md (OpenGL was listed as 3 instead of 1)
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/README.md b/README.md
index 80f507ede..a10852387 100644
--- a/README.md
+++ b/README.md
@@ -51,7 +51,13 @@ Congratulations, you are now sailing with 2 Ship 2 Harkinian! Have fun!
| Ctrl+R | Reset |
### Graphics Backends
-Currently, there are three rendering APIs supported: DirectX11 (Windows), OpenGL (all platforms), and Metal (macOS). You can change which API to use in the `Settings` menu of the menubar, which requires a restart. If you're having an issue with crashing, you can change the API in the `2ship2harkinian.json` file by finding the line `"Backend":{`... and changing the `id` value to `3` and set the `Name` to `OpenGL`. `DirectX 11` with id `2` is the default on Windows. `Metal` with id `4` is the default on macOS.
+Currently, there are three rendering APIs supported: DirectX 11 (Windows), OpenGL (all platforms), and Metal (macOS). You can change which API to use in the `Settings` menu of the menubar, which requires a restart.
+
+If you're having an issue with crashing, you can also change the API manually in the `2ship2harkinian.json` file by finding the `"Backend": {` section and updating the backend ID and name. Be sure to use one of the valid values:
+
+- `0` = DirectX 11 (default on Windows)
+- `1` = OpenGL
+- `2` = Metal (default on macOS)
# Custom Assets