aboutsummaryrefslogtreecommitdiff
path: root/docs/installing-northstar/northstar-installers/vtol-guide.md
blob: c7785f2e25db293230fa39a2586a2a8d129e0fc7 (plain)
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
# VTOL Guide

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

![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

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, 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 below both of these reading _"Re-Install Northstar"_.

![Installation Section](../../images/vtol-northstar-installation-info.png)

## Installation Via VTOL

VTOL handles most things automatically, but it may still require minimal setup for some users.

![Locate Titanfall 2 Install](../../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 _"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.

## Additional Mods/Settings

## Tab List

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

![Mods page](../../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. Note that core mods (those that come installed with Northstar/those that start with `Northstar`) have a yellow border to differentiate them from normal mods.

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.)

![Right clicking on a mod](../../images/vtol-mods-right-click.png)


## Installing Mods Via 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](../../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

![Skins installation tab](../../images/vtol-skins.png)

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.

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

![Tools tab](../../images/vtol-tools.png)

The fifth tab called _"Tools"_ is meant to help those trying to create mods for Northsar. 

### ThunderStore Packer

![ThunderStore packer](../../images/vtol-thunderstore-packer.png)

The first screen is an area where you can locate a folder for a mod you've created, 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'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).

### 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 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

![Tools for Modders](../../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.

## Profiles

![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 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`.

## About

![VTOL About section](../../images/vtol-about.png)

The last section of the VTOL client is the seventh 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.