diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 2f9a2f2..1b814f4 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -1,6 +1,14 @@ name: modapi-launcher-kit -on: [push, pull_request] +on: + push: + paths-ignore: + - 'docs/**' + - 'README.md' + pull_request: + paths-ignore: + - 'docs/**' + - 'README.md' jobs: build: @@ -162,4 +170,4 @@ jobs: Headers = @{Authorization="Bearer $env:CF_PURGECACHE_TOKEN"} Body = '{"hosts":["update.launcherkit.sporecommunity.com"]}' } - Invoke-WebRequest @params \ No newline at end of file + Invoke-WebRequest @params diff --git a/docs/_common-errors/antivirus.md b/docs/_common-errors/antivirus.md index 0ab4d8f..5db98eb 100644 --- a/docs/_common-errors/antivirus.md +++ b/docs/_common-errors/antivirus.md @@ -1,5 +1,6 @@ --- title: Defender/SmartScreen/Virus Detections +description: When a new Launcher Kit version is released, for a short period of time, the new version may be blocked by Windows Defender, SmartScreen, or your web browser. This is a false positive due to how Microsoft's filters work. Please read the full page for more details on how we keep the Launcher Kit safe. --- When a new Launcher Kit version is released, for a short period of time, the new version may be blocked by Windows Defender, SmartScreen, or your web browser. This is a false positive due to how Microsoft's filters work. @@ -54,8 +55,8 @@ All of these use HTTPS to ensure that your connection to the website has not bee **Do not download the Launcher Kit from any other website.** We do not maintain downloads on other websites, and cannot ensure that they have not been tampered with. For your safety, only download from the official locations. ### Safety when using mods -Please note that while the Launcher Kit itself is safe, we do not check individual mods for quality or safety. Only install mods from trusted sources. Use caution when installing unfamiliar mods. +Please note that while the Launcher Kit itself is safe, we cannot guarantee that individual mods have been checked for quality or safety. Only install mods from trusted sources. Use caution when installing unfamiliar mods. Do not run the Launcher as administrator, as this is a security risk because it removes certain safeguards, allowing mods to have full unrestricted access to your computer. -If in doubt, please [ask for help](/support) before downloading a mod that you are unsure about. +If in doubt, please [ask for help](/support) before downloading a mod that you are unsure about. \ No newline at end of file diff --git a/docs/_common-errors/crashes.md b/docs/_common-errors/crashes.md index 4b0f4e0..fa23081 100644 --- a/docs/_common-errors/crashes.md +++ b/docs/_common-errors/crashes.md @@ -1,5 +1,6 @@ --- title: Game Crashes +description: If your game freezes or crashes (i.e. "SPORE Galactic Adventures has stopped responding"), it may be due to a bug in the game itself, or due to a mod. See the page on Improving Game Stability for general recommendations that may help fix some crashes. You can ask for help when troubleshooting other crashes. --- If your game freezes or crashes (i.e. "SPORE Galactic Adventures has stopped responding"), it may be due to a bug in the game itself, or due to a mod. diff --git a/docs/_common-errors/data-directory-missing.md b/docs/_common-errors/data-directory-missing.md index e2becfc..857a9f2 100644 --- a/docs/_common-errors/data-directory-missing.md +++ b/docs/_common-errors/data-directory-missing.md @@ -1,5 +1,6 @@ --- title: Data directory is missing or corrupt +description: Steam users: Please launch Spore Galactic Adventures once from Steam before using the Launcher Kit. Afterwards, you should always use the ModAPI Launcher instead of launching from Steam. --- You may also see "Configuration Script Failed" along with this error. The two errors are related. diff --git a/docs/_common-errors/di-genetic-modifier.md b/docs/_common-errors/di-genetic-modifier.md index f40c29d..feebd30 100644 --- a/docs/_common-errors/di-genetic-modifier.md +++ b/docs/_common-errors/di-genetic-modifier.md @@ -1,5 +1,6 @@ --- title: Overlapping outfitters in Planner +description: In the Tribe, City, or Colony Planner, the outfitter tab may show two thumbnails that are overlapping, preventing access to the outfitter. This is a bug in Dark Injection. --- In the Tribe, City, or Colony Planner, the outfitter tab may show two thumbnails that are overlapping, preventing access to the outfitter. This is a bug in Dark Injection. diff --git a/docs/_common-errors/mod-outdated-function-name.md b/docs/_common-errors/mod-outdated-function-name.md index 0f33344..5ee9c13 100644 --- a/docs/_common-errors/mod-outdated-function-name.md +++ b/docs/_common-errors/mod-outdated-function-name.md @@ -1,5 +1,6 @@ --- title: Entry Point Not Found +description: This error means that a mod requires an update to work with the latest version of the ModAPI. Check that your mods are up-to-date. --- This error means that a mod requires an update to work with the latest version of the ModAPI. diff --git a/docs/_common-errors/not-c-drive.md b/docs/_common-errors/not-c-drive.md index aa43932..ee4e03e 100644 --- a/docs/_common-errors/not-c-drive.md +++ b/docs/_common-errors/not-c-drive.md @@ -1,5 +1,6 @@ --- title: The system cannot find the file specified +description: This error seems to occur when Spore is installed to a drive other than the C:\ drive. Unfortunately, we do not have any fix for this error, aside from reinstalling the game onto the C:\ drive. --- This error seems to occur when Spore is installed to a drive other than the C:\ drive. diff --git a/docs/_common-errors/steam-4gb-patch-error.md b/docs/_common-errors/steam-4gb-patch-error.md index 39f2847..db73010 100644 --- a/docs/_common-errors/steam-4gb-patch-error.md +++ b/docs/_common-errors/steam-4gb-patch-error.md @@ -1,5 +1,6 @@ --- title: Steam Application load error after 4GB patch +description: This error may occur if you have installed the 4GB patch on the latest Steam version of the game. You can remove the 4GB patch by verifying game files in Steam. This will fix the error. Please see proper instructions on how to use the 4GB patch with Steam. --- This error may occur if you have installed the 4GB patch on the latest Steam version of the game. It is caused by Steam's DRM. diff --git a/docs/_common-errors/update-check-failed.md b/docs/_common-errors/update-check-failed.md index 3ca5324..3a50e35 100644 --- a/docs/_common-errors/update-check-failed.md +++ b/docs/_common-errors/update-check-failed.md @@ -1,5 +1,6 @@ --- title: Update Check Failed +description: Download the latest version of the Launcher Kit from the website. Follow the instructions to update your existing Launcher Kit. --- This error occurs on Launcher Kit versions prior to 1.5.0.0. There are two ways to fix this error, you can perform either one. diff --git a/docs/_config.yml b/docs/_config.yml index 577a0f1..7958924 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -16,7 +16,9 @@ defaults: crashfix_mod_url: "https://mods.sporecommunity.com/?search=SporeCrashFix" 4gb_patch_url: "https://ntcore.com/?page_id=371" modapi_url: "https://modapi-docs.sporecommunity.com" + modapi_github_url: "https://github.com/Spore-Community/Spore-ModAPI" smfx_url: "https://smfx.sporecommunity.com" + smfx_github_url: "https://github.com/Spore-Community/SporeModder-FX" sporemodloader_url: "https://github.com/Rosalie241/SporeModLoader" gog_url: "https://www.gog.com/game/spore_collection" # Use "page.html" layout for markdown files diff --git a/docs/_info/galaxy-reset.md b/docs/_info/galaxy-reset.md index 980bfa3..9a35938 100644 --- a/docs/_info/galaxy-reset.md +++ b/docs/_info/galaxy-reset.md @@ -1,5 +1,6 @@ --- title: Galaxy Reset +description: Because all campaign games take place in a single galaxy, mods that alter certain elements may require resetting the entire galaxy, for the mod to take effect. This does mean you will lose *all* saved games. The Easy Installer will warn you when installing a mod that requires a galaxy reset. It does *not* reset the galaxy automatically, to ensure you can create your own backup copy, if needed. --- Because all campaign games take place in a single galaxy, mods that alter certain elements may require resetting the entire galaxy, for the mod to take effect. This does mean you will lose *all* saved games. diff --git a/docs/_info/game-save-data.md b/docs/_info/game-save-data.md index 90929fa..3f53776 100644 --- a/docs/_info/game-save-data.md +++ b/docs/_info/game-save-data.md @@ -1,5 +1,6 @@ --- title: Backup Spore Save Data +description: Spore saves all save data, including your galaxy (with all saved games), personal creations, downloaded creations, settings, saved login info, and cached data in one folder. --- Spore saves all save data, including your galaxy (with all saved games), personal creations, downloaded creations, settings, saved login info, and cached data in one folder. diff --git a/docs/_info/game-versions.md b/docs/_info/game-versions.md index afb4473..1561b88 100644 --- a/docs/_info/game-versions.md +++ b/docs/_info/game-versions.md @@ -1,8 +1,9 @@ --- title: Supported Game Versions +description: You must have a supported game version to use mods. Please read the page for more details. --- The following game versions are supported for mods: -- 3.0.0.2818 (July 2009) if installed from disc, with patch 5.1 manually installed +- 3.0.0.2818 (July 2009) if installed from disc, with patch 5.1 manually installed (see below) - 3.1.0.22 (March 2017) if installed from EA App, Steam, or GOG - 3.1.0.29 (October 2024) if installed from EA App, Steam, or GOG @@ -33,14 +34,16 @@ You would need to reinstall the latest version of the game, downloaded from GOG. ### Disc Disc users have two options. -#### Updating to 3.0.0.2818 +#### Updating to 3.0.0.2818 via patch While this is not the latest version of the game, it has no apparent differences from newer versions, aside from online functionality, which can be restored with the [SporeFixOnline mod]({{ page.fixonline_mod_url }}). Note that you must own both Spore and Galactic Adventures on disc, and have both installed. You cannot combine disc and download versions. -Download [Patch 1.5.1]({{ page.patch151_url }}) and install it. It will update your game to 3.0.0.2818. +Download [Patch 5.1]({{ page.patch151_url }}) and install it. It will update your game to 3.0.0.2818. -#### Updating to 3.1.0.29 +Do *NOT* install patch 6. This patch was never officially released and has multiple game-breaking issues. + +#### Updating to 3.1.0.29 via EA App Alternatively, you may be able to obtain a free copy of the game on EA App. You must be the original purchaser of the disc (i.e. cannot be a used copy). If you have used Spore's online features, download and launch EA App, sign in with the same account used for Spore, and see if Spore and Galactic Adventures are available to download. If not, choose Add a Game and enter the code from the back of each manual. If the codes do not work, you will need to contact EA Help to have them replaced. @@ -58,4 +61,4 @@ It is not necessary to downgrade your game. However, Steam users may *optionally - When it's installed, it will not be in the default location but instead in `Steam/Steamapps/Content/`, go there and, assuming it exists, navigate to `app_24720/depot_24721/SporeBinEP1`. - Copy the `SporeApp.exe` contained in that folder, and replace the existing one in the installed game's directory, usually `Steam/Steamapps/Common/Spore/SporebinEP1`, with the newly-downloaded version from the depot. -It is not possible or necessary to manually downgrade if the game was purchased elsewhere. +It is not possible or necessary to manually downgrade if the game was purchased elsewhere. \ No newline at end of file diff --git a/docs/_info/improving-stability.md b/docs/_info/improving-stability.md index 36e0c8f..5e91f75 100644 --- a/docs/_info/improving-stability.md +++ b/docs/_info/improving-stability.md @@ -1,5 +1,6 @@ --- title: Improving Game Stability +description: Spore has a number of bugs and crashes that have never officially been fixed. Some of these can be resolved using the SporeCrashFix mod and the 4GB patch tool. --- Spore has a number of bugs and crashes that have never officially been fixed. Some of these can be resolved using external tools and mods. diff --git a/docs/_info/linux-mac.md b/docs/_info/linux-mac.md index fd9ec46..df0d92a 100644 --- a/docs/_info/linux-mac.md +++ b/docs/_info/linux-mac.md @@ -1,5 +1,6 @@ --- title: Linux & Mac Support +description: The Launcher Kit is not optimized for use on Linux or Mac, which both use a Windows compatibility layer to run the game. On these platforms, it is instead recommended to use SporeModLoader. --- The Launcher Kit is not optimized for use on Linux or Mac, which both use a Windows compatibility layer to run the game. On these platforms, it is instead recommended to use **SporeModLoader**. diff --git a/docs/_info/outdated-mods.md b/docs/_info/outdated-mods.md index 445389e..1913987 100644 --- a/docs/_info/outdated-mods.md +++ b/docs/_info/outdated-mods.md @@ -1,5 +1,6 @@ --- title: Outdated Mods +description: Spore modding has been around for over 15 years, and many older mods have not been updated to be compatible with newer game versions. Please see the full page for details on outdated mods. --- Spore modding has been around for over 15 years, and many older mods have not been updated to be compatible with newer game versions. diff --git a/docs/_info/uninstall-lk.md b/docs/_info/uninstall-lk.md index 312af0b..a1c2d4a 100644 --- a/docs/_info/uninstall-lk.md +++ b/docs/_info/uninstall-lk.md @@ -1,5 +1,6 @@ --- title: Uninstall Launcher Kit +description: If you are uninstalling the Launcher Kit in an attempt to solve a problem, please read through the other support pages or ask for help first. You must uninstall all mods before uninstalling the Launcher Kit. --- ## Some notes before uninstalling If you are uninstalling the Launcher Kit in an attempt to solve a problem, please read through the other support pages or ask for help first. Most likely, your issue will not be resolved by simply reinstalling the Launcher Kit. diff --git a/docs/_info/update-lk.md b/docs/_info/update-lk.md index ab351d9..c9ab982 100644 --- a/docs/_info/update-lk.md +++ b/docs/_info/update-lk.md @@ -1,5 +1,6 @@ --- title: Updating Launcher Kit +description: The Launcher Kit will automatically check for updates every time you open the Launcher, Easy Installer, or Easy Uninstaller. If an update is available, you will be prompted to install it. --- The Launcher Kit will automatically check for updates every time you open the Launcher, Easy Installer, or Easy Uninstaller. If an update is available, you will be prompted to install it. diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index 3df164f..c03d543 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -2,7 +2,7 @@ - Spore ModAPI Launcher Kit - {{ page.title }} + Spore ModAPI Launcher Kit{% if page.url == "/" %} - {{ page.title }}{% endif %} @@ -10,9 +10,9 @@ - - - + + + @@ -45,7 +45,7 @@

Spore ModAPI Launcher Kit

diff --git a/docs/developers.md b/docs/developers.md index 72d9d50..408f1e2 100644 --- a/docs/developers.md +++ b/docs/developers.md @@ -1,17 +1,23 @@ --- title: For Mod Developers +description: Learn about making Spore mods using the Spore ModAPI SDK and SporeModder FX. --- ## Learn about making mods -- [Introduction to Spore modding (read this first)](https://github.com/emd4600/SporeModder-FX/wiki/Introduction-to-Spore-modding) -- [Creating your first mod](https://github.com/emd4600/SporeModder-FX/wiki/Tutorial:-Creating-your-first-mod) -- [SporeModder FX documentation](https://github.com/emd4600/SporeModder-FX/wiki) -- [ModAPI tutorials](https://emd4600.github.io/Spore-ModAPI/pages.html) -- [XML Mod Identity (ModInfo.xml) documentation](https://davoonline.com/sporemodder/rob55rod/ModAPI/Public/xmlModIdentity_v1_0_1_1.html) +- [Introduction to Spore modding (read this first)]({{ page.smfx_github_url }}/wiki/Introduction-to-Spore-modding) +- [Creating your first mod]({{ page.smfx_github_url }}/wiki/Tutorial:-Creating-your-first-mod) +- [ModAPI tutorials]({{ page.modapi_url }}/Spore-ModAPI/pages.html) ## Useful links -- [SporeModder FX]({{ page.smfx_url }}) -- [ModAPI SDK]({{ page.modapi_url }}) - [Spore Modding Community Discord]({{ page.smc_discord_url }}) +### SporeModder FX (data modding) +- [Download]({{ page.smfx_url }}) +- [Documentation]({{ page.smfx_github_url }}/wiki) +- [Source code]({{ page.smfx_github_url }}) +### ModAPI (code modding) +- [Documentation]({{ page.modapi_url }}) +- [Source code]({{ page.modapi_github_url }}) +### Publishing mods +- [XML Mod Identity (ModInfo.xml) documentation](https://davoonline.com/sporemodder/rob55rod/ModAPI/Public/xmlModIdentity_v1_0_1_1.html) ## Launcher Kit [The Launcher Kit itself is open source on GitHub]({{ site.github.repository_url }}) and licensed under the [{{ page.license_name }}]({{ page.license_url }}). It is built using .NET/C# and contributions are welcome! Instructions for building and contributing can be found in the [README]({{ site.github.repository_url }}) file. \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index f14cf0d..da27837 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,5 +1,6 @@ --- title: Home +description: The Spore ModAPI Launcher Kit installs, manages, and loads mods for Spore. It is the recommended way to install all mods, and allows mods to use advanced features, such as introducing new game modes, cheats, configurable options, and more. ---
diff --git a/docs/support.md b/docs/support.md index 0183053..37e6e2d 100644 --- a/docs/support.md +++ b/docs/support.md @@ -1,24 +1,25 @@ --- title: Launcher Kit Support layout: support-page +description: Get help with Spore mods. Please read the suggested steps on this page before asking for help. --- -### Ensure Launcher Kit is up-to-date -Before trying anything else, make sure you have the latest version of the Launcher Kit. The latest version is **{{ site.github.latest_release.name }}**. You can check your current version by opening the Easy Uninstaller and looking in the bottom left corner. - -If you see "Update Check Failed" please see [here](support/update-check-failed). - -Oftentimes, errors are caused by using an outdated Launcher Kit version, as many errors have been fixed in newer versions. - ### Common troubleshooting steps +- Ensure the Launcher Kit is up-to-date. The latest version is **{{ site.github.latest_release.name }}**. + - You can check your current version by opening the Easy Uninstaller and looking in the bottom left corner. + - If you see "Update Check Failed", please see [here](support/update-check-failed). - If you are getting an error, please look through the list on the left and see if the error is listed. - Make sure you have a [supported game version](support/game-versions). - Make sure you don't have any [outdated mods](support/outdated-mods). - If the game is working but occasionally crashes, see [improving stability](support/improving-stability). ### Get help -If you have tried all of the above and still need help, please take a screenshot of the error message (if applicable), and ask for help in the #mod-support channel of the [Spore Modding Community Discord]({{ page.smc_discord_url }}). Include the following information: -- A screenshot of the error message (if applicable) and/or a description of what is not working +If you have tried all of the above and still need help, please prepare the following information: - Where you got the game from (disc, EA App, Steam, or GOG) -- Your current mod list (ideally a screenshot of the Easy Uninstaller) +- Screenshot of the error message (if applicable) and/or a description of what is not working +- Screenshot(s) of the Easy Uninstaller, specifically showing both + - Your current mod list + - Your current Launcher Kit version + +Press Alt+PrtScr to copy a screenshot, then you can paste it directly into Discord or GitHub. -Press Alt+PrtScr while the error message is shown to copy a screenshot, then you can paste it directly into Discord. \ No newline at end of file +Submit the above information in the #mod-support channel of the [Spore Modding Community Discord]({{ page.smc_discord_url }}) (recommended), or, create an issue on GitHub and submit it there. We do not provide support via email or DMs. \ No newline at end of file