From ff59054b7a05e048f427ab67efe7e38a1418a5ea Mon Sep 17 00:00:00 2001 From: Cyn <70904206+itscynxx@users.noreply.github.com> Date: Thu, 19 Oct 2023 08:19:41 -0500 Subject: Update VTOL Guide (#198) --- docs/images/vtol-download-github-portable.png | Bin 0 -> 32021 bytes docs/images/vtol-download-github.png | Bin 0 -> 326599 bytes docs/images/vtol-locate.png | Bin 40895 -> 63040 bytes docs/images/vtol-main-window.png | Bin 500764 -> 541984 bytes docs/images/vtol-northstar-installation-info.png | Bin 77772 -> 58852 bytes .../northstar-installers/vtol-guide.md | 60 +++++++++++++++------ 6 files changed, 43 insertions(+), 17 deletions(-) create mode 100644 docs/images/vtol-download-github-portable.png create mode 100644 docs/images/vtol-download-github.png diff --git a/docs/images/vtol-download-github-portable.png b/docs/images/vtol-download-github-portable.png new file mode 100644 index 0000000..2863fe7 Binary files /dev/null and b/docs/images/vtol-download-github-portable.png differ diff --git a/docs/images/vtol-download-github.png b/docs/images/vtol-download-github.png new file mode 100644 index 0000000..6207c96 Binary files /dev/null and b/docs/images/vtol-download-github.png differ diff --git a/docs/images/vtol-locate.png b/docs/images/vtol-locate.png index 8a800cd..6a1fadb 100644 Binary files a/docs/images/vtol-locate.png and b/docs/images/vtol-locate.png differ diff --git a/docs/images/vtol-main-window.png b/docs/images/vtol-main-window.png index 7b03928..76c4769 100644 Binary files a/docs/images/vtol-main-window.png and b/docs/images/vtol-main-window.png differ diff --git a/docs/images/vtol-northstar-installation-info.png b/docs/images/vtol-northstar-installation-info.png index b043a44..acd2a5b 100644 Binary files a/docs/images/vtol-northstar-installation-info.png and b/docs/images/vtol-northstar-installation-info.png differ diff --git a/docs/installing-northstar/northstar-installers/vtol-guide.md b/docs/installing-northstar/northstar-installers/vtol-guide.md index 06c269b..c7785f2 100644 --- a/docs/installing-northstar/northstar-installers/vtol-guide.md +++ b/docs/installing-northstar/northstar-installers/vtol-guide.md @@ -1,6 +1,15 @@ # 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). +VTOL is a mod manager for installing and managing mods for the Northstar client made for Titanfall 2. + +VTOL works on Windows only and you can find links to download it on [Northstar's website](https://northstar.tf) or [VTOL's GitHub repo](https://github.com/R2NorthstarTools/VTOL). +Installing it from the website automatically installs the latest version that will automatically update itself. +On the GitHub repo, you can download the newest version by clicking one of two options. +Note that the portable is just a `.exe` file and not the installer, as such it won't automatically update itself. + +![VTOL installer download (on GitHub, automatically updates](../../images/vtol-download-github.png) + +![VTOL portable download (on GitHub, doesn't automatically update](../../images/vtol-download-github-portable.png) ## Main Menu @@ -8,24 +17,24 @@ VTOL is a mod manager for installing and managing mods for the Northstar client **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"_. +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. +In the top left corner of the VTOL window you can see what versions of VTOL and Northstar you have installed. ![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).\ +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, make sure to open EA/Origin first.\ If you are unsure if you have EA or Origin, you have EA. ![Server/EA/Origin 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"_ +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 below both of these reading _"Re-Install Northstar"_. ![Installation Section](../../images/vtol-northstar-installation-info.png) @@ -37,25 +46,28 @@ VTOL handles most things automatically, but it may still require minimal setup f 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. +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 _"Re-Install Northstar"_ button shown in the screenshot earlier, which you can use to forcibly reinstall Northstar in the case something goes wrong with your Northstar install. ## Launching Northstar via VTOL ![Launching 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. +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 Tab List](../../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 ![3 Bars](../../images/vtol-settings-expand.png) +![VTOL Tab List](../../images/vtol-settings.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 @@ -72,7 +84,9 @@ You can also right click on a specific mod to get the option to either delete it ![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 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. @@ -80,19 +94,26 @@ VTOL also has support where all you need to do is drag and drop a mod downloaded ![VTOL Settings](../../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. +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 ![Skins installation tab](../../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. +The third settings tab on VTOL is the _"Skins"_ tab. VTOL has support for DDS format skins (the skins with the numbered folders in them), which are commonly used for Vanilla Titanfall 2, with Northstar generally opting to convert them to mods. + +This format is older and less consistent than converting them to a mod to be used with Northstar (see [Advocate](./#advocate)). +It can still be used on Vanilla by making use of a [vanilla profile](../../using-northstar/advanced.md#vanilla-profile). + +However, if you want you can still install skins like this for use with Northstar. +All you need to do is drag the folder of a DDS format skin onto the Skins screen of VTOL to install it automatically. ## Server ![Launch arguments/dedicated server tab](../../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. +The fourth tab on VTOL is the _"Server"_ tab. This section allows you to add Launch Arguments to your client or dedicated server. 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) @@ -112,13 +133,16 @@ The first screen is an area where you can locate a folder for a mod you've creat ![VTOL's Skin Tool implementation](../../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). +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's Advocate implementation](../../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) +The third screen is an implementation of Spoon's [Advocate Tool](https://github.com/ASpoonPlaysGames/Advocate), where you can convert a DDS formatted skin to a mod that can be installed by everyone normally without the need for the [Skin Tool](https://github.com/zxcPandora/Titanfall2-SkinTool). +If you're going to be sharing a converted skin that isn't yours, please give credit to the original creator. +(If confused on how to use this, follow the earlier link to Github that describes how to set up Advocate. +Do note, this version of Advocate isn't perfectly up to date) ### External Tools @@ -130,11 +154,13 @@ The fourth screen lists a lot of commonly used tools by modders to help create m ![VTOL's Profiles menu](../../images/vtol-profiles.png) -The sixth tab is the _"Profiles"_ tab, allowing you to create profiles for Northstar. Profiles are seperate Northstar installs, each with their own set of mods and seperated by folders. For example, you can have one profile with your normal set of mods, and another profile for only using core mods (those that common with Northstar/the ones that start with `Northstar.`). +The sixth tab is the _"Profiles"_ tab, allowing you to create profiles for Northstar. Profiles are seperate Northstar installs, each with their own set of mods and seperated by folders. +For example, you can have one profile with your normal set of mods and another profile for only using core mods (those that common with Northstar/the ones that start with `Northstar.`). ![The Export Profile menu in VTOL](../../images/vtol-export-profile.png) -Hitting `Export Profile` will save your current profile to a `.vbp` file, which you can easily switch to by clicking `IMPORT` on the desired profile inside of VTOL. You can also share your profile or download someone else's profile if they send you this file by hitting `Add Profile` and selecting the downloaded file. These files get saved to `Titanfall2/VTOL_profiles`. +Hitting `Export Profile` will save your current profile to a `.vbp` file, which you can easily switch to by clicking `IMPORT` on the desired profile inside of VTOL. +You can also share your profile or download someone else's profile if they send you this file by hitting `Add Profile` and selecting the downloaded file. These files get saved to `Titanfall2/VTOL_profiles`. ## About -- cgit v1.2.3