Add docs

Author: Kade-N

docs/CNAME

@@ -0,0 +1 @@
+https://launcherkit.sporecommunity.com

docs/README.md

@@ -0,0 +1,41 @@
+# Launcher Kit website
+This site uses Jekyll, which is built into GitHub Pages. It converts markdown files into webpages.
+
+## Overview of files
+- `_config.yml` handles Jekyll configuration. It also defines variables which may be reused across pages.
+- `CNAME` sets the website URL. This file should not be modified.
+- `_layouts` contains the HTML templates used to generate the webpages. The contents of individual pages are automatically inserted into these templates to produce the website.
+- `style` contains CSS, images, and fonts, which define the visual style of the website.
+- `index.html` is the website homepage, containing the download link, and basic information and instructions.
+- `support.md` is the "Info & Support" page, containing links to "General Info" and "Common Errors", as well as instructions for getting support from others.
+- `_info` contains the pages that will appear under the "General Info" heading on the support pages.
+- `_common-errors` contains the pages that will appear under the "Common Errors" heading on the support pages.
+- `developers.md` is the "For Mod Developers" page, with basic info about making mods.
+
+## How to...
+### Add support pages
+Create a markdown (.md) file in either `_info` or `_common-errors`. If you are copying a guide from Discord, it can likely be used as-is, as the markdown syntax is mostly compatible.
+
+The file name will be used as the page URL, so choose something short and simple, yet unique and descriptive. It should use `snake-case`, i.e. no spaces or capital letters. The file name won't show on the page itself, only in the address bar. File names must be unique across both the `_info` and `_common-errors` folders.
+
+Choose a title that is not overly-long, as it will be shown in the navigation list. Add it to the very top of the file, using this format:
+```
+---
+title: An Appropriate Title
+---
+```
+
+If you need more advanced formatting, you can optionally create an HTML (.html) file instead of markdown.
+
+After pushing, the page will automatically be detected and added to the navigation list.
+
+### Change URLs that are reused across pages
+Some URLs used in links, for example, the links to Discord servers or specific downloads, are defined in the `_config.yml` file. Updating the URL in this file will change it across all pages where it is used.
+
+Additional URLs or values may be added to the config file. They can be used in a page with `{{ page.variable_name }}`.
+
+### Add top-level pages
+If it becomes necessary to add a top-level page to the top navigation bar, create a top-level (i.e. not in a folder) file using markdown or HTML, and give it a title as described above. Update `_layouts/default.html` as described in that file.
+
+### Add new categories for support pages
+If "General Info" and "Common Errors" are not enough, additional headings can be added. Add them to `_config.yml` matching the existing format. Create a new top-level folder with the same name used, prefixed with `_`. Update `_layouts/support-page.html` as described in that file.

docs/_common-errors/update-check-failed.md

@@ -0,0 +1,16 @@
+---
+title: Update Check Failed
+---
+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.
+
+## Fix by downloading latest Launcher Kit version directly
+Download the latest version of the Launcher Kit from the homepage. Follow the instructions to update your existing Launcher Kit.
+
+## Fix using `overrideUpdatePath.info` file
+1. Make sure you have installed the Launcher Kit and have run the ModAPI Launcher at least once (so that you see the "Update Check Failed" message).
+2. Open the ModAPI Easy Uninstaller and check the Launcher Kit version in the bottom left corner. It must be 1.4.1.0 or lower. If it is 1.5.0.0 or higher, please ask for help before continuing. You can ignore the DLLs build version.
+3. Open the folder `%appdata%\Spore ModAPI Launcher`. You can type/copy this into Windows search, the File Explorer address bar, or pressing Win+R and typing/copying it there. You should see files like `current.info` and `path.info` here.
+4. Download [this file](https://update.launcherkit.sporecommunity.com/overrideUpdatePath.info) and place it in the folder from the previous step. The file name must remain exactly as-is (`overrideUpdatePath.info`).
+5. Open the ModAPI Launcher. You should no longer get the error, and you will be prompted to update to the latest version.
+
+The `overrideUpdatePath.info` file will be removed automatically upon updating to Launcher Kit 1.5.0.0 or newer. This is normal - the fix has been built directly into the newer version, so a separate file is no longer needed. Do not put the file back in.

docs/_config.yml

@@ -0,0 +1,48 @@
+defaults:
+  # Default variables applied to all pages
+  - scope:
+      path: ""
+    values:
+      layout: "default"
+      # Add or change reusable variables here
+      lk_download_url: "https://github.com/Spore-Community/modapi-launcher-kit/releases/latest/download/ModApi.InterimSetup.exe"
+      smc_discord_url: "https://discord.gg/spore-modding"
+      license_name: "MIT License"
+      license_url: "https://github.com/Spore-Community/modapi-launcher-kit/blob/main/LICENSE"
+      modbrowser_url: "https://mods.sporecommunity.com"
+      patch151_url: ""
+      fixonline_mod_url: "https://mods.sporecommunity.com/?search=SporeFixOnline"
+      multiplesaves_mod_url: "https://mods.sporecommunity.com/?search=Spore-MultipleSaveFiles"
+      crashfix_mod_url: "https://mods.sporecommunity.com/?search=SporeCrashFix"
+      4gb_patch_url: "https://ntcore.com/?page_id=371"
+      modapi_url: "https://emd4600.github.io/Spore-ModAPI/index.html"
+      smfx_url: "https://emd4600.github.io/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
+  - scope:
+      path: "*.md"
+    values:
+      layout: "page"
+  # Use "support-page.html" sidebar layout for info pages
+  - scope:
+      type: "info"
+    values:
+      layout: "support-page"
+  # Use "support-page.html" sidebar layout for common error pages
+  - scope:
+      type: "common-errors"
+    values:
+      layout: "support-page"
+
+collections:
+  # Add additional categories here
+  info:
+    output: true
+    permalink: /support/:name
+  common-errors:
+    output: true
+    permalink: /support/:name
+
+# Prevents README files from being part of the actual website
+exclude: ["README.md", "**/README.md"]

docs/_info/galaxy-reset.md

@@ -0,0 +1,24 @@
+---
+title: Galaxy Reset
+---
+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.
+
+---
+
+## Locating the galaxy files
+Press Win+R and type in `%appdata%\Spore`. The `Games` folder contains your galaxy.
+
+## Creating a backup
+Copy or rename the `Games` folder. It can be left in the same Spore folder, or copied to another location. Give it a name, so you can identify it later - for example, the date, or the names of planets or species in that galaxy.
+
+To restore this backup at a later date, copy this backup folder back to its original place and name. You can have many different galaxies, each in a different folder, and swap between them as desired.
+
+## Generating a new galaxy
+If there is no folder called `Games` in the Spore folder, the game will generate a new galaxy the next time you launch the game. The effects of mods that require a galaxy reset should be visible in the newly-generated galaxy.
+
+---
+
+## Alternatives to manually swapping the Games folder
+You can alternatively use a mod which performs these steps automatically. [Find it here]({{ page.multiplesaves_mod_url }})

docs/_info/game-save-data.md

@@ -0,0 +1,48 @@
+---
+title: Backup Spore Save Data
+---
+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.
+
+---
+
+## Locating Spore's save data
+Press Win+R and type in `%appdata%\Spore`. This folder contains all Spore save data.
+
+---
+
+## Backing up data
+Make a copy of this entire `Spore` folder in a safe location.
+
+If the backup is too large, you may optionally exclude any `GraphicsCache` files, as these are not critical data and can be regenerated when needed.
+
+Do not separate any other files. In particular, the following files are necessary to ensure your creations and galaxy are kept intact, and *cannot* be mixed and matched with other copies of save data:
+- `Games` folder
+- `Planets.package`
+- `EditorSaves.package`
+- `Pollination.package` (there may be multiple)
+
+---
+
+## Restoring data
+To restore a backup, you must first remove or rename an existing `%appdata%\Spore` folder, if one exists. Merging or combining data is not supported and may result in corruption.
+
+Place the `Spore` folder back in its original location. When the game is launched, all data should be restored.
+
+---
+
+## The "My Spore Creations" folder
+While the *primary* copy of creations is stored in the above location, the game also exports PNG copies of your own creations to the `My Spore Creations` folder in `Documents`. This folder may be backed up to OneDrive on Windows.
+
+You can save a backup of this folder to have an extra copy of your creations.
+
+It is *not* recommended to restore this folder to its original location. Instead, if needed, you should drag individual PNGs from the backup of this folder directly into the game while it is running. This is a more reliable way to import creations and will ensure they are sorted properly in the Sporepedia.
+
+---
+
+## Tips for transferring data to a new computer
+- Make backups of the `%appdata%\Spore` and `My Spore Creations` folders (as described above) onto an external drive.
+- Keep copies of all `.sporemod` and `.package` mods.
+- On the new computer, install Spore and Galactic Adventures.
+- Install the Launcher Kit, and use the Easy Installer to install all mods you had.
+- Restore the backup by placing the copied folder back at `%appdata%\Spore`. If you have not yet launched the game, there will be no Spore folder here yet.
+- Launch the game, and everything should be exactly as you left it.

docs/_info/game-versions.md

@@ -0,0 +1,64 @@
+---
+title: Supported Game Versions
+---
+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.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
+
+Any other game version that is not listed here is not supported for modding.
+
+*Note: To use Spore's online features, you must have the latest game version (3.1.0.29), OR the [SporeFixOnline mod]({{ page.fixonline_mod_url }}).*
+
+### Checking your game version
+Open the folder where Spore Galactic Adventures is installed and open the `SporebinEP1` folder. Hover over `SporeApp` to see the game version.
+
+### Do not install multiple copies of the game
+Installing multiple copies of the game is known to cause a variety of problems. For example, do not install the game from EA App if you already have it installed from Steam or GOG. 
+
+### Note for EA App users
+The Launcher Kit needs to download a fix to allow mods to work on this version of the game. This fix *may* downgrade your game to 3.1.0.22 while using the Launcher Kit. There are no differences between 3.1.0.22 and 3.1.0.29 aside from online functionality, which can be restored with the [SporeFixOnline mod]({{ page.fixonline_mod_url }}).
+
+### Galactic Adventures requirement
+Due to major changes and technical improvements introduced in Galactic Adventures, the Launcher Kit and most mods cannot work without Galactic Adventures.
+
+### Pirated copies are not supported
+Ethical issues aside, pirated versions are often modified in such a way that they are incompatible with regular mods. In short, if it's not an official version of the game, we have no way of knowing what it contains, and therefore cannot effectively support it. Sharing links, asking for pirated copies or CD keys, or otherwise encouraging piracy is strictly prohibited in all partnered communities.
+
+---
+
+## Updating the game
+### EA App, Steam, and GOG Galaxy
+You may safely update their game using these apps. No further steps are required. Mods will not be affected in any way.
+
+### GOG offline installer
+You would need to reinstall the latest version of the game, downloaded from GOG.com. However, there is little reason to update if you already have 3.1.0.22, as there are no differences between 3.1.0.22 and 3.1.0.29 aside from online functionality, which can be restored with the [SporeFixOnline mod]({{ page.fixonline_mod_url }}).
+
+### Disc
+Disc users have two options.
+#### Updating to 3.0.0.2818
+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.
+
+#### Updating to 3.1.0.29
+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.
+
+*IMPORTANT*: Uninstall the disc versions before downloading the game from EA App.
+
+---
+
+## Downgrading the game
+It is not necessary to downgrade your game. However, Steam users may *optionally* downgrade their game to use the 4GB patch.
+
+### Downgrading to 3.1.0.22 on Steam
+- Press Windows Key (Win) + R, and type in `steam://open/console/` to open Steam's console.
+- From the Steam console, enter the command `download_depot 24720 24721 7407510787032991484` to prompt Steam to download the old version.
+- 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.

docs/_info/improving-stability.md

@@ -0,0 +1,34 @@
+---
+title: Improving Game Stability
+---
+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.
+
+---
+
+## SporeCrashFix
+This mod fixes crashes that occur in several *specific* scenarios, such as when dying in creature stage. It does not fix all crashes, but is highly recommended to fix some of the most common crashes in the game.
+
+[Download SporeCrashFix]({{ page.crashfix_mod_url }})
+
+---
+
+## 4GB Patch (Large Address Aware)
+Spore is an older game and is not optimized to take full advantage of modern computers. This external tool patches the game to use more memory, doubling from the historical Windows default of 2GB, to 4GB (internally known as being "large address aware"). This can reduce crashes that occur if the game exceeds the normal Windows memory limitations.
+
+This is not a Spore-specific patch and should not be confused with official Spore patches, such as patch 1.5.1.
+
+[Download 4GB Patch]({{ page.4gb_patch_url }})
+
+#### Disc and GOG
+Apply the 4GB patch to `SporeApp.exe` in the `SporebinEP1` folder.
+
+#### Steam
+The 4GB patch is not compatible with the latest Steam version of the game due to Steam's DRM. You must first [downgrade the game](game-versions).
+
+After downgrading, apply the 4GB patch to the newly-downloaded `SporeApp.exe` in the `SporebinEP1` folder.
+
+#### EA App
+Apply the 4GB patch to `SporeApp_ModAPIFix.exe` in the `SporebinEP1` folder.
+
+#### Linux and Mac users
+The 4GB patch is performed automatically by the Windows compatibility layer. No additional steps are required.

docs/_info/linux-mac.md

@@ -0,0 +1,14 @@
+---
+title: Linux & Mac Support
+---
+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**.
+
+This does not require the use of a Launcher app, as it allows mods to be loaded directly by the game itself. On platforms like Steam Deck, this means you can launch Spore Galactic Adventures normally from the Steam UI.
+
+A command-line mod manager app is included to install, list, and uninstall mods. It supports all the same mods as the Launcher Kit, including both .sporemod and .package formats, and provides all the same configuration options for mods that use them.
+
+[Learn more and download]({{ page.sporemodloader_url }})
+
+SporeModLoader may also be used on Windows, if preferred over the Launcher Kit.
+
+*Note: Do not use the Launcher Kit and SporeModLoader at the same time. Only install mods using one of them. Remove the files for SporeModLoader before using the Launcher Kit.*

docs/_info/outdated-mods.md

@@ -0,0 +1,26 @@
+---
+title: 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.
+
+## General guidelines
+- Mods released in 2018 or later are almost always compatible with the [game versions supported by the Launcher Kit](game-versions).
+- Mods released in 2010-2017 *may* be compatible, but not always. It is better to look for a newer version, if possible.
+- Mods released in 2009 or earlier should not be expected to work. In particular, mods released before Galactic Adventures should not be used.
+
+## Mods known to be outdated
+The mods listed here are known to be incompatible with the game versions supported by the Launcher Kit, and should be not be used. Use these mods at your own risk.
+
+- BetterSpore
+- PlatinumSpore
+- OrbitSpore
+- ForgottenSpore
+- TitanSpore
+- Dark Injection versions prior to 9.r Beta 2.3.2
+
+## Dark Injection
+While Dark Injection has historically been a popular mod to install, and the latest version (9.r Beta 2.3.2) works with the latest game version, the mod has been left in an unfinished and unpolished state, and has multiple known issues. As a result, we no longer recommend the mod.
+
+If you still want to use Dark Injection for its parts, you may use the mod, but it is strongly recommended to disable all non-essential options. Some of these options cause crashes, graphical issues, or incompatibilities with other mods. In particular, do not use the Full Darkspore UI or Darkspore Beta UI, and disable all options except the part categories.
+
+Please note that even with these options disabled, there are still known issues and incompatibilities that cannot be fixed without fully uninstalling Dark Injection.