FlashpointProject · colin969 · Nov 14, 2023 · Nov 16, 2023 · Mar 17, 2024 · Mar 29, 2024
diff --git a/.eslintrc.json → .eslintrc-old.json b/.eslintrc.json → .eslintrc-old.json
diff --git a/.gitmodules b/.gitmodules
@@ -4,6 +4,3 @@
 [submodule "docs/api"]
 	path = docs/api
 	url = https://github.com/FlashpointProject/launcher_ApiDocs.git
-[submodule "extensions/core-curation"]
-	path = extensions/core-curation
-	url = https://github.com/FlashpointProject/Sys-Extension-Core-Curation.git
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,54 +1,7 @@
-Note: This is still a work in progress. Some parts of this file are not finalized and are kept outside of the project.
+It's recommended to read the Documentation if you wish to contribute to Flashpoint Launcher development.
 
-# Branch naming guidelines and Pull Requests
+You'll likely find help in the #launcher channel of the discord as well.
 
-Branches are expected to follow the git flow naming scheme:
-- `feature/<name>`
-- `bugfix/<name>`
-- `hotfix/<name>`
+Documentation: https://flashpointproject.github.io/launcher
 
-Make sure that the base for PRs is set to ``develop`` for features and ``master`` or ``develop`` for hotfixes or bugfixes.
-
-Maintainer Note - Make sure to merge hotfixes and bugfixes manually with `--no-ff` into both master and develop. See https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow for more detail.
-
-# Commit Message Guidelines
-
-*Note: These guidelines are based on the [guidelines used by Angular](https://github.com/angular/angular/blob/master/CONTRIBUTING.md)*
-
-Each commit message consists of a header, a body and a footer. The header has a special format that includes a type and a subject:
-
-```
-<type>: <subject>
-<BLANK LINE>
-<body>
-<BLANK LINE>
-<footer>
-```
-
-The **header** is mandatory. The **body** is optional. The **footer** is temporarily forbidden.
-
-The **subject**, **body** and **footer** may be split over any number of lines, but they must not contain any blank lines (in order to make it clear where each section begin and end).
-
-Any line of the commit message MUST NOT be longer than 73 characters!
-
-## Type
-
-Must be one of the following:
-
-* **build**: Changes that affect the build system or external dependencies (for example: editing ``package.json``, ``gulpfile.js`` or ``.eslintrc.json``)
-* **docs**: Documentation only changes
-* **feat**: A new feature
-* **fix**: A bug fix
-* **github**: Changes to our GitHub CI configuration files or scripts
-* **perf**: A code change that improves performance
-* **refactor**: A code change that neither fixes a bug nor adds a feature
-* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.)
-* **test**: Adding missing tests or correcting existing tests
-
-## Body
-
-Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.
-
-## Footer
-
-The footer is **RESERVED** and must not be included in any commit.
+Discord: https://discordapp.com/invite/qhvAkhWXU5
diff --git a/README.md b/README.md
@@ -11,7 +11,8 @@ The launcher for Flashpoint Archive (the non-profit web preservation project).
 [![Crowdin](https://badges.crowdin.net/flashpoint-launcher/localized.svg)](https://crowdin.com/project/flashpoint-launcher)
 
 ### Links
-* [Flashpoint Archive](http://flashpointarchive.org) - Download Flashpoint here (the launcher is bundled with it)
+* [Documentation](https://flashpointproject.github.io/launcher) - Documentation for Configuation, Development and Extensions information of the Flashpoint Launcher.
+* [Flashpoint Archive](https://flashpointarchive.org) - Download Flashpoint here (the launcher is bundled with it)
 * [Donate](https://opencollective.com/flashpointarchive) - Funds go towards the Flashpoint Archive non-profit to sustain archival efforts, not to fund developers of the launcher.
 
 ## About

diff --git a/docs/configuration/config.md b/docs/configuration/config.md
@@ -0,0 +1,39 @@
+# config.json
+
+## Overview
+
+The `config.json` file will be generated next to the Launcher executable and will have a few basic settings that can often be considered immutable by your project.
+
+User or Data version specific options are found in [preferences.json](preferences) instead.
+
+## Options
+| Config Key                        | Description                                                                                                                                        |
+| --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `flashpointPath`                  | Path to the root folder (where the `/Data` folder will be), can be relative or absolute. Same folder as the working directory when empty.          |
+| `useCustomTitlebar`               | If set to true, it will allow the operating system to use its own titlebar instead of our own.                                                     |
+| `startServer`                     | Whether the `server` will be automatically started and closed as defined in [services.json](services)                                              |
+| `backPortMin` / `backPortMax`     | Port range the Launcher will iterate over to get a free port when opening the websocket for front / back communication                             |
+| `imagesPortMin` / `imagesPortMax` | Port range the Launcher will iterate over to get a free port when opening the Fileserver to respond to image (and curate file) local web requests. |
+| `logsBaseUrl`                     | The base URL of the Flashpoint Paste server. You're free to use ours by default or selfhost.                                                       |
+| `updatesEnabled`                  | **UNUSED**                                                                                                                                         |
+| `gotdUrl`                         | The URL where a remote `gotd.json` is located and will be fetched on startup. If unavailable, the existing `/Data/gotd.json` file will be used.    |
+| `gotdShowAll`                     | When set to true, will stop hiding games that are chosen for a date later than Today.                                                              |
+| `middlewareOverridePath`          | Used by extensions when copying files to override those returned by the Flashpoint Game Server if used. Pretty Flashpoint Archive specific.        |
+
+## Default Configuration
+
+```json title="config.json"
+{
+  "flashpointPath": "",
+  "useCustomTitlebar": false,
+  "startServer": true,
+  "backPortMin": 12001,
+  "backPortMax": 12100,
+  "imagesPortMin": 12101,
+  "imagesPortMax": 12200,
+  "logsBaseUrl": "https://logs.unstable.life/",
+  "updatesEnabled": true,
+  "gotdUrl": "https://download.unstable.life/gotd.json",
+  "gotdShowAll": false,
+  "middlewareOverridePath": "Legacy/middleware_overrides/"
+}
diff --git a/docs/credits.md → docs/configuration/credits.md b/docs/credits.md → docs/configuration/credits.md
@@ -8,7 +8,7 @@ E.G Profile roles in the order `"Two", "One", "Three"` will match `Two` first.
 
 ### Layout
 
-```json
+```json title="/Data/credits.json"
 {
   "roles": [
     {

diff --git a/docs/configuration/introduction.md b/docs/configuration/introduction.md
@@ -0,0 +1,15 @@
+# Introduction
+
+## Overview
+
+The Configuration documentation is written from the perspective of someone wanting to use Flashpoint Launcher for their own project, and made using the knowledge of how it works for Flashpoint Archive.
+
+[**config.json**](config) - `config.json` defines the most basic operation settings, such as path to the root data folder and some immutable options like logs server url and Game of the Day remote server url.
+
+[**preferences.json**](preferences) - `preferences.json` defines user specific and data version specific settings like different folder paths, Browse page and Curate page settings. This page will explain how to set default preferences for the user, including when they delete their own preferences file.
+
+[**Services**](services) - `/Data/services.json` defines the background services, and required server process that Games will need. This is fairly flexible and should fit your needs most of the time.
+
+[**Shortcuts**](shortcuts) - Defined in `preferences.json` this covers all keyboard shortcuts in the Flashpoint Launcher. This is only relevant for the Curate page currently.
+
+[**Credits**](credits) - `/Data/credits.json` defines the user details that appear on the about page. This should be specific to the people working on your project.