diff --git a/README.md b/README.md index 9ef6e71..2347088 100644 --- a/README.md +++ b/README.md @@ -51,8 +51,7 @@ Compared to the legacy version, most of the features are done, along with some e ## Contributing -If you'd like to contribute to the project, please get in touch first, as we've got some designs goin on, and we'd hate to have any effort wasted! - +If you'd like to contribute to the project, please get in touch first, as we've got some designs in mind, and we'd hate to have any effort wasted! ## Get in touch @@ -61,6 +60,15 @@ https://chat.unfa.xyz/channel/liblast ## How to edit the game +Get the Godot 4 editor for the OS of your choosing from here: +https://downloads.tuxfamily.org/godotengine/testing/4.0/4.0-dev.20211004/ + +For example for Linux you need `Godot_[version]_linux.64.zip`. Extract the archive to obtain the Godot editor binary (yes, it's a single file). + +If you'll want to export the game (make game builds) you'll also need to download (and subsequently install in Godot) the export templates (file ending with `.tpz`). + +After you have that done - proceeed based on your OS: + ### GNU/Linux 1. Make sure you have `git`, `git-lfs` and `unzip` installed. @@ -80,23 +88,12 @@ cd liblast git lfs install ``` -5. Pull the large files (notably the currently used Godot binaries): +5. Pull the Git-LFS stored files: ``` git lfs pull ``` -6. Extract the godot editor binary: -``` -cd ./Godot -unzip godot-linux-nightly-x86_64.zip -``` - -7. Run the Godot editor binary and load the project: -``` -./godot ../Game/project.godot -``` - -Once Godot editor loads the project, hit `F5` to start the game. Alternatively you can run tehe `Liblst.sh` script, that'll do this for you. +6. Run the Godot editor and import the project located in `../Game/project.godot` ### Windows (untested!) @@ -115,29 +112,13 @@ git clone https://git.gieszer.link/unfa/liblast.git git lfs install ``` -5. Pull the large files (notably the currently used Godot binaries): +5. Pull the Git-LFS stored files: ``` git lfs pull ``` -6. Extract the godot editor binary (you can use Windows Explorer I guess): +6. Run the Godot editor and import the project located in `../Game/project.godot` ``` -unzip godot-windows-nightly-x86_64.zip -``` - -7. Run the Godot editor binary: -``` -godot.exe -``` - -8. Import the Liblast game project into Godot. - 1. Click on "Import" and select the `\Liblast\Game\` directory (it should contain a `project.godot` file) - 2. Click "Import and Edit" - the project will now be added to your projects list and will be easily accessible later - -9. Once Godot editor loads the project, hit `F5` to start the game. Alternatively you can click "Run" rom teh Project Selection in Godot, without loading it in the editor. - - -Because of Godot 4's unstable nature, things may not work. The game is being developed using the a particular build of the engine - the builds of the engine are included in this repository for the conveniece of developers and users. but to access them (in `Godot` directory) you need to clone the repository, install and pull from Git-LFS. # What does the name of this project mean?