Merge pull request #410 from FlashpointProject/feature/ruffle

Game Configurations

.eslintignore

@@ -2,4 +2,5 @@
 src/database/migration/*
 build/*
 typings/*
-gulpfile.*
+gulpfile.*
+*webpack*.config.js

docs/middleware.md

@@ -0,0 +1,87 @@
+# Middleware
+
+Extensions can provide middleware which a user can choose to apply before a game launches. This can be useful for modifying game files, creating new files or modifying launch options before a game starts.
+
+# Context - Game Configurations
+
+Each game configuration belongs to a specific game ID, and has a specific owner. It contains a list of configured middleware to apply to a game before launching and these configurations can be swapped per game at will by the user:
+
+- **Game ID** - Either `template` for a template configuration, for the game id.
+- **Owner** - Either `local` for a user created configuration, or something else for remote synced configurations.
+
+Template configurations are available to use on any game, provided the game is valid for each used middleware. It is ideal for configurations applicable to a wide array of games.
+
+Configurations synced from a remote server are not modifiable by the user, but can be copied into a game specific configuration. This can be made into a local template too.
+
+# Middleware Structure
+
+- `id` - Unique identifier for the middleware
+- `name` - Name of the middleware to display to the user
+- `isValid(game)` - Returns whether the middleware is valid for the game
+- `isValidVersion(version)` - Returns whether the version string is valid for this middleware
+- `getDefaultConfig(game)` - Returns the default middleware configuration for a game
+- `getConfigSchema(version)` - Returns the configuration schema for the middleware version 
+- `execute(config)` - Executes to apply the middleware when launching game
+
+## Changing Launch Info
+
+Whilst this can already be achieved globally via `onWillLaunchGame` and `onWillLaunchAddApp`, a preference should be made to use middleware unless intended to apply to every game without question.
+
+## Replacing Existing Game Files
+
+`Legacy/htdocs/content/` acts a second root directory to `Legacy/htdocs/`. 
+
+E.G `http://example.com/game.txt` would check in the order:
+ `Legacy/htdocs/content/example.com/game.txt`, then any loaded gamezips, then `Legacy/htdocs/example.com/game.txt`
+
+You can either write these directly yourself, or use the utility functions to create or copy files.
+
+- `writeServedFile` - Writes data to a file e.g `example.com/game.txt`
+- `writeServedFileByUrl` - Writes data to a file based on a URL, e.g `http://example.com/game.txt` writes to `example.com/game.txt`. Useful when overriding launch commands.
+- `copyServedFile` - Copies a file to the specified path e.g `example.com/game.txt`
+
+## Developer Notes
+
+- Goals
+  - Overview
+    - Individual game configurations with several applied middleware
+    - Allow multiple game configurations to be stored
+      - Store ownership to support easy sync (local, remote server etc)
+    - Extension support to create middleware
+      - Use system extensions for 'built-in' middleware
+  - File and launch info modification support
+    - Support creating new files to serve over proxy
+    - Support overriding existing files to serve over proxy
+    - Allow modification of launch info (similair to onWillLaunchGame)
+      - Launch info should be runtime validated by launcher before game launch
+    - Allow specific orders of execution for middleware, with individual middleware configs.
+  - Detailed middleware configuration
+    - Create new config schemas (use existing dialog options code)
+    - Return the correct config schema based on the factors given by the game's configuration
+      - Chosen middleware version
+      - Launch Command(?)
+      - Platform(?)
+    - Support upgrading old configs where older versions are not supported anymore
+    - User can modify this configuration inside the launcher using simple dialogs
+      - Raw JSON support? Would this be too difficult to validate?
+    - Allow middleware to be enabled or disabled in the game's configuration, without removing anything
+
+- Middleware shape
+  - Get config schema given parameters e.g
+    - Version
+    - Platform(?)
+    - Launch Command(?)
+  - Validate config(?) (optional)
+  - Check enabled state based on existing game info or config(?)
+  - Execution method
+    - Runtime validation of returned launch info
+
+- Served file overrides any existing file in gamezip or htdocs
+
+- Utility functions
+  - Write served file by path
+  - Write served file by url
+  - Copy served file by path
+  - Copy served file by url
+  - Extract file from game zip by path
+  - Extract file from game zip by url

extensions/core-ruffle/.gitignore

@@ -0,0 +1,4 @@
+out
+dist
+node_modules
+*.fplx

extensions/core-ruffle/README.md

@@ -0,0 +1,63 @@
+# core-ruffle README
+
+This is the README for your extension "core-curation". After writing up a brief description, Flashpoint recommends including the following sections.
+
+## Features
+
+Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
+
+For example if there is an image subfolder under your extension project workspace:
+
+\!\[feature X\]\(images/feature-x.png\)
+
+## Requirements
+
+If you have any requirements or dependencies, add a section describing those and how to install and configure them.
+
+## Extension Settings
+
+Include if your extension adds any Config page settings through the `contributes.configuration` extension point.
+
+## Icon
+
+Add a Icon to your extension, this will be shown on the Config page.
+
+Add this to your package.json and move your icon to icon.png, or change the path to another image in your extension folder.
+* `"icon": "./icon.png"`
+
+## Known Issues
+
+Calling out known issues can help limit users opening duplicate issues against your extension.
+
+## Release Notes
+
+Users appreciate release notes as you update your extension.
+
+### 1.0.0
+
+Initial release of ...
+
+### 1.0.1
+
+Fixed issue #.
+
+### 1.1.0
+
+Added features X, Y, and Z.
+
+-----------------------------------------------------------------------------------------------------------
+
+## Working with Markdown
+
+**Note:** You can author your README using Visual Studio Code.  Here are some useful editor keyboard shortcuts:
+
+* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux)
+* Toggle preview (`Shift+CMD+V` on macOS or `Shift+Ctrl+V` on Windows and Linux)
+* Press `Ctrl+Space` (Windows, Linux) or `Cmd+Space` (macOS) to see a list of Markdown snippets
+
+### For more information
+
+* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
+* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)
+
+**Enjoy!**

extensions/core-ruffle/gulpfile.js

@@ -0,0 +1,43 @@
+const { series } = require('gulp');
+const fs = require('fs');
+const gulp = require('gulp');
+const zip = require('gulp-zip');
+const merge = require('merge-stream');
+
+const filesToCopy = [
+    'extension.js',
+    'package.json',
+    'icon.png',
+    'LICENSE.md',
+    'README.md'
+];
+
+function clean(cb) {
+    fs.rm('./package', { recursive: true }, (err) => {
+        if (err) { console.log('Clean', err); }
+        cb();
+    });
+}
+
+function stage() {
+    const streams = filesToCopy.map(file => {
+        if (fs.existsSync(file)) {
+            return gulp.src(file).pipe(gulp.dest('package/core-curation'));
+        }
+    }).filter(s => s !== undefined);
+    return merge([
+        ...streams,
+        gulp.src('out/**/*').pipe(gulp.dest('package/core-curation/out')),
+        gulp.src('dist/**/*').pipe(gulp.dest('package/core-curation/dist')),
+        gulp.src('static/**/*').pipe(gulp.dest('package/core-curation/static')),
+    ]);
+}
+
+function package() {
+    return gulp.src('package/**/*').pipe(zip('core-curation.fplx')).pipe(gulp.dest('.'));
+}
+
+exports.clean = clean;
+exports.stage = stage;
+exports.package = package;
+exports.default = series(clean, stage, package);