Release/14.1.0 - Extension Data

README.md

@@ -48,7 +48,9 @@ Install by running ``sudo apt install libgtk-3-0 libnss3``
 
 4. Run ``npm run start`` (at the root of the repository) to start the launcher. It is recommended to do this in a second command prompt / terminal.
 
-5. **Optional** - It is highly recommended to set the launcher's "Flashpoint folder". This is where the launcher will read and write most data to and from. You can set the "Flashpoint folder" path at the "Config" tab in the launcher. Make sure the background of the text field is green (this means the path is valid) and don't forget to hit "Save and Exit"!
+5. React components use the React Compiler. If creating new components please make sure they are compiled, see this extension for a handy IDE hint in Vscode. Existing components are fine to be skipped. https://marketplace.visualstudio.com/items?itemName=blazejkustra.react-compiler-marker
+
+6. **Optional** - It is highly recommended to set the launcher's "Flashpoint folder". This is where the launcher will read and write most data to and from. You can set the "Flashpoint folder" path at the "Config" tab in the launcher. Make sure the background of the text field is green (this means the path is valid) and don't forget to hit "Save and Exit"!
 
 Notes:
 

docs/overhaul.md

@@ -0,0 +1,101 @@
+# Goals
+
+- Have a very deep level of visual and functional customization to the majority of the Launcher, particularlly the Browse pages
+- Turn most of the existing systems into jigsaw pieces that can be fit together at request of the extension developer
+- Provide easy to use ways to create customized components built like the existing set so extensions can choose to use them instead of reinventing the wheel
+- Allow highly specific functionality for content which won't interfere with other content that is also browseable in launcher
+- Create a basic yet flexible common Search API which extensions must adhere to, with ability to support any use case, for example:
+  - Browsing a local database (Flashpoint Archive)
+  - Browsing results taken from querying directories on disk (ROM file directories)
+  - Browsing results from existing APIs, like Steam, Youtube etc
+
+# Helper Functionality
+
+Flashpoint Launcher will provide a few extras to make it easier to support new data:
+- Running applications and background services can already be managed via the Services API
+- Wrapper for defining a List View with custom headers
+- Wrapper for defining a Grid View with a given Grid render function
+  - Game List Item wrapper, length must match header lengths, can provide individual render funcs for each
+  - Game Grid Item wrapper with a given id, title, logo and icon list
+- Built-in handling of Software component downloads and hash verifying the files before installation
+  - Software providers may have to handle verification and configuration themselves
+- Simple Metadata Update API for providers which do not read metadata remotely and want to only have updates apply on request (Subject to change)
+- React Components for common wrappers like:
+  - Home Page boxes with custom internals
+  - Editable sidebar fields which display and / or modify content metadata
+
+# Game
+
+Required fields:
+- `id` string
+- `title` string
+- `runner` string (Decides which content runner to use)
+- `logoPath` string (opt. Primary image)
+- `screenshotPath` string (opt. Secondary image)
+- `imageFileProvider` string (opt. Priority filter when choosing the file provider for Logos and Screenshots)
+
+Optional fields:
+- Arbitrary
+
+Extensions can coerce the type to narrow down type safety if they are confident their field is unique.
+
+# Content Runner
+
+Handles starting and stopping of games, and associated services like daemons.
+Register a unique handler to each `runner` value, Extensions can use code reuse if needed.
+
+Can implement the Software check
+
+# File Provider
+
+Exposes Logos, Screenshots or other Custom prefix routes over the localhost file server.
+For Logos and Screenshots, be fed a request, must write response itself, returns whether it handled the request.
+Content will priority use the `fileProvider` field otherwise iterate over each until one returns true.
+
+Custom routes will define a prefix which will exist under a unique name. Will handle all aspects of requests.
+
+# Software Components
+
+Extensions can register Software Components, these replace the old style Flashpoint Manager system.
+
+Provides easy management of prerequisite software and updating of software outside of individual games. Primarily for content which will help run content.
+
+Fields:
+- `id`
+- `name`
+- `installed`
+- `sizeOnDisk` (opt.)
+- `downloaddSize` (opt.)
+- `downloadHash` (opt.)
+- Arbitrary fields
+
+Flashpoint will likely use an optional 'provides' field or just check install state of components in its Content Runner.
+
+# Search Provider
+
+Search providers are given a query, and are expected to return results from an async function in a specific format with only a few required fields.
+They are free to decide how to perform that search, and the level of detail to return in a search vs when requesting a single game.
+Must fit query workflow via common API:
+- Text change or Advanced filters change forces query to rebuild (`rebuildQuery`)
+- Query building must consider both text and advanced filters at the same time
+- Query changing will automatically wipe existing results
+- Be able to return metadata for a specific game in full
+
+Can choose which search capabilities to support, must support at least one
+- Indexed Keyset Pagination (Current)
+- All results at once
+- Infinite scroll (Keyset Pagination)
+
+Frontend side must provide it's own way of presenting the data
+
+# Browse Page
+
+Each search provider will have an individual tab within the view.
+This makes sure the visuals remain tailored to the content the search provider has without requiring a high level of compatability between structures.
+Can choose which providers will be queryed even when the tab isn't in view.
+Current Tab -> Other Tabs in order, so results are faster on the first page.
+Rendering of tables is handled by the frontend portion of the search provider.
+
+The sidebar rendering function will be built by factory and cached based on the ID of the search provider.
+When a new render function is created, extensions will be queried in their load order to add or remove components.
+They can also register component overrides which are applied before theme component overrides.

eslint.config.mjs

@@ -5,17 +5,26 @@ import tseslint from 'typescript-eslint';
 import react from 'eslint-plugin-react';
 import stylistic from '@stylistic/eslint-plugin';
 import globals from 'globals';
+import reactHooks from 'eslint-plugin-react-hooks';
 
 export default tseslint.config(
     eslint.configs.recommended,
+    reactHooks.configs['recommended-latest'],
     ...tseslint.configs.recommended,
     {
-        files: ['**/*.{js,jsx,ts,tsx}'],
-        ignores: ['gulpfile.js'],
+        ignores: ['**/*.js']
+    },
+    {
+        files: ['**/*.{ts,tsx}'],
         plugins: {
             react,
             '@stylistic': stylistic,
         },
+        settings: {
+            react: {
+                version: '17'
+            }
+        },
         languageOptions: {
             parserOptions: {
                 ecmaFeatures: {
@@ -29,15 +38,9 @@ export default tseslint.config(
         rules: {
             "@stylistic/object-curly-spacing": ["warn", "always"],
             "@typescript-eslint/adjacent-overload-signatures": "off",
-            "@typescript-eslint/ban-types": ["error", {
-                "types": {
-                    "{}": false
-                },
-                "extendDefaults": true
-            }],
             "@typescript-eslint/explicit-function-return-type": "off",
             "@typescript-eslint/explicit-module-boundary-types": "off",
-            "@typescript-eslint/indent": ["error", 2, {
+            "@stylistic/indent": ["error", 2, {
                 "MemberExpression": 0,
                 "SwitchCase": 1
             }],
@@ -47,6 +50,7 @@ export default tseslint.config(
             "@typescript-eslint/no-namespace": "off",
             "@typescript-eslint/no-unused-vars": ["error", {
                 "vars": "all",
+                "caughtErrors": "none",
                 "args": "none"
             }],
             "@typescript-eslint/no-use-before-define": "off",

extensions/core-controller/.eslintignore

@@ -0,0 +1 @@
+*.js

extensions/core-controller/.gitignore

@@ -0,0 +1,4 @@
+dist/
+static/*.js
+static/mf*.json
+static/*mf-types*

extensions/core-controller/AntiMicroX/bin/antimicrox_settings.ini

@@ -0,0 +1,15 @@
+[General]
+DisplayNames=0
+WindowSize=@Size(650 883)
+WindowPosition=@Point(619 254)
+
+[Controllers]
+Controller0300f617de2800000512000000016800104624613MEDA20901796LastSelected=G:/Data/FP2/Data/Controller Configs/08143aa7-f3ae-45b0-a1d4-afa4ac44c845.gamecontroller.amgp
+Controller0300b7e67e050000092000000000680314068201e417d8018ac2ConfigFile1=G:/Data/Projects/launcher/extensions/core-controller/Controller Configs/08143aa7-f3ae-45b0-a1d4-afa4ac44c845.gamecontroller.amgp
+Controller0300b7e67e050000092000000000680314068201e417d8018ac2LastSelected=G:/Data/Projects/launcher/extensions/core-controller/Controller Configs/08143aa7-f3ae-45b0-a1d4-afa4ac44c845.gamecontroller.amgp
+Controller0300f617de2800000512000000016800104624613MEDA20901796ConfigFile1=G:/Data/FP2/Data/Controller Configs/08143aa7-f3ae-45b0-a1d4-afa4ac44c845.gamecontroller.amgp
+Controller0300b7e67e050000092000000000680314068201e417d8018ac2ConfigFile2=G:/Data/Projects/launcher/extensions/core-controller/Controller Configs/db15e875-6230-4fed-9901-0a3a8282155f.gamecontroller.amgp
+Controller0300f617de2800000512000000016800104624613MEDA20901796ConfigFile2=G:/Data/Projects/launcher/extensions/core-controller/Controller Configs/08143aa7-f3ae-45b0-a1d4-afa4ac44c845.gamecontroller.amgp
+Controller0300b7e67e050000092000000000680314068201e417d8018ac2ConfigFile3=G:/Data/FP2/Data/Controller Configs/08143aa7-f3ae-45b0-a1d4-afa4ac44c845.gamecontroller.amgp
+Controller0300f617de2800000512000000016800104624613MEDA20901796ConfigFile3=G:/Data/Projects/launcher/extensions/core-controller/Controller Configs/db15e875-6230-4fed-9901-0a3a8282155f.gamecontroller.amgp
+Controller0300b7e67e050000092000000000680314068201e417d8018ac2ConfigFile4=C:/Users/Colin/Documents/AlienHominid.gamecontroller.amgp

extensions/core-controller/AntiMicroX/share/antimicrox/LICENSE_SDL_GameControllerDB

@@ -0,0 +1,18 @@
+Simple DirectMedia Layer
+Copyright (C) 1997-2020 Sam Lantinga <[email protected]>
+
+This software is provided 'as-is', without any express or implied
+warranty.  In no event will the authors be held liable for any damages
+arising from the use of this software.
+
+Permission is granted to anyone to use this software for any purpose,
+including commercial applications, and to alter it and redistribute it
+freely, subject to the following restrictions:
+
+1. The origin of this software must not be misrepresented; you must not
+   claim that you wrote the original software. If you use this software
+   in a product, an acknowledgment in the product documentation would be
+   appreciated but is not required. 
+2. Altered source versions must be plainly marked as such, and must not be
+   misrepresented as being the original software.
+3. This notice may not be removed or altered from any source distribution.