Skip to content

Commit

Permalink
Updated Readme for 2.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@BigSpice
BigSpice authored Sep 5, 2022
1 parent c9d8564 commit 5bf2142
Showing 1 changed file with 48 additions and 106 deletions.
154 changes: 48 additions & 106 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@

# VTOL
[![Download Banner](https://user-images.githubusercontent.com/23240514/166419664-53e775d8-fe0d-4508-be5c-1361de70725e.png)](https://github.com/BigSpice/VTOL/releases/latest/download/VTOL_Installer.msi)
![Download Banner](https://user-images.githubusercontent.com/23240514/166419664-53e775d8-fe0d-4508-be5c-1361de70725e.png)](https://github.com/BigSpice/VTOL/releases/latest/download/VTOL_Installer.msi)


<!---
Expand Down Expand Up @@ -29,7 +30,8 @@ Total Downloads Since First Release:
</p>


<!---![image](https://user-images.githubusercontent.com/23240514/166421159-59079ea5-2a6e-4a6e-83cf-6fe8534753fe.png)--->
![image](https://user-images.githubusercontent.com/23240514/188515341-e1dc6dbf-e52c-4d56-b608-eb44743df26c.png)


<!---![VTOL_Showcase_Trim](https://user-images.githubusercontent.com/23240514/157264628-43601f3e-1066-42ce-8564-e2554bd5799f.gif)<br /><br /><br />--->

Expand All @@ -56,182 +58,123 @@ Total Downloads Since First Release:
* Install Skins From the Thunderstore Mod Browser

* Use the Tools To pack Thunderstore Compatible Mod Packages


### Contribute
* _Suggestions/bug reports are highly appreciated. Please create a new [issue](https://github.com/BigSpice/VTOL/issues/new) and fill out the fields._

### Installation and updates
* Install this application by downloading and running the latest [release from here](https://github.com/BigSpice/VTOL/releases)
* ``Download the .msi package``

![image](https://user-images.githubusercontent.com/23240514/166421076-ef637226-a61b-4904-9fae-88f1298d4051.png)

* You can preferably enable the automatic-updater module in the ``Update`` section
* You can preferably enable the automatic-updater module in the ``Settings`` section

![image](https://user-images.githubusercontent.com/23240514/175615014-8005da51-6602-414f-9bf6-aa8be18797a4.png)
![image](https://user-images.githubusercontent.com/23240514/188515310-accf9570-bc73-4d65-96cf-64c8681ffab5.png)


### Configuration

* If the launcher fails to automatically find your Titanfall 2 installation, please select ``Browse`` on the Main page and _browse_ to where your Titanfall 2 installation is, and select the Titanfall2 folder
* If the launcher fails to automatically find your Titanfall 2 installation, please select ``Locate TitanFall 2 Install`` on the Main page and _browse_ to where your Titanfall 2 installation is, and select the Titanfall2 folder

* Common Game Install Locations:
* Steam: `C:\Program Files (x86)\Steam\steamapps\common\Titanfall2`
* Origin: `C:\Program Files (x86)\Origin Games\Titanfall2`


![image](https://user-images.githubusercontent.com/23240514/152446386-4bb584c1-038a-4dd6-9588-ac3827884144.png)

![image](https://user-images.githubusercontent.com/23240514/188321176-a59ee242-592d-4ba1-b0a9-52656c998676.png)

### Verify [Northstar](https://northstar.tf)

* This will check the status of NorthstarLauncher.exe and show it's install location.
* Steam: `C:\Program Files (x86)\Steam\steamapps\common\Titanfall2\NorthstarLauncher.exe`
* Origin: `C:\Program Files (x86)\Origin Games\Titanfall2\NorthstarLauncher.exe`

![image](https://user-images.githubusercontent.com/23240514/152446412-d10f1f7e-bbc2-4558-8e8b-033aae2af410.png)

* To update or repair your Northstar installation, click the ``Update/Repair Northstar`` Button.
* To update or repair your Northstar installation, click the ``Update Northstar`` Button.
* This will download the latest [Northstar release](https://github.com/R2Northstar/Northstar/releases/latest) and repair/update your current installation.


![image](https://user-images.githubusercontent.com/23240514/152446466-26d91f33-948d-4051-9247-c21b20328515.png)
![image](https://user-images.githubusercontent.com/23240514/188321618-9276fa4b-450c-41e1-be11-b32d00079256.png)

_If an outdated version is detected, this will update it, if the installed version is up to date, it will repair it._

## Feature Guides

### Status Icons
_If origin has been detected as inactive, clicking this icon will auto start the Origin Client._
![image](https://user-images.githubusercontent.com/23240514/175618395-1b95e20a-147d-4101-a93e-159e9d96b177.png)
### Dedicated Server

![image](https://user-images.githubusercontent.com/23240514/175618633-cc3a6411-392c-4d68-a3e6-66e6b42da24f.png)
![image](https://user-images.githubusercontent.com/23240514/188321241-e9b51ff5-22ff-4f43-9a3c-cb7e75a188d6.png)
![image](https://user-images.githubusercontent.com/23240514/188515172-23434e04-3d65-4154-8e88-51546091c64f.png)

### Dedicated Server
![image](https://user-images.githubusercontent.com/23240514/188321318-85c5c9fb-9147-49cd-937b-a8f69d68ba04.png)
**Under this section, you can configure the entire backend of a server and start it from here.**<br/>
*Simply click load configuration to start editing your server cfg files.*
![image](https://user-images.githubusercontent.com/23240514/175618698-a42a92d5-cfd8-4c8f-9aad-171b8d0cc5bc.png)<br/>

![image](https://user-images.githubusercontent.com/23240514/175618788-51c6621d-7ac0-48a8-9473-22ae1395108b.png)<br/>
![image](https://user-images.githubusercontent.com/23240514/175618810-ebcd86a6-a797-4ade-874d-86c76d60711f.png)<br/>
![image](https://user-images.githubusercontent.com/23240514/188321318-85c5c9fb-9147-49cd-937b-a8f69d68ba04.png)
![image](https://user-images.githubusercontent.com/23240514/188321345-1174e877-3eec-4a22-b313-bef28a1c3b49.png)
You are also able to import and export server Configs from other Pilots :D.
![image](https://user-images.githubusercontent.com/23240514/175620654-8a865c81-0785-47da-9d4b-443e2b434edc.png)<br/>
<br/>
![image](https://user-images.githubusercontent.com/23240514/175620405-dddfd675-3cd6-4322-9299-fc96ebf650a8.png)
![image](https://user-images.githubusercontent.com/23240514/188321367-08dcd5b4-b947-4534-9c4b-3a2cabe949d5.png)
![image](https://user-images.githubusercontent.com/23240514/188321372-a0c742a1-cdd9-41b2-9019-be02647bf3cf.png)

### Thunderstore Mod Browser

_[Thunderstore](https://northstar.thunderstore.io) Support released as of version 1.1.7_
![image](https://user-images.githubusercontent.com/23240514/175615183-657f4412-6953-477f-8e2f-b36d22582cc1.png)

There is now Search functionality you can use to search through the mod Categories by publisher or mod name. Simply Click the ``Search Bar`` and Fill out your query<br/><br />

![image](https://user-images.githubusercontent.com/23240514/175615679-72cfcb6e-8a86-4bc6-bc3a-215df71ace15.png)
<br/><br />

![image](https://user-images.githubusercontent.com/23240514/188321389-d059d73a-1352-4aaa-868c-8fd1a3370164.png)

If you wish to, you can also navigate to the mod's thunderstore site to download the mod manually using the ``Go To Webpage`` button.<br/>

![image](https://user-images.githubusercontent.com/23240514/166420788-ad403cd9-d435-49b9-8d41-168d028f06f8.png)

<br />
<br />


![image](https://user-images.githubusercontent.com/23240514/188321404-3ae260b8-53d8-437f-829d-7f13d417213b.png)
## Installing Mods

* You can see a list of all installed and disabled mods in the ``Mods`` section:
![image](https://user-images.githubusercontent.com/23240514/175618156-ef991163-0729-422c-8362-d5358c568e1a.png)



* If you have a .zip file of the mod you want to install, you simply need to browse to the .zip file and select it. It'll be installed in the same way.

* If you want to enable, or disable mods, simply click the specific mod's name in the list, and press the corresponding arrow button to move them between the Enabled/Disabled lists.

![image](https://user-images.githubusercontent.com/23240514/152447411-2f7b1f99-a558-4885-bd11-f45952d6a04b.png)
![image](https://user-images.githubusercontent.com/23240514/152447434-f2996352-9237-46f0-aa07-2c2e3181ea21.png)
![image](https://user-images.githubusercontent.com/23240514/152447448-24d51ad1-da48-44d2-b1d6-c864767cd230.png)

![image](https://user-images.githubusercontent.com/23240514/188321416-7e00088d-2a6e-4cd6-b254-18ae066d46da.png)
* Right Click over a mod to view more options such as deleting the mod,<br/>
![image](https://user-images.githubusercontent.com/23240514/175615887-8682b71d-b375-4ed5-ab9c-8db6847caccd.png)

![image](https://user-images.githubusercontent.com/23240514/188321450-73c660e0-b96f-41a7-a095-4aa9de8aef94.png)
* Or to see info about the mod<br/>
![image](https://user-images.githubusercontent.com/23240514/175615942-cd533cc2-aec1-48c6-a515-1df3cdb591fd.png)

![image](https://user-images.githubusercontent.com/23240514/188321454-4793363f-6ffa-49f1-97bc-fd9fb778a45d.png)
## Installing Skins

* First, Navigate to your desired Skin's ``.ZIP`` file
![image](https://user-images.githubusercontent.com/23240514/175616031-cc4cf3e4-5899-4f5c-8935-b01fd024445d.png)

<br /><br />

* Click import skin and wait for the compatibility check to finish.

![image](https://user-images.githubusercontent.com/23240514/152447613-e3fc58d8-992e-46ad-9c2c-499a87888603.png)
![image](https://user-images.githubusercontent.com/23240514/188321477-af07a286-5b3c-41a0-9acb-ce27feb192a3.png)
![image](https://user-images.githubusercontent.com/23240514/188321547-43ff52b4-9b3a-45df-a474-694a230965c9.png)

![image](https://user-images.githubusercontent.com/23240514/175616227-83102217-1ba1-4499-9c3e-74291c4d002b.png)


* Once the compatibility is ``Confirmed`` with a green light, the application can now inject the skin.
* Click ``Install Skin`` to proceed with the installation of the skin.
* Click ``Install Skin`` once you have dragged or manually located your skin zip, to proceed with the installation of the skin.
* Installed Skins usually replace the ``Factory Issue`` skin of a weapon

![image](https://user-images.githubusercontent.com/23240514/152447644-27b7089a-1c17-4628-8616-42f8c0950baa.png)

Skin Textures will be previewed in the following way

![image](https://user-images.githubusercontent.com/23240514/175616321-17bfc047-a240-4fca-88a8-53e2401912e3.png)

## THEMES
To Change your Theme, Simply select a color and Click Confirm.
![image](https://user-images.githubusercontent.com/23240514/175616520-5c169ccf-9997-48dc-ab1f-6cc69ba14ae9.png)
![image](https://user-images.githubusercontent.com/23240514/175616582-138f870d-6480-47bb-b82e-9ca5dfe28030.png)

![image](https://user-images.githubusercontent.com/23240514/188321558-9a40893d-5d7c-4336-952e-3e7fb494ee8e.png)
## TOOLS
As of 1.2.3, the `` Tools`` Section has been added.<br/>
### Thunderstore Packager<br/>
![image](https://user-images.githubusercontent.com/23240514/175616984-e2aa7fef-92fc-4231-855a-56aec3409830.png)
![image](https://user-images.githubusercontent.com/23240514/188321695-6f56a7de-67e0-4200-90ac-02b2f08a6c8a.png)

Under this tool, it makes it seamless and easy to add and create fully compatible `` Thunderstore Mods`` .
* Select the Zip of the Mod to be Uploaded<br/>
![image](https://user-images.githubusercontent.com/23240514/175617495-2f6c95c9-b2e5-4d57-9556-ebbbb5ff7260.png)
![image](https://user-images.githubusercontent.com/23240514/188321708-428a38d0-da14-435a-be26-5bd9cd98eae3.png)


* Drag or click to select a **PNG** Icon that is **256x256** this is **VERY** Important<br/>
![image](https://user-images.githubusercontent.com/23240514/188321717-dd80e1e8-d293-42b1-bd6b-a960b334322d.png)

* Select an **PNG** Icon that is **256x256** this is **VERY** Important<br/>
![image](https://user-images.githubusercontent.com/23240514/175617503-4fe651f6-4724-47b6-9084-dd6267ea11bf.png)

* Fill out your Page Description<br/>
![image](https://user-images.githubusercontent.com/23240514/175617519-710cb9a2-fd55-4ef5-985a-7cd2da9ed311.png)
![image](https://user-images.githubusercontent.com/23240514/188321724-75599226-3ddc-4b5b-bc01-e75c2c729e4a.png)


* Fill out these Fields as you Wish
*Remember, mod names can only have letters(no -,?,', and other related symbols)*<br/>
![image](https://user-images.githubusercontent.com/23240514/175617530-9edf95b7-568b-490c-acda-3c8de00de4ca.png)
![image](https://user-images.githubusercontent.com/23240514/188321736-af541f38-f941-47aa-9393-8d58d2451ca4.png)


* Select and output Directory<br/>
![image](https://user-images.githubusercontent.com/23240514/175617542-cfa9972b-e5c7-4c7c-89c3-caf1138354b3.png)
![image](https://user-images.githubusercontent.com/23240514/188321759-981d0668-c4c4-4f94-829f-051f036438ce.png)


* This option is available as ``VTOL`` is able to install DDS skins put on the Thunderstore Page.<br/>
![image](https://user-images.githubusercontent.com/23240514/175617549-06a757da-70d6-4ede-95ab-bfe5d95db972.png)
![image](https://user-images.githubusercontent.com/23240514/188321741-65fd9fa2-3de4-4414-a4f8-c2d7b6c9e122.png)


* Click output and place the mod in your Thunderstore Publishes.<br/>
![image](https://user-images.githubusercontent.com/23240514/175617562-83d0eb87-1ab4-4969-840e-384c3a0a7622.png)
![image](https://user-images.githubusercontent.com/23240514/188321780-8b683c45-2a35-4687-bbf6-0fe15f0be51b.png)



## Updating VTOL

* You can check for updates in the ``Updates`` Section

![image](https://user-images.githubusercontent.com/23240514/152447690-94ba2d70-c832-4b25-b040-532bf0f27f33.png)
![image](https://user-images.githubusercontent.com/23240514/188321790-70779d12-eb28-49a2-b205-23e04ed55db4.png)

* If you wish to, you can configure automatic updates for your installation.

![image](https://user-images.githubusercontent.com/23240514/152447709-58e9ae8c-e630-4bfc-976c-b56f741effad.png)


* If you wish to update or repair your installation, simply click the "Update/Repair" button.

![image](https://user-images.githubusercontent.com/23240514/152447727-332cc754-fb71-4552-ab3f-f206390cede1.png)

* If you wish to, you can configure automatic updates for your installation.

![image](https://user-images.githubusercontent.com/23240514/188321794-e95ba16d-1e8a-4185-88b0-ce2be0ced378.png)
# Troubleshooting
* If you see one of the following error messages
Simply click "Yes" and the application will attempt to fix the issue.
Expand All @@ -244,4 +187,3 @@ Simply click "Yes" and the application will attempt to fix the issue.
Thank you to @ConnorDoesDev and @MysteriousRSA for the massive support in making the application and #Readme more readable.

Logo by @MysteriousRSA

0 comments on commit 5bf2142

Please sign in to comment.