README.md


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

<p align="center">
	<img src="docs/assets/Square310x310Logo.png" width="200px">
	<br>
	<br>
	<a href="https://r2northstartools.github.io/FlightCore/index.html?win-setup"><img src="docs/assets/downloadbutton.png" width="300px"></a>
	<br>
</p>

# FlightCore

A [Northstar](https://northstar.tf/) installer, updater, and mod-manager

![FlightCore screenshot](docs/assets/main-window-screenshot.png)

## Install

Downloads are available on the [releases page](https://github.com/R2NorthstarTools/FlightCore/releases).

**Windows:** Download `FlightCore_X.Y.Z_x64_en-US.msi` and then run the installer by double-clicking the file.

**Linux:** Download `flight-core_X.Y.Z_amd64.AppImage`, put it in a preferred location and make it executable. A Flatpak version is planned for the future.

All versions of FlightCore feature an auto-updater that will ask to self-update on new releases.

<a href="https://github.com/R2NorthstarTools/FlightCore/releases"><img src="https://img.shields.io/github/v/release/R2NorthstarTools/FlightCore" alt="GitHub release (latest by date)"></a>
<img src="https://img.shields.io/github/downloads/R2NorthstarTools/FlightCore/latest/total" alt="GitHub release downloads (latest by date)">
<a href="https://translate.harmony.tf/engage/northstar/">
<img src="https://translate.harmony.tf/widgets/northstar/-/flightcore/svg-badge.svg" alt="Translation status" />
</a>

## Frequently Asked Questions (FAQ)

Answers to frequently asked questions can be found in [docs/FAQ.md](docs/FAQ.md)

## Development

If you'd like to contribute to FlightCore, see [docs/DEVELOPMENT.md](docs/DEVELOPMENT.md)

If you are a Northstar developer/contributor, you might want to look at [docs/DEV-TOOLS.md](docs/DEV-TOOLS.md)

### Translating

Translations can be submitted via [weblate](https://translate.harmony.tf/projects/northstar/flightcore/). \
If you want to add translations for a new language that does not exist in FlightCore yet, please [reach out via GitHub issues](https://github.com/R2NorthstarTools/FlightCore/issues/new) so that we can add support for it.

<a href="https://translate.harmony.tf/engage/northstar/">
<img src="https://translate.harmony.tf/widgets/northstar/-/flightcore/multi-auto.svg" alt="Translation status" />
</a>

## Roadmap

--> See https://github.com/R2NorthstarTools/FlightCore/issues/1