From 65ad4677653b91c79db2ac3b0896ad8ffdf74790 Mon Sep 17 00:00:00 2001 From: QueenOfSquiggles <8940604+QueenOfSquiggles@users.noreply.github.com> Date: Sun, 8 Oct 2023 15:54:59 -0500 Subject: [PATCH] Improved and updated installation article --- docfx_project/articles/installation.md | 35 ++++++++++++++------------ 1 file changed, 19 insertions(+), 16 deletions(-) diff --git a/docfx_project/articles/installation.md b/docfx_project/articles/installation.md index efab412..068f1bf 100644 --- a/docfx_project/articles/installation.md +++ b/docfx_project/articles/installation.md @@ -5,7 +5,7 @@ This is a guide on how to install Squiggles Core 4X into your project. ## Prerequisites - Godot 4.1-Mono installed -- Your preferred dotnet version (6 or 7). Core is built for dotnet6 so this is recommended +- Your preferred dotnet version (6 or 7). Core is built for dotnet6 so this is recommended. - A programming environment that is currently working with Godot 4.1 and C# scripting - Fundamental understanding of computer systems @@ -23,8 +23,9 @@ You have options for your installation method. Installing from the respository g 4. Click on the download button and wait a few seconds 5. Click on the install button. 6. ***Disable*** all checkboxes except for: - - Core/ - - addons/ + +- addons/ *(optional)* +- Core/ > This means that those two folders are the only ones being installed. All else is extra tooling that is used for the development of this core system and is not necessary for you to create your game with. @@ -41,25 +42,27 @@ You have options for your installation method. Installing from the respository g 2. Click on the "Download ZIP" button and wait for your download to finish. 3. Open the zip archive file as well as your project folder 4. Copy over the folders into the root of your projects folder. - - addons/ + - addons/ *(optional)* - Core/ 5. Follow the common "Final Setup" steps to finish installation ### Final Setup - -1. Click on "Build" in the top right corner of the Godot editor. -2. Open "Project"->"Project Settings" in the top left corner -3. Go to the Plugins tab and enable: +1. Open "Project"->"Project Settings" in the top left corner +2. Go to the Plugins tab and enable: - squiggles_core_autoloads - squigglesbt -4. (Optional) Click on "Project"->"Reload Current Project" to reload the project and ensure all files are properly imported. -5. To ensure translation files are set up, go to "Project"->"Project Settings"->"Localization"->"Translations" and add "res://Core/Assets/Translation/translations_sheet.en.translation" -6. To add translations for different languages, modify "res://Core/Assets/Translation/translations_sheet.csv" with new columns for the language of your choice. Refer to the [offical documntation](https://docs.godotengine.org/en/stable/tutorials/assets_pipeline/importing_translations.html#doc-importing-translations) for instructions. Refer to [this page](https://docs.godotengine.org/en/stable/tutorials/i18n/internationalizing_games.html) for further help providing translation for your game/project. -7. Set your main scene for your project to "res://Core/this_is_your_main_scene.tscn" -8. In the root of your project, right click and in the context menu click "Create New"->"Resource..." -9. In the dialog that pops up, search for "SquigglesCoreConfigFile" and select it -10. In the "Save Resource As..." window, ensure that Path reads "res://". Into the "File" text box, enter "squiggles_config.tres". This is case sensitive and required but Squiggles Core 4X -11. Open the created ressource and fill out the properties desired. Ensure you create the resources for resource parameters (embedded is totally OK and even recommended) +3. A dialog window should appear with options to create relevant items for SC4X. Leave as default for the suggested installation. + - If not, click on "Project"->"Tools"->"SC4X Setup Dialog" to open it any time +4. Click on the "Ok" button to apply configuration +5. Wait a few seconds (dotnet dependencies really slow things down) +6. (Optional) Click on "Project"->"Reload Current Project" to reload the project and ensure all files are properly imported. +7. Open "res://squiggles_config.tres" and fill out your desired properties (Create it if it was not created earlier). Ensure you create the resources for resource parameters (embedded is totally OK and even recommended) + +### Translation/Internationalization + +To ensure translation files are set up, go to "Project"->"Project Settings"->"Localization"->"Translations" and add "res://Core/Assets/Translation/translations_sheet.en.translation" (english translations) + +To add translations for different languages, modify "res://Core/Assets/Translation/translations_sheet.csv" with new columns for the language of your choice. Refer to the [offical documentation](https://docs.godotengine.org/en/stable/tutorials/assets_pipeline/importing_translations.html#doc-importing-translations) for instructions. Refer to [this page](https://docs.godotengine.org/en/stable/tutorials/i18n/internationalizing_games.html) for further help providing translation for your game/project. ## Closing