Skip to content

Commit b95ad3e

Browse files
committed
ooops, undo all the things I broke in the README
1 parent 2746cbf commit b95ad3e

1 file changed

Lines changed: 33 additions & 10 deletions

File tree

FlashpointSecurePlayer/README.md

Lines changed: 33 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ It is possible to modify the Server Mode's behaviour by using the Server Mode Te
4343
`FlashpointSecurePlayer --server "http://www.example.com"`
4444

4545
**Setting The Internet Explorer Version**
46+
4647
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.
4748

4849
Here are some examples of meta elements that may be used to change the Internet Explorer version.
@@ -96,7 +97,8 @@ Here is an example of a Modification that does not do anything, called "Example.
9697
<startup>
9798
9899
<supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5"/></startup>
99-
</configuration>```
100+
</configuration>
101+
```
100102

101103
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.
102104

@@ -120,14 +122,16 @@ The command line below launches the Astro Avenger II ActiveX Control in Administ
120122
The `modification` element below also causes Administrator Mode to be used.
121123

122124
```
123-
<modification name="example" runAsAdministrator="true" />```
125+
<modification name="example" runAsAdministrator="true" />
126+
```
124127
## <a name="mode-templates"></a>Mode Templates
125128
Set Via:
126129
- Configuration File: `modeTemplates` element
127130

128131
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.
129132

130133
**Server Mode Template**
134+
131135
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.
132136

133137
```
@@ -139,13 +143,15 @@ The Server Mode Template provides the ability to apply a regex to the URL that w
139143
</regexes>
140144
</serverModeTemplate>
141145
</modeTemplates>
142-
</modification>```
146+
</modification>
147+
```
143148

144149
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.
145150

146151
`FlashpointSecurePlayer --name "Miniclip" --server "games/save-the-sheriff/en/"`
147152

148153
**Software Mode Template and hideWindow Attribute**
154+
149155
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.
150156

151157
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.
@@ -159,7 +165,8 @@ For example, a practical use of the Software Mode Template would be to create a
159165
</regexes>
160166
</softwareModeTemplate>
161167
</modeTemplates>
162-
</modification>```
168+
</modification>
169+
```
163170

164171
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.
165172

@@ -178,18 +185,21 @@ Here is a modification `element` that sets the FP_UNITY_PATH variable to the loc
178185
<environmentVariables>
179186
<environmentVariable name="FP_UNITY_PATH" value="%FLASHPOINTSECUREPLAYERSTARTUPPATH%\BrowserPlugins\UnityWebPlayer\Unity3d2.x\loader" />
180187
</environmentVariables>
181-
</modification>```
188+
</modification>
189+
```
182190

183191
**Compatibility Layers**
184192

193+
185194
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.
186195

187196
```
188197
<modification name="lowresolution">
189198
<environmentVariables>
190199
<environmentVariable name="__COMPAT_LAYERS" value="640x480" />
191200
</environmentVariables>
192-
</modification>```
201+
</modification>
202+
```
193203

194204
## Downloads Before
195205
Set Via:
@@ -210,7 +220,8 @@ The Downloads Before Modification may be used to download files from the Flashpo
210220
</regexes>
211221
</softwareModeTemplate>
212222
</modeTemplates>
213-
</modification>```
223+
</modification>
224+
```
214225

215226
Here is a `modification` element that demonstrates the use of the Downloads Before Modification.
216227

@@ -222,7 +233,8 @@ Here is a `modification` element that demonstrates the use of the Downloads Befo
222233
<downloadBefore name="http://www.example.com/example2.swf" />
223234
</downloadsBefore>
224235
</modeTemplates>
225-
</modification>```
236+
</modification>
237+
```
226238

227239
## <a name="registry-backups"></a>Registry Backups
228240
Set Via:
@@ -239,19 +251,23 @@ Here is a `modifications` element which temporarily changes the Unity directory.
239251
valueName="un.Directory" value="%FLASHPOINTSECUREPLAYERSTARTUPPATH%\BrowserPlugins\UnityWebPlayer\Unity3d2.x"
240252
valueKind="String" />
241253
</registryBackups>
242-
</modification>```
254+
</modification>
255+
```
243256

244257
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.
245258

246259
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.)
247260

248261
**binaryType Attribute and WOW64 Keys**
262+
249263
*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.
250264

251265
**ActiveX Imports**
266+
252267
See the section about [ActiveX Mode](#activex-mode) above.
253268

254269
**<a name="#crash-recovery"></a>Crash Recovery**
270+
255271
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.
256272

257273
There are four possible scenarios.
@@ -266,6 +282,7 @@ In scenarios one and two, Flashpoint Secure Player reverts the active Registry B
266282
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.
267283

268284
**Administrator Mode**
285+
269286
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.
270287

271288
## Single Instance
@@ -288,7 +305,8 @@ This command line in combination with this `modification` element uses the Singl
288305
</softwareModeTemplate>
289306
</modeTemplates>
290307
<singleInstance strict="false" commandLine="basilisk.exe" />
291-
</modification>```
308+
</modification>
309+
```
292310

293311
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`.
294312

@@ -297,13 +315,15 @@ Let's curate the game Zenerchi. The first step is to add the ActiveX Control to
297315
`ActiveX\ZenerchiWeb.1.0.0.10\zenerchi.1.0.0.10.dll`
298316

299317
**Creating a Registry Backup from an ActiveX Control**
318+
300319
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.
301320

302321
`FlashpointSecurePlayer --name "ActiveX\ZenerchiWeb.1.0.0.10\zenerchi.1.0.0.10.dll" --activex`
303322

304323
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.
305324

306325
**Using the Registry Backup**
326+
307327
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.
308328

309329
`FlashpointSecurePlayer --name "ActiveX\ZenerchiWeb.1.0.0.10\zenerchi.1.0.0.10.dll" --server "http://www.shockwave.com/content/zenerchi/sis/index.html"`
@@ -339,10 +359,13 @@ You may notice that because the Flashpoint Secure Player is effectively capable
339359

340360
# Questions And Answers
341361
**Is there is Linux version?**
362+
342363
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.
343364

344365
**Why does the Modification Name need to be specified in the configuration file if the filename of the configuration file also reflects it?**
366+
345367
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.
346368

347369
**Shouldn't the Flashpoint Launcher just have these features built in?**
370+
348371
No.

0 commit comments

Comments
 (0)