From b66b3598fd030a6b88686a3351839cffe667cd62 Mon Sep 17 00:00:00 2001 From: CooldudePUGS <70904206+CooldudePUGS@users.noreply.github.com> Date: Mon, 27 Feb 2023 09:56:06 -0600 Subject: Add VTOL Guide (#133) Adds a dedicated guide for how to use VTOL Co-authored-by: Jordan --- docs/SUMMARY.md | 1 + docs/images/vtol-about.png | Bin 0 -> 52830 bytes docs/images/vtol-advocate.png | Bin 0 -> 90558 bytes docs/images/vtol-external-tools.png | Bin 0 -> 352607 bytes docs/images/vtol-launching-northstar.png | Bin 0 -> 102820 bytes docs/images/vtol-locate.png | Bin 0 -> 40895 bytes docs/images/vtol-mods-browser.png | Bin 0 -> 441509 bytes docs/images/vtol-mods-right-click.png | Bin 0 -> 6946 bytes docs/images/vtol-mods.png | Bin 0 -> 58916 bytes docs/images/vtol-northstar-installation-info.png | Bin 0 -> 77772 bytes docs/images/vtol-server-status.png | Bin 0 -> 62727 bytes docs/images/vtol-server.png | Bin 0 -> 25825 bytes docs/images/vtol-settings-expand.png | Bin 0 -> 30361 bytes docs/images/vtol-settings-tab.png | Bin 0 -> 27881 bytes docs/images/vtol-settings.png | Bin 0 -> 25187 bytes docs/images/vtol-skins.png | Bin 0 -> 171792 bytes docs/images/vtol-skintool.png | Bin 0 -> 29102 bytes docs/images/vtol-thunderstore-packer.png | Bin 0 -> 25260 bytes docs/images/vtol-tools.png | Bin 0 -> 6424 bytes docs/images/vtol-version-numbers.png | Bin 0 -> 226757 bytes .../northstar-installers/vtol-guide.md | 117 +++++++++++++++++++++ 21 files changed, 118 insertions(+) create mode 100644 docs/images/vtol-about.png create mode 100644 docs/images/vtol-advocate.png create mode 100644 docs/images/vtol-external-tools.png create mode 100644 docs/images/vtol-launching-northstar.png create mode 100644 docs/images/vtol-locate.png create mode 100644 docs/images/vtol-mods-browser.png create mode 100644 docs/images/vtol-mods-right-click.png create mode 100644 docs/images/vtol-mods.png create mode 100644 docs/images/vtol-northstar-installation-info.png create mode 100644 docs/images/vtol-server-status.png create mode 100644 docs/images/vtol-server.png create mode 100644 docs/images/vtol-settings-expand.png create mode 100644 docs/images/vtol-settings-tab.png create mode 100644 docs/images/vtol-settings.png create mode 100644 docs/images/vtol-skins.png create mode 100644 docs/images/vtol-skintool.png create mode 100644 docs/images/vtol-thunderstore-packer.png create mode 100644 docs/images/vtol-tools.png create mode 100644 docs/images/vtol-version-numbers.png create mode 100644 docs/installing-northstar/northstar-installers/vtol-guide.md (limited to 'docs') diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 46cce46..386c867 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) + * [VTOL Guide](installing-northstar/northstar-installers/vtol-guide.md) * [Manual installation](installing-northstar/manual-installation.md) * [SteamDeck and Linux](steamdeck-and-linux/README.md) * [Installing on SteamDeck and Linux](steamdeck-and-linux/installing-on-steamdeck-and-linux.md) diff --git a/docs/images/vtol-about.png b/docs/images/vtol-about.png new file mode 100644 index 0000000..9131501 Binary files /dev/null and b/docs/images/vtol-about.png differ diff --git a/docs/images/vtol-advocate.png b/docs/images/vtol-advocate.png new file mode 100644 index 0000000..eed77af Binary files /dev/null and b/docs/images/vtol-advocate.png differ diff --git a/docs/images/vtol-external-tools.png b/docs/images/vtol-external-tools.png new file mode 100644 index 0000000..b4ae8c7 Binary files /dev/null and b/docs/images/vtol-external-tools.png differ diff --git a/docs/images/vtol-launching-northstar.png b/docs/images/vtol-launching-northstar.png new file mode 100644 index 0000000..b2997d4 Binary files /dev/null and b/docs/images/vtol-launching-northstar.png differ diff --git a/docs/images/vtol-locate.png b/docs/images/vtol-locate.png new file mode 100644 index 0000000..8a800cd Binary files /dev/null and b/docs/images/vtol-locate.png differ diff --git a/docs/images/vtol-mods-browser.png b/docs/images/vtol-mods-browser.png new file mode 100644 index 0000000..16ec93f Binary files /dev/null and b/docs/images/vtol-mods-browser.png differ diff --git a/docs/images/vtol-mods-right-click.png b/docs/images/vtol-mods-right-click.png new file mode 100644 index 0000000..c6fab90 Binary files /dev/null and b/docs/images/vtol-mods-right-click.png differ diff --git a/docs/images/vtol-mods.png b/docs/images/vtol-mods.png new file mode 100644 index 0000000..a54b684 Binary files /dev/null and b/docs/images/vtol-mods.png differ diff --git a/docs/images/vtol-northstar-installation-info.png b/docs/images/vtol-northstar-installation-info.png new file mode 100644 index 0000000..b043a44 Binary files /dev/null and b/docs/images/vtol-northstar-installation-info.png differ diff --git a/docs/images/vtol-server-status.png b/docs/images/vtol-server-status.png new file mode 100644 index 0000000..9788f02 Binary files /dev/null and b/docs/images/vtol-server-status.png differ diff --git a/docs/images/vtol-server.png b/docs/images/vtol-server.png new file mode 100644 index 0000000..d7bacbf Binary files /dev/null and b/docs/images/vtol-server.png differ diff --git a/docs/images/vtol-settings-expand.png b/docs/images/vtol-settings-expand.png new file mode 100644 index 0000000..599d721 Binary files /dev/null and b/docs/images/vtol-settings-expand.png differ diff --git a/docs/images/vtol-settings-tab.png b/docs/images/vtol-settings-tab.png new file mode 100644 index 0000000..3ed7bac Binary files /dev/null and b/docs/images/vtol-settings-tab.png differ diff --git a/docs/images/vtol-settings.png b/docs/images/vtol-settings.png new file mode 100644 index 0000000..1130ba1 Binary files /dev/null and b/docs/images/vtol-settings.png differ diff --git a/docs/images/vtol-skins.png b/docs/images/vtol-skins.png new file mode 100644 index 0000000..6d28fda Binary files /dev/null and b/docs/images/vtol-skins.png differ diff --git a/docs/images/vtol-skintool.png b/docs/images/vtol-skintool.png new file mode 100644 index 0000000..71d4278 Binary files /dev/null and b/docs/images/vtol-skintool.png differ diff --git a/docs/images/vtol-thunderstore-packer.png b/docs/images/vtol-thunderstore-packer.png new file mode 100644 index 0000000..c71cba5 Binary files /dev/null and b/docs/images/vtol-thunderstore-packer.png differ diff --git a/docs/images/vtol-tools.png b/docs/images/vtol-tools.png new file mode 100644 index 0000000..9c6c2aa Binary files /dev/null and b/docs/images/vtol-tools.png differ diff --git a/docs/images/vtol-version-numbers.png b/docs/images/vtol-version-numbers.png new file mode 100644 index 0000000..821b18b Binary files /dev/null and b/docs/images/vtol-version-numbers.png differ diff --git a/docs/installing-northstar/northstar-installers/vtol-guide.md b/docs/installing-northstar/northstar-installers/vtol-guide.md new file mode 100644 index 0000000..3b6794e --- /dev/null +++ b/docs/installing-northstar/northstar-installers/vtol-guide.md @@ -0,0 +1,117 @@ +# VTOL Guide + +VTOL is a mod manager for installing and managing mods for the Northstar client made for Titanfall 2. You can find links to install it on the [Northstar website](https://northstar.tf), or on [VTOL's GitHub page](https://github.com/R2NorthstarTools/VTOL). + +## Main Menu + +![vtol-main-window](../../images/vtol-main-window.png) +**The *Main Menu* of VTOL is where you'll probably spend most of your time.** + +This menu has a lot of useful information, such as the *version of VTOL* you have, the *version of Northstar* you have, if the Master Server is online, *whether EA App/Origin are currently open*, and a *place to set your game path*. + +## Version Numbers + +You can see what *version of VTOL/Northstar* you have in the top left corner of the VTOL window. +![version-numbers](../../images/vtol-version-numbers.png) + +## Master Server/EA or Origin online + +These small tabs near the middle of the VTOL window show you whether the Master Server for Northstar is currently online, and if EA or Origin is running properly on your computer. If the EA/Origin tab is red, solving that will be covered later (See: Settings section later on).\ +If you are unsure if you have EA or Origin, you have EA. +![server-status](../../images/vtol-server-status.png) + +## Northstar Installation/Locate Titanfall 2 Install + +The final parts of the Main Menu are at the bottom, showing your game's directory with a button to Locate Titanfall 2 install, a small button next to this, and a button reading "Update +Northstar" +![vtol-northstar-installation-info](../../images/vtol-northstar-installation-info.png) + +## Installation Via VTOL + +VTOL handles most things automatically, but it may still require minimal setup for some users.\ +![vtol-locate](../../images/vtol-locate.png) +Something you might have to do manually is locate your Titanfall 2 install. You can do this by pressing the button of the same name on VTOL, and navigating to your Titanfall 2 directory (If you're unsure of what your game path is, check out the [Default Directories](../troubleshooting.md#game-location) section) + +After doing this, Northstar should automatically install. If not, the button at the bottom will read "Install Northstar". Let VTOL install Northstar, and you should be good to go. Once installed, this button will turn into the "Update +Northstar" shown in the screenshot earlier, which you can use to update without having to reinstall. + +## Launching Northstar via VTOL + +![vtol-launch-northstar](../../images/vtol-launching-northstar.png)\ +Assuming you've followed everything up to this point, you should be set to hit "Launch Titanfall 2 Northstar" and play on Northstar's servers. If you encounter an error like a crash, Northstar will create a log file in the "titanfall2/r2northstar/logs" directory. You can look at this log yourself, or send it on the [Northstar Discord server](https://discord.com/invite/northstar) and someone can try to look at it and help you. + +## Additional Mods/Settings + +## Tab List + +![vtol-settings](../../images/vtol-settings.png)\ +The furthermost left side of VTOL has a list of tabs you can use for several different functions.\ +To expand the smaller version of the tab list, press the button with 3 bars as shown below\ +![vtol-settings-expand](../../images/vtol-settings-expand.png)\ +**NOTE: This guide will not be including the "Home" button as a tab when describing this list. When it says the first tab, it means the first tab underneath the home button** +## Installed Mods List + +![vtol-mods](../../images/vtol-mods.png) + +The first tab of VTOL is the "Mods" tab. This is a list of your currently installed mods, with the ability to disable any of them quickly. + +You can also right click on a specific mod to get the option to either delete it, or look at the mod's information (Mod Name, Author Name, Description, etc.)\ +![vtol-mods-right-click](../../images/vtol-mods-right-click.png) + + +## Installing Mods Via VTOL + +![vtol-mods-browser](../../images/vtol-mods-browser.png) + +VTOL has a built in-browser for searching [Northstar's Thunderstore page](https://northstar.thunderstore.io/) (the website where most Northstar mods get uploaded to), located at the second tab "Browse" on the tab list. You will see the newest uploaded mods here by default, which you can change by applying filters (Note: The sorting is by default Low-High for filters. You can change this by pressing the button with an arrow next to the filters button, making it High-Low) + +VTOL also has support where all you need to do is drag and drop a mod downloaded from the Thunderstore page onto the Mods tab (the second tab on the left side) to automatically install the mod. + +## Settings + +![vtol-settings-tab](../../images/vtol-settings-tab.png) + +On the way bottom of the tab list, there is a button to open settings for the VTOL manager. You will want to keep most of these on default, but change them as you wish. It is normal for the "Restart_As_Admin" button to appear untoggled. This is also where you can tick "Enable_EA_APP_Usage" to make the client work better with the EA app, assuming you have it and not Origin + +## Skins + +![vtol-skins](../../images/vtol-skins.png) + +The third settings tab on VTOL is the "Skins" tab. VTOL has support for skins formatted for an older version of Northstar, normally requiring an extra tool. All you need to do is drag the folder of one of these old style skins onto the Skins screen to install it automatically. + +## Server + +![vtol-server](../../images/vtol-server.png) + +The fourth tab on VTOL is the "Server" tab. This section allows you to add Launch Arguments to your client or dedicated server. Note that this adds Launch Arguments to change what Northstar does when it launches, not to launch Northstar itself. A way you can do this is by adding [Launch Arguments](../troubleshooting.md#launch-opts) via the store you own the game on and launching through there. + +For the dedicated server option, you can scroll through this tab to set many different options for a server which can be found on the Northstar Wiki's [Server Hosting Guide](../../hosting-a-server-with-northstar/basic-listen-server.md) + +## Tools + +![vtol-tools](../../images/vtol-tools.png) +The fifth tab called "Tools" is meant to help those trying to create mods for Northsar. + +## ThunderStore Packer + +![vtol-thunderstore-packer](../../images/vtol-thunderstore-packer.png) +The first screen is an area where you can locate your mod folder, and easily set up things such as the Name, Description, and Icon to be shown on the Thunderstore page when you go to upload your mod. + +## Skin Tool + +![vtol-skintool](../../images/vtol-skintool.png) +The second screen is an area where you can drag and drop images to the different maps of a skin to make your own skin. This is an implementaion of the [skin tool](https://github.com/zxcPandora/Titanfall2-SkinTool). + +## Advocate + +![vtol-advocate](../../images/vtol-advocate.png) +The third screen is an implementation of Spoon's [Advocate Tool](https://github.com/ASpoonPlaysGames/Advocate), where you can convert an old style skin mod to a mod that can be installed by everyone like a normal mod. Please give credit to the original skin owner while doing this. (If confused, following the earlier link to Github describes how to set up Advocate) + +## External Tools + +![vtol-external-tools](../../images/vtol-external-tools.png) +The fourth screen lists a lot of commonly used tools by modders to help create mods easier. You can get more info about each tool by clicking the information icon in the top right of the image for each respective tool. + +## About + +![vtol-about](../../images/vtol-about.png) + +The last section of the VTOL client is the 6th tab of VTOL, the "About" section. This screen shows you what VTOL can do, as well as a button to configure updates, and a button to check for updates for the VTOL client. -- cgit v1.2.3