1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
# FlightCore
A [Northstar](https://northstar.tf/) installer, updater, and mod-manager
## Roadmap
- [ ] General
- [ ] Icon
- [ ] CI builds
- [ ] Self updating
- [x] ensure version sync with tauri.conf.json, cargo.toml
- [x] CI release
- [x] some scripts to create release JSON file
- [ ] Self detect if outdated
- [ ] Self update delivery
- [ ] CI/CD
- [ ] Flatpak (with CI to push flatpak update)
- [ ] Chocolatey (maybe?)
- [ ] Option to disable self-update (for Flatpak and Chocolatey)
- [ ] Display current version in UI window
- [x] Crash report uploading (sentry.io)
- [ ] Northstar install/launch support
- [ ] 1-click to get to running Northstar
- [ ] Detect game install path
- [x] Steam
- [x] Origin
- [ ] EA
-[ ] Handle read-only filesystem
- [x] Check if Northstar install is up-to-date
- [ ] 1-click updating Northstar
- [ ] Support for multiple release channels (GitHub + Thunderstore)
- [ ] Launch Northstar support via gamelauncher (Steam/Origin/EA)
- [ ] Read-out current version from exe and mods
- [ ] Mod install support
- [ ] check mod validity
- [ ] mod update detection
- [ ] Game repair functionality
- [ ] Button to disable all mods except core Northstar mods
- [ ] Check filesystem permissions (we wanna look for admin owned files etc)
- [ ] Northstar crash detection
- [ ] CloudFlare blocking debugger (in particular make sure to check IPv4)
- [ ] Extra
- [ ] "dev mode"
- [ ] Show list of Northstar (org) contributors and GitHub profile pics in some about menu, similarly to how it's done for releases
- [ ] PR install support
- [ ] Localisations (waiting on "official way" to do it in Tauri before jumping to any custom toolkits)
- [ ] Support multiple profiles
- [ ] get list of installed mods and export as TXT
- [ ] support r2mm links
- [ ] Open common config files
- [ ] Security
- [ ] Ensure when loading mod title, description etc from Thunderstore to escape HTML tags
## Development
Make sure you have the necessary dependencies installed: https://tauri.app/v1/guides/getting-started/prerequisites
Install `npm` dependencies with
```sh
npm install
```
Then for developing
```sh
# terminal 1 (UI localhost for hot-reload)
npm run ui-dev
# terminal 2 (for the Rust/App hot-reload)
npm run tauri dev
```
> **Note**
> On Windows instead of `npm run ui-dev`, you may need to run
> `./node_modules/.bin/rollup --config --watch`
> and
> `npm run localhost`
> in two separate console windows
### Tips
Note that you can adjust the behaviour of Tauri windows in `tauri.conf.json`, e.g.
```json
"windows": [
{
"fullscreen": false,
"resizable": true,
"alwaysOnTop": true,
"x": 1200,
"y": 0,
"height": 500,
"width": 300,
"title": "FlightCore"
}
]
```
### Building
Release builds are generally done via CI. To build locally, make sure typescript is compiled (`./node_modules/.bin/rollup --config`), then run `npm run tauri build`.
## Why yet another Northstar intaller/updater/mod-manager instead of contributing to an existing one?
The 3 main GUI tools for handling such tasks with Norhtstar are
- [r2modman](https://github.com/ebkr/r2modmanPlus)
- [Viper](https://github.com/0neGal/viper)
- [VTOL](https://github.com/BigSpice/VTOL)
while they get most of the work done, each of them has their own problem.
- **r2modman** has not too great UX and given that it also has to support other games there's not a(n easy) way to quickly add new features specific to Northstar
- **Viper** probably has the best UX but is missing features such as Origin process runtime detection (to avoid LSX errors) and lacks the ability to install Northstar from Thunderstore. Further there are still cases where JavaScript errors are not handled properly simply showing the stack trace and confusing users.
- **VTOL** has recently undergone a rewrite that removes a lot of older issues (such as requiring to be run as admin), however it is Windows exclusive and requires installing an additional library not shipped directly with the application, confusing some users. It also has a lot of edge case handling that while giving a smoother user experience blows up code base complexity.
With that said, FlightCore is not written from scratch. For handling Northstar specific logic, functions are re-used from the CLI-only Northstar installer called [papa](https://github.com/AnActualEmerald/papa) by making use of the underlying library [libthermite](https://crates.io/crates/libthermite).
The plan is to upstream any changes to `libthermite` so that it can be re-used by any other Rust-based Northstar installer.
## Additional info
Based on source code for the [Rust Tauri Introduction Video](https://www.youtube.com/watch?v=kRoGYgAuZQE&list=PL7r-PXl6ZPcCIOFaL7nVHXZvBmHNhrh_Q)
|
