From ee1dcc2b7cd3ba615ee0ae0be76b6ca32f495863 Mon Sep 17 00:00:00 2001 From: 0neGal Date: Fri, 11 Feb 2022 17:05:55 +0100 Subject: added FAQ page --- FAQ.md | 31 +++++++++++++++++++++++++++++++ README.md | 6 +++++- 2 files changed, 36 insertions(+), 1 deletion(-) create mode 100644 FAQ.md diff --git a/FAQ.md b/FAQ.md new file mode 100644 index 0000000..3d78f90 --- /dev/null +++ b/FAQ.md @@ -0,0 +1,31 @@ +## Frequently Asked Questions (FAQ) + +### How do I install Viper? + +As briefly covered in the README, you've multiple choices for installing Viper. + +#### Windows + +There's the installer, and the portable exe, we recommend using the installer as it can auto update, there's a Download button on the README which downloads the newest version of the installer. + +#### Linux + +On the [releases page](https://github.com/0neGal/viper/releases/latest) there are various package distributions we release, feel free to pick any one of them, but as with Windows only one of them supports auto-installation, that one being the AppImage. + +#### After Install + +After you've gotten Viper installed you'll select your game path (this may or may not be done automatically, however if we can't find your game automatically we'll ask you to select it manually), then go onto the Northstar tab, click "Install", and now you can launch Northstar and have fun on the frontier. + +If you keep getting errors about your game path being wrong follow the [instructions further below...](#this-folder-is-not-a-valid-game-path) + +### How do I install mods? + +We recommend using Thunderstore, which allows you to easily find mods and install them, to do so simply go into the Northstar tab, then go into the Mods section, and there'll be a button aptly named **"Find Mods"**, clicking it will open an easy to use UI that'll let you search for mods and install them. + +### "This folder is not a valid game path." + +When selecting a game path make sure it actually is *the game path*. Your game path is where the `Titanfall2.exe` is located, usually inside `C:\Program Files (x86)\Origin Games\Titanfall2`, however if you've installed the game somewhere else or you've installed the game through Steam it may be located somewhere else. + +For Steam users, you can inside Steam right click on the game, click **Properties**, then in the window that opens **Local Files**, then **Browse**, the folder that it opens is the game path. + +Ideally Viper should be able to find Titanfall automatically, however given we can't predict every installation of the game we can't always find the game. diff --git a/README.md b/README.md index e5422fc..5650c12 100644 --- a/README.md +++ b/README.md @@ -43,13 +43,17 @@ Your configuration file will be found in `%APPDATA%\viper.json` on Windows, and ## Contact/Support -To get supoport either open a GitHub issue.
+To get support either open a GitHub issue.
Or if you must you can contact a developer through the methods below: Ways to contact the main developer: [0neGal](https://github.com/0neGal) * Twitter: [@0neGal](https://twitter.com/0neGal) * Reddit: [/u/0neGal](https://reddit.com/u/0neGal) +### Frequently Asked Questions (FAQ) + +Many of the questions and problems you may have might be able to be answered by reading the [FAQ page](FAQ.md). So before opening an issue or asking for support please read through it first! + ## Sidenote Given that we already have so many Northstar updaters and launchers I urge people to instead of creating new launchers unless there's a very specific reason, just make a pull request on one of the existing, otherwise we'll continue to have new ones. -- cgit v1.2.3