@awayfl/awayfl-player 0.2.34 → 0.2.36

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1 +1,37 @@
1
- # awayfl-player
1
+ # AwayFL Player
2
+ Flash Player emulator for executing SWF files (published for FP versions 6 and up) in javascript
3
+
4
+ ## Prerequistes ##
5
+ - git ([installation instructions](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git))
6
+ - Node.js ([installation instructions](https://nodejs.dev/learn/how-to-install-nodejs))
7
+
8
+ ## Installing ##
9
+ Either use the template file [here](https://github.com/awayfl/awayfl-template) (recommended) or clone this repo and test your own content by typing the following into a terminal / cmd prompt / shell window:
10
+ ```shell
11
+ git clone https://github.com/awayfl/awayfl-player
12
+ cd awayfl-player
13
+ npm install
14
+ ```
15
+
16
+ ## Configuration ##
17
+ Open the `awayfl.config.js` file and add some SWF files to `fileconfigs`, including a `rt_title` and `rt_filename` entry (without the .swf extension), eg:
18
+
19
+ ```javascript
20
+ fileconfigs: [
21
+ {
22
+ rt_title: "my Awesome Flash Game",
23
+ rt_filename: "my_awesome_flash_game",
24
+ },
25
+ ],
26
+ ```
27
+
28
+ `awayfl.config.js` contains many additional configs (documented inline) that can be applied either global or locally to individual test SWFs.
29
+
30
+ ## Preview ##
31
+
32
+ To run a preview of your SWFs, start up the webpack development server:
33
+
34
+ ```shell
35
+ npm start
36
+ ```
37
+ Once compilation is complete, you can view your SWFs through the links at http://localhost. Updating SWFs or any files in `/src` will auto-reload the browser. However, any changes to `awayfl.config.js` will require a restart.
package/awayfl.config.js CHANGED
@@ -13,7 +13,7 @@ module.exports = {
13
13
  rt_showFPS: false, // show fps display - always false in prod
14
14
  cacheBuster: true, // add cachebuster to urls - always false in prod
15
15
  allowURLSearchParams: true, // allow changing config via url-params - always false in prod
16
- split: false, // create own folder for each file - only available in prod
16
+ split: true, // create own folder for each file - only available in prod
17
17
 
18
18
  entryName: "Main", // name of webpack-entry - must be set for each config (use package.main ?)
19
19
  entryPath: "./src/Main.ts", // path to webpack-entry - must be set for each config (use package.main ?)