From f3140885fea216c2f9d1ebbea64acaf0aedac665 Mon Sep 17 00:00:00 2001 From: CooldudePUGS <70904206+CooldudePUGS@users.noreply.github.com> Date: Mon, 27 Feb 2023 13:34:28 -0600 Subject: Add FlightCore guide (#136) Adds basic guide on how to install and use FlightCore --- docs/SUMMARY.md | 1 + docs/images/flightcore-changelog.png | Bin 0 -> 1591930 bytes docs/images/flightcore-executable-as-program.png | Bin 0 -> 39685 bytes docs/images/flightcore-main-window-information.png | Bin 0 -> 47963 bytes docs/images/flightcore-settings.png | Bin 0 -> 615376 bytes docs/images/flightcore-windows-download.png | Bin 0 -> 37967 bytes .../northstar-installers/flightcore-guide.md | 53 +++++++++++++++++++++ 7 files changed, 54 insertions(+) create mode 100644 docs/images/flightcore-changelog.png create mode 100644 docs/images/flightcore-executable-as-program.png create mode 100644 docs/images/flightcore-main-window-information.png create mode 100644 docs/images/flightcore-settings.png create mode 100644 docs/images/flightcore-windows-download.png create mode 100644 docs/installing-northstar/northstar-installers/flightcore-guide.md diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 386c867..b647dec 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -7,6 +7,7 @@ * [Basic Setup](installing-northstar/basic-setup.md) * [Northstar Installers](installing-northstar/northstar-installers/README.md) + * [FlightCore Guide](installing-northstar/northstar-installers/flightcore-guide.md) * [VTOL Guide](installing-northstar/northstar-installers/vtol-guide.md) * [Manual installation](installing-northstar/manual-installation.md) * [SteamDeck and Linux](steamdeck-and-linux/README.md) diff --git a/docs/images/flightcore-changelog.png b/docs/images/flightcore-changelog.png new file mode 100644 index 0000000..665adfc Binary files /dev/null and b/docs/images/flightcore-changelog.png differ diff --git a/docs/images/flightcore-executable-as-program.png b/docs/images/flightcore-executable-as-program.png new file mode 100644 index 0000000..d5532af Binary files /dev/null and b/docs/images/flightcore-executable-as-program.png differ diff --git a/docs/images/flightcore-main-window-information.png b/docs/images/flightcore-main-window-information.png new file mode 100644 index 0000000..132f614 Binary files /dev/null and b/docs/images/flightcore-main-window-information.png differ diff --git a/docs/images/flightcore-settings.png b/docs/images/flightcore-settings.png new file mode 100644 index 0000000..464afc4 Binary files /dev/null and b/docs/images/flightcore-settings.png differ diff --git a/docs/images/flightcore-windows-download.png b/docs/images/flightcore-windows-download.png new file mode 100644 index 0000000..b1d52ad Binary files /dev/null and b/docs/images/flightcore-windows-download.png differ diff --git a/docs/installing-northstar/northstar-installers/flightcore-guide.md b/docs/installing-northstar/northstar-installers/flightcore-guide.md new file mode 100644 index 0000000..65d979d --- /dev/null +++ b/docs/installing-northstar/northstar-installers/flightcore-guide.md @@ -0,0 +1,53 @@ +# FlightCore Guide + +FlightCore is a Northstar installer and mod manager which allows for installing, updating, and managing mods for the Northstar client made for Titanfall 2. + +Something to note is that FlightCore works on both Windows and Linux. The setup process is similar for both, except for the installation folder, and how you install FlightCore. + +## Windows Installation + +![The Windows download button on FlightCore's GitHub page](../../images/flightcore-windows-download.png) + +Install the FlightCore file directly from the [Northstar website](https://northstar.tf), from [FlightCore's GitHub releases page](https://github.com/R2NorthstarTools/FlightCore/releases) (You want to download `FlightCore_X.Y.Z_x64_en-US.msi`, X Y Z being the version numbers of FlightCore), or by clicking the Windows download button on [FlightCore's GitHub page](https://github.com/R2NorthstarTools/FlightCore) + +Then, run the `.msi` file this downloads, and it will automatically install FlightCore for you. + +## Linux Installation + +For Linux, you want to download `flight-core_X.Y.Z_amd64.AppImage` (X Y Z being the version numbers of FlightCore) from [FlightCore's GitHub releases page](https://github.com/R2NorthstarTools/FlightCore/releases), put it in a place you prefer, then make sure to right click on it, click on properties, and tick `Executable as Program` (as shown below), then you can just double click it to open FlightCore. + +![Make sure to tick this setting to be ON](../../images/flightcore-executable-as-program.png) + +## Main Menu + +![FlightCore Main Window](../../images/flightcore-main-window.png) + +This is the *Main Menu* of FlightCore. It includes the *Play*, *Changelog*, *Mods*, and *Settings* tabs, all of which will be covered in the guide. + +## Play + +![Play tab's information](../../images/flightcore-main-window-information.png) + +The *Play* tab is actually the main window that FlightCore opens to. It includes some useful information in the bottom left, such as the version of Northstar you have installed, how many players are online, how many servers are online, and a button to launch Northstar. + +## Changelog + +![FlightCore's Changelog tab](../../images/flightcore-changelog.png) + +The *Changelog* tab displays information from Northstar's [GitHub page for releases](https://github.com/R2Northstar/Northstar/releases), detailing what a new update to Northstar brings. + +## Mods + +![FlightCore's Mods browser](../../images/flightcore-mod-browser-window.png) + +The *Mods* tab of Flightcore can display either mods installed locally, or a browser for installing mods from [Northstar's Thunderstore page](https://northstar.thunderstore.io/). The default option it opens to when clicking the tab is displaying the mods you have installed. + +`Local` displays mods you have installed currently, with options to toggle them on or off or delete them. + +`Online` displays the Mod browser, which sorts by newest uploads by default. Hitting install on a mod will automatically install it, and hitting the *i* next to it will open the mod's information page on ThunderStore in your browser. + +## Settings + +![FlightCore's Settings tab](../../images/flightcore-settings.png) + +The *Settings* tab is the fourth and final tab of FlightCore. This tab allows you to view and choose your Titanfall2 directory (default directories can be found in the [Default Directories](../troubleshooting.md#game-location) section), select how many mods you want to see on in one page on the online browser in FlightCore, the version of FlightCore you're running, as well as a toggle to enable testing release channels. -- cgit v1.2.3