aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
author George L. Albany <Megacake1234@gmail.com>2023-01-26 00:39:46 +0100
committer George L. Albany <Megacake1234@gmail.com>2023-01-26 00:39:46 +0100
commit1c13eadaa98b68fa64f222781d9160ec94fb884e (patch)
tree1fd5e57506ec9d9aca745433963c835c4ab35792 /README.md
parent039b562b8738aa7028ccc78deffb253f70928acb (diff)
feat(godot): Add Windows and Linux export presets.
feat(docs): Updated README.md to include install requirements, build/run instructions, and project export instructions.
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 22 insertions, 6 deletions
diff --git a/README.md b/README.md
index cb5570b..350f486 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,25 @@
# 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
+## Required
+* [Godot 4 Beta 14](https://downloads.tuxfamily.org/godotengine/4.0/beta14/)
+* [scons](https://scons.org/)
+
+## Build/Run Instructions
+1. Install [Godot 4 Beta 14](https://downloads.tuxfamily.org/godotengine/4.0/beta14/) and [scons](https://scons.org/) for your system.
+3. Run `scons` in the project root, you should see a libopenvic2 file in `game/bin/openvic2`.
+4. Open with Godot 4 Beta 14, click import and navigate to the `game` directory.
+5. Import and edit.
+6. 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
+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`:
+ * 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`:
+ * On Windows run `game/export/Windows/OpenVic2.exe`.
+ * On Linux x86_64 run `game/export/Linux-x86_64/OpenVic2.sh`.