Pages for this project
- General
- Administrators
- Developers
On this page
The SplameiPlay Policy allows system admins to restrict and control how SplameiPlay can be used. Its mainly for organisations, businesses and education sectors to use SplameiPlay without allowing for unrestrictive access. You shouldn’t use this feature as a general user.
Make sure to protect to protect all the Policy files you’re using to prevent unauthorised changes which can break SplameiPlay and allow Policy bypasses
This page is for the file syntax 1.1 which means it will not be compatible with versions prior to 5.0 Particle
Manually creating
To begin, you need to create the header, this tells SplameiPlay that your file is, in fact, a policy file. All you need to do is put the following lines at the start of a text file
Version=1.1
Type=Policy
TypeVersion=1.1
Hop file
Policy hop files serve the purpose of re-directing where SplameiPlay should look so you can store a central Policy file for multiple devices to use, making it easier to update. SplameiPlay supports hopping to Policy files via HTTPS or file paths. You can link up to 49 Policy hop files before SplameiPlay requires a valid Policy term file otherwise it will trigger error 0_POLICY_HOP_LOOP (0x00D)
The only declaration you need to make it HopTo= followed by the URL or path to the Policy file to ‘hop to’. Make sure the device has access to the provided location otherwise it will trigger error 0_POLICY_FILE_EXCEPTION (0x00C)
An example could look like this:
Version=1.1
Type=Policy
TypeVersion=1.1
HopTo=https://example.com
Term file
These Policy files store the actual terms that SplameiPlay needs to follow. There’s multiple terms, each restricting and controlling how SplameiPlay should work. Not all terms will work on all SplameiPlay editions. The terms you can use are listed below. You should put these in the global section (an empty line below the header).
| Term name | Type | Description | Affected editions | Example / Recommended |
|---|---|---|---|---|
| RestrictStore | Boolean | Enables or disables the store page from being viewed | Main-line | true |
| RestrictCustomProjects | Boolean | Enables or disables users adding custom projects. This does not affect custom projects installed via the Policy file | Main-line, Lite | true |
| DisableRecap | Boolean | Enables or disables SplameiPlay Recap. Disabling Recap usually serves no benefit for organisations | Main-line | false |
| DisableDiscordRP | Boolean | Enables or disables using Discord Rich Presence. In most cases, this should be disabled | Main-line | true |
| InstallLocation | String | Sets the install location that SplameiPlay should use. This should always be the user’s AppData directory or the C: drive | Main-line, Lite | C:/Splamei |
If an unknown declaration is found in the policy file, SplameiPlay will trigger and error and be unable to run
The policy also has 3 other sections allowing for extra control. This is the InstallProjects, ApplyPolicyFor and IgnorePolicyFor sections.
The only declarations that should be made in the InstallProjects section should be empty value keys listing the path to the installer file to use. This must be a file location as HTTPS locations are currently not supported.
The ApplyPolicyFor section should list the username(s) where the policy should be applied. In most cases, you should use IgnorePolicyFor to apply the Policy to everyone except listed users. Wildcards (*) are supported.
The IgnorePolicyFor section does the opposite of the ApplyPolicyFor section as it lists the usernames of the users who should not have the Policy applied to them. This is best to use to prevent the Policy being applied to system administrator accounts while applying for every other user. Wildcards (*) are supported.
If both
IgnorePolicyForandApplyPolicyForis present andIgnorePolicyForhas at least one item, SplameiPlay will ignoreApplyPolicyFor
Below is a complete example of a Policy term file:
Version=1.1
Type=Policy
TypeVersion=1.1
RestrictStore=true
RestrictCustomProjects=true
DisableRecap=false
DisableDiscordRP=true
ForceOnlineMode=true
InstallLocation=C:/Splamei
/InstallProjects
C:/example/installer.spinstaller
/ApplyPolicyFor
StandardUser*
/IgnorePolicyFor
Admin*User