You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: FlashpointSecurePlayer/README.md
+20-38Lines changed: 20 additions & 38 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Flashpoint Secure Player 1.0.0
1
+
# Flashpoint Secure Player 1.0.1
2
2
This application attempts to solve common compatibility or portability issues posed by browser plugins on Windows for the purpose of playback in BlueMaxima's Flashpoint.
3
3
4
4
It is compatible with Windows 7, Windows 8, Windows 8.1 and Windows 10, and requires .NET Framework 4.5. If you are on Windows 8.1 or Windows 10, or if you are on Windows 7/8 and have updates enabled, you already have .NET Framework 4.5. Otherwise, you may [download .NET Framework 4.5.](http://www.microsoft.com/en-us/download/details.aspx?id=30653)
@@ -15,7 +15,7 @@ This application has bugs. Help me find them! See the [Known Issues](#known-issu
15
15
The Mode determines what action Flashpoint Secure Player will perform after all of the Modifications are made. For example, the end goal may be to open a browser, or a specific software. The Mode to use is not optional. If it is not set, an error will occur. Modes are exclusive - there may only be one set at a time.
16
16
17
17
## <aname="activex-mode"></a>ActiveX Mode
18
-
**Command Line:** --activex (or -ax)
18
+
**Command Line:**`--activex` (or `-ax`)
19
19
20
20
*For curator use only.*
21
21
@@ -34,7 +34,7 @@ Please note that you should NOT use the ActiveX Mode in your final curation. The
34
34
This is a command you could use in your curation, remembering to include the Registry Backup in the curation. For more information about Registry Backups, see the section about [Registry Backup Modifications](#registry-backups) below.
35
35
36
36
## Server Mode
37
-
**Command Line:** --server (or -sv)
37
+
**Command Line:**`--server` (or `-sv`)
38
38
39
39
The Server Mode opens a URL in an Internet Explorer frame. The Flashpoint Proxy is used to access the URL, so Server Mode is Redirectorless.
40
40
@@ -43,24 +43,28 @@ It is possible to modify the Server Mode's behaviour by using the Server Mode Te
By default, the Internet Explorer version used in Server Mode is Internet Explorer 7. Changing the Internet Explorer version to use may be accomplished by means of HTTP headers or meta elements.
48
47
49
48
Here are some examples of meta elements that may be used to change the Internet Explorer version.
The Software Mode opens any software. The command line argument *must* be the last argument specified, as everything after the command line argument will be interpreted as the command line to be passed to the software.
66
70
@@ -73,7 +77,7 @@ It is possible to modify the Software Mode's behaviour by using the Software Mod
73
77
# Modifications
74
78
The Modifications determine what temporary modifications will be made for the duration of time that the application is open. Modifications are optional, none are required to be set. Modifications are not exclusive - there may be multiple Modifications set at a time.
75
79
76
-
The Modifications Name is set via the --name (or -n) command line argument. The Modifications Name is case-insensitive. When this argument is passed, Flashpoint Secure Player will check for a configuration file in the FlashpointSecurePlayerConfigs folder with the same name (with any invalid pathname characters replaced with a period character.) If it fails to find a configuration file in this folder, it will look for the configuration file on the Flashpoint Server at http://flashpointsecureplayerconfig/ using the same pathname rules. If the configuration file is not found in either location, an error occurs.
80
+
The Modifications Name is set via the `--name` (or `-n`) command line argument. The Modifications Name is case-insensitive. When this argument is passed, Flashpoint Secure Player will check for a configuration file in the FlashpointSecurePlayerConfigs folder with the same name (with any invalid pathname characters replaced with a period character.) If it fails to find a configuration file in this folder, it will look for the configuration file on the Flashpoint Server at http://flashpointsecureplayerconfig/ using the same pathname rules. If the configuration file is not found in either location, an error occurs.
77
81
78
82
Here is an example of a Modification that does not do anything, called "Example."
79
83
@@ -92,8 +96,7 @@ Here is an example of a Modification that does not do anything, called "Example.
The important element here is the `modification` element, which in future examples is all that will be shown. The rest of the configuration file will be the same in every configuration file Flashpoint Secure Player uses.
99
102
@@ -117,16 +120,14 @@ The command line below launches the Astro Avenger II ActiveX Control in Administ
117
120
The `modification` element below also causes Administrator Mode to be used.
The Mode Templates can modify the behaviour of the Server Mode and Software Mode such that a particular configuration file will cause these modes to be used. There is no ActiveX Mode Template.
127
129
128
130
**Server Mode Template**
129
-
130
131
The Server Mode Template provides the ability to apply a regex to the URL that was in the command line. For example, a `modification` element could be created which prefixes the URL with a specific domain.
131
132
132
133
```
@@ -138,15 +139,13 @@ The Server Mode Template provides the ability to apply a regex to the URL that w
138
139
</regexes>
139
140
</serverModeTemplate>
140
141
</modeTemplates>
141
-
</modification>
142
-
```
142
+
</modification>```
143
143
144
144
With the "Miniclip" Modification Name specified, all URLs passed into Server Mode will be modified, such that the command line below would cause the URL of http://www.miniclip.com/games/save-the-sheriff/en/ to open in the Internet Explorer frame.
**Software Mode Template and hideWindow Attribute**
149
-
150
149
The Software Mode Template works identically to the Server Mode Template in that it provides the ability to replace the command line passed in with regexes. The Software Mode Template also has an additional attribute, `hideWindow`, which causes the window of the software to be hidden. This is ideal for hiding console windows for softwares that have them.
151
150
152
151
For example, a practical use of the Software Mode Template would be to create a `modification` element that always ensures the use of important Java options.
@@ -160,8 +159,7 @@ For example, a practical use of the Software Mode Template would be to create a
160
159
</regexes>
161
160
</softwareModeTemplate>
162
161
</modeTemplates>
163
-
</modification>
164
-
```
162
+
</modification>```
165
163
166
164
With the "Java" Modification Name specified, the URL is factored into the regex, such that only the URL needs to be given when specifying the Software Mode argument. The command line below could be interpreted as passing the URL to the software.
167
165
@@ -180,21 +178,18 @@ Here is a modification `element` that sets the FP_UNITY_PATH variable to the loc
It is possible to use the Environment Variables Modification to set compatibility layers by setting the __COMPAT_LAYERS environment variable to a [compatibility fix.](http://docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows-7/cc765984(v=ws.10)) Here is a `modification` element that starts the software in 640 x 480 resolution.
The `type` attribute of the `registryBackup` element specifies whether the element represents a `KEY` or `VALUE`. If not specified, the default is `KEY`. The `keyName` and `valueName` attributes specify the location of the registry key and value. The `valueKind` attribute specifies the kind of value that will be set. Currently, only `String` (REG_SZ) is supported. If the `type` attribute is `KEY`, the `valueName`, `value`, and `valueKind` attributes are ignored.
253
245
254
246
There is no way to delete a registry key or value, only set them. The application may set a `_deleted` attribute, which is for internal use by the application only, and is ignored outside of the active configuration file (see the section about [Crash Recovery](#crash-recovery) below.)
255
247
256
248
**binaryType Attribute and WOW64 Keys**
257
-
258
249
*You do not need to include the WOW6432Node or WOW64AANode subkeys when creating a Registry Backup.* If the `binaryType` attribute of the `registryBackups` element is not set to `SCS_64BIT_BINARY`, the 32-bit registry view is used, so the WOW6432Node and WOW64AANode subkeys will be used automatically where necessary.
259
250
260
251
**ActiveX Imports**
261
-
262
252
See the section about [ActiveX Mode](#activex-mode) above.
263
253
264
254
**<a name="#crash-recovery"></a>Crash Recovery**
265
-
266
255
The configuration file in the same folder as the executable is the *active configuration file.* This configuration file is maintained by the application and is not meant to be modified by curators or users (unless there is an issue with loading the file.) This file is created so that the registry may be restored in the event of a crash, shutdown or power outage.
267
256
268
257
There are four possible scenarios.
@@ -277,7 +266,6 @@ In scenarios one and two, Flashpoint Secure Player reverts the active Registry B
277
266
If the Registry Backups Modification cannot be reverted, an error occurs and the application will exit, and not do anything else regardless of what Modes or Modifications are specified until the issue is resolved. If the registry has been modified by a different application outside of Flashpoint Secure Player, the application no longer assumes control of those registry keys and values, and the active Registry Backups Modification is silently discarded.
278
267
279
268
**Administrator Mode**
280
-
281
269
ActiveX Imports are always created in Administrator Mode, but it is not required during playback. Please note that in some cases, ActiveX Controls may be required to be launched in Administrator Mode. Flashpoint Secure Player will attempt to play the game without running as administrator by default, and in these cases, the ActiveX Control will not work unless the Run As Administrator Modification is used. For more information, see the section about the [Run As Administrator Modification](#run-as-administrator) above.
282
270
283
271
## Single Instance
@@ -300,8 +288,7 @@ This command line in combination with this `modification` element uses the Singl
The Single Instance Modification has two attributes: `strict` and `commandLine`. The `strict` attribute specifies whether the test only looks for the process with the exact same pathname or any process on the machine with a matching name. The default is `false`. The `commandLine` attribute specifies an alternate command line to test for. For example, in this instance, if the `commandLine` attribute were empty, it would instead look for `Basilisk-Portable.exe`.
307
294
@@ -310,15 +297,13 @@ Let's curate the game Zenerchi. The first step is to add the ActiveX Control to
**Creating a Registry Backup from an ActiveX Control**
313
-
314
300
The first time an ActiveX Control is added to Flashpoint, a curator must create an ActiveX Import. This is accomplished with the following command line, substituting the ActiveX Control's location. If not run as administrator, the curator will be asked to launch in Administrator Mode. This command line is NOT to be included in the curation metadata, it is only used to create the Registry Backup.
This will produce a file in the FlashpointSecurePlayerConfigs folder called `activex.zenerchiweb.1.0.0.10.zenerchi.1.0.0.10.dll.config`. This file may be included in the curation as if it existed at the URL of http://flashpointsecureplayerconfigs/activex.zenerchiweb.1.0.0.10.zenerchi.1.0.0.10.dll.config and it will be downloaded from the Flashpoint Server by Flashpoint Secure Player when required.
319
305
320
306
**Using the Registry Backup**
321
-
322
307
To use the ActiveX Control, the same Modification Name is specified but the Mode is changed to Server Mode with the URL to load. This is the command line the curation metadata may include.
@@ -354,13 +339,10 @@ You may notice that because the Flashpoint Secure Player is effectively capable
354
339
355
340
# Questions And Answers
356
341
**Is there is Linux version?**
357
-
358
342
No, but also, what? This application deals mostly in solving Windows specific problems (to do with the registry, or running as administrator, etc.) for Windows specific plugins. The types of programs Flashpoint Secure Player is useful for would not have run natively on Linux in the first place.
359
343
360
344
**Why does the Modification Name need to be specified in the configuration file if the filename of the configuration file also reflects it?**
361
-
362
345
It provides additional redundancy, ensuring the configuration file loaded was the one intended, and also opens the door for potentially allowing single configuration files to have multiple `modification` elements in the future.
363
346
364
347
**Shouldn't the Flashpoint Launcher just have these features built in?**
0 commit comments