diff options
| author | GeckoEidechse <40122905+GeckoEidechse@users.noreply.github.com> | 2023-04-20 17:58:25 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-04-20 17:58:25 +0200 |
| commit | 675d75d817d4279b7a8630700d1feb691e4a7e31 (patch) | |
| tree | 76b6ba92dae4c41e3085b9d3017a89bc6e8e7ef0 /docs | |
| parent | a74785bb9e6300b0baeb4f92aa647e3b498f7d0b (diff) | |
| download | FlightCore-675d75d817d4279b7a8630700d1feb691e4a7e31.tar.gz FlightCore-675d75d817d4279b7a8630700d1feb691e4a7e31.zip | |
docs: Add docs for DevView (#275)
* docs: Add docs for DevView
Contains information about:
- How to access it
- What it's for
- Explanation of certain features
* fix: Update broken image link
* fix: Mention correct number of clicks
on version number
* docs: Mention batch file to run mods PR profile
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/DEV-TOOLS.md | 28 | ||||
| -rw-r--r-- | docs/assets/dev-view-screenshot.png | bin | 0 -> 716658 bytes |
2 files changed, 28 insertions, 0 deletions
diff --git a/docs/DEV-TOOLS.md b/docs/DEV-TOOLS.md new file mode 100644 index 00000000..cf880d9d --- /dev/null +++ b/docs/DEV-TOOLS.md @@ -0,0 +1,28 @@ +# Dev tools + + + +FlightCore features a hidden view that contains development features. + +It's targetted at both Northstar and FlightCore contributors. Among other things it contains buttons for unreleased features in FlightCore and tools to help with Northstar development. + +To activate it, spam click the FlightCore version number in the settings view at least 6 times. After that a new entry named _DEV_ should appear in the menubar. + +## Northstar + +### Pull request install + +The dev view offers a way to install pull request from the [NorthstarLauncher](https://github.com/R2Northstar/NorthstarLauncher) and [NorthstarMods](https://github.com/R2Northstar/NorthstarMods) repositories. + +Launcher pull requests overwrite `NorthstarLauncher.exe` and `Northstar.dll`. + +Mod pull requests install into a separate profile called `R2Northstar-PR-test-managed-folder`. \ +When installing a mods PR, FlightCore will place `r2ns-launch-mod-pr-version.bat` into your Titanfall2 directory that can be used to run that PR profile directly. \ +The batch file simply runs `NorthstarLauncher.exe -profile=R2Northstar-PR-test-managed-folder` + + +## FlightCore + +The dev view contains various buttons that call functions that might not be fully implemented or tested yet. + +Additionally it has some buttons for testing like the _Panic button_ which force crashes the application to test automatic log uploading on crash among other things. diff --git a/docs/assets/dev-view-screenshot.png b/docs/assets/dev-view-screenshot.png Binary files differnew file mode 100644 index 00000000..5cf28043 --- /dev/null +++ b/docs/assets/dev-view-screenshot.png |
