diff options
| author |   George L. Albany <Megacake1234@gmail.com> | 2023-01-26 12:23:27 +0100 |
|---|---|---|
| committer | George L. Albany <Megacake1234@gmail.com> | 2023-01-26 12:23:27 +0100 |
| commit | d20ea768a1be4b3a805e68dbe2ea6fd33a108292 (patch) | |
| tree | 0613955a85c7970023214051f43a279b7182a54b /README.md | |
| parent | 1c13eadaa98b68fa64f222781d9160ec94fb884e (diff) | |
feat(vscode): Add dev_build task and debugger launcher
feat(git): Ignore clangd cache and user VSCode files
feat(build): Make dev_build=yes overwrite the non-dev_build extension library
feat(docs): Added instructions in README.md to run Godot with our extension and attach a debugger
fix(docs): Corrected README.md Project Export header steps being off
TODO: vscode Debug launch configuration relies on /bin/godot4 in both Windows and Linux PATH, likely should be an environment variable.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 16 |
1 files changed, 11 insertions, 5 deletions
@@ -14,12 +14,18 @@ Main Repo for the OpenVic2 Project ## Project Export 1. Build the extension with `scons` or `scons target=template_debug`. (or `scons target=template_release` for release) -1. Open `game/project.godot` with Godot 4 Beta 14. -2. Click `Project` at the top left, click `Export`. -3. If you do not have the templates, you must download the templates, there is highlighted white text at the bottom of the Export subwindow that opens up the template manager for you to download. -4. Click `Export All`: +2. Open `game/project.godot` with Godot 4 Beta 14. +3. Click `Project` at the top left, click `Export`. +4. If you do not have the templates, you must download the templates, there is highlighted white text at the bottom of the Export subwindow that opens up the template manager for you to download. +5. Click `Export All`: * If you built with the default or debug target you must export with `Debug`. * If you built with the release target you must export `Release`. -5. Files will be found in platform specific directories in `game/export`: +6. Files will be found in platform specific directories in `game/export`: * On Windows run `game/export/Windows/OpenVic2.exe`. * On Linux x86_64 run `game/export/Linux-x86_64/OpenVic2.sh`. + +## Extension Debugging +1. If in a clean build, build the extension with `scons`. +2. Build with `scons dev_build=yes`. +3. [Setup your IDE](https://godotengine.org/qa/108346/how-can-i-debug-runtime-errors-of-native-library-in-godot) so your Command/Host/Launching App is your Godot 4 binary and the Working Directory is the `game` directory. +4. Start the debugger. |