Skip to content

Commit

Permalink
Added: Misc & Experimental Features to Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Sewer56 committed Feb 23, 2022
1 parent 5f64b80 commit 09c8594
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 1 deletion.
46 changes: 46 additions & 0 deletions docs/ExperimentalFeatures.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Experimental & Miscellaneous Features

This page lists Reloaded features which don't necessarily fit into other pages of the wiki.

## Experimental Features

Experimental features are features which are either partially implemented, or which have not yet been thoroughly tested.
Use at your own risk.

### Portable Mode

Reloaded II can be put into portable mode by creating a file called `portable.txt` in the same directory as the launcher.

When portable mode is used, Reloaded will always use the `Apps`, `Mods`, `User` and `Plugins` folders from the launcher's directory.

Other global settings still apply, however.

### Relative Pathed Applications

It's possible to set a relative `AppLocation` for programs, as opposed to a fixed path.
This will allow you to move the launcher to a subfolder of a game should you plan to only use Reloaded with one game, or ship the launcher preconfigured for a given game.

Example Configuration (`Apps/sonicriders.exe/AppConfig.json`):

```json
// `Reloaded II/Apps/sonicriders.exe` -> `Sonic Riders/SonicRiders.exe`
{
"AppId": "sonicriders.exe",
"AppName": "Sonic Riders",
"AppLocation": "..\\..\\..\\Sonic Riders\\SonicRiders.exe",
"AppArguments": "",
"AppIcon": "Icon.png",
"AutoInject": false
}
```

All paths are relative to the folder in which the `AppConfig.json` file is located.

## Miscellaneous Features

### RGB Window Border

You can set your window border to hue cycle through the colors of the rainbow.
This is a hidden feature that can be used in themes, and is set in `Theme/Default/Settings.xaml`.

Property name is `EnableGlowHueCycle`.
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ nav:
- Advanced:
- NuGet Sources: NuGetSources.md
- Injection Methods: InjectionMethods.md
- Misc & Experimental Features: ExperimentalFeatures.md
- For Modders:
- Getting Started: GettingStartedMods.md
- Publishing Mods: PublishingMods.md
Expand All @@ -44,7 +45,6 @@ nav:
- Writing Mods for Actively Developed Games/Apps: https://github.com/Sewer56/Reloaded.SharedLib.Hooks#supporting-actively-developed-applications
- Writing Native Mods: NativeMods.md
- Troubleshooting: Troubleshooting.md

- For Contributors:
- Building Reloaded: BuildingReloaded.md
- Project Structure: ProjectStructure.md
Expand Down

0 comments on commit 09c8594

Please sign in to comment.