aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
author George L. Albany <Megacake1234@gmail.com>2023-01-25 02:07:01 +0100
committer George L. Albany <Megacake1234@gmail.com>2023-01-25 02:07:01 +0100
commit5371a960c9f0665d7de594cc5e274db225620207 (patch)
treef0c5d01c2ae8c2293b60af9b120440730021ccc3 /README.md
parentc16b58ddb07a4f814a4efa1dc3bf72e7bbe5f932 (diff)
feat(build): Implement scons building
feat(engine): Integrate basic Godot project feat(test): Demonstrate Godot using extension feat(dependency): Add OV2-compiler as deps submodule feat(dependency): Add godot-cpp as a submodule feat(git): Ignore Godot 4 files feat(docs): Updated readme with instructions feat: Can call `TestSingleton.hello_singleton()` from GDScript Adds basic workflow support but that is currently disabled
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
index 3aefcaa..cb5570b 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,9 @@
# OpenVic2
Main Repo for the OpenVic2 Project
+
+# Instructions
+1. Ensure you have [scons](https://scons.org/) installed.
+2. Run `scons` here, when finished a libopenvic2 file will appear in `game/bin/openvic2`
+3. Open with Godot 4 beta 14, click import and navigate to the game directory
+4. Import and edit
+5. 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. \ No newline at end of file