OpenVic2
Main Repo for the OpenVic2 Project
Quickstart Guide
For detailed instructions, view the Contributor Quickstart Guide here
Required
Godot Documentation
Build/Run Instructions
- Install Godot 4.0 and scons for your system.
- Run the command
git submodule update --init --recursive
to retrieve all related submodules. - Run
scons
in the project root, you should see a libopenvic2 file ingame/bin/openvic2
. - Open with Godot 4.0, click import and navigate to the
game
directory. - Import and edit.
- Once loaded, click the play button at the top right, if you see
Hello GDExtension Singleton!
in the output at the bottom then it is working.
Project Export
- Build the extension with
scons
orscons target=template_debug
. (orscons target=template_release
for release) - Open
game/project.godot
with Godot 4.0. - Click
Project
at the top left, clickExport
. - 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.
- 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
.
- If you built with the default or debug target you must export with
- 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
.
- On Windows run
Extension Debugging
- If in a clean build, build the extension with
scons
. - Build with
scons dev_build=yes
. - Setup your IDE so your Command/Host/Launching App is your Godot 4 binary and the Working Directory is the
game
directory. - Start the debugger.