Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Trim trailing whitespaces #65

Merged
merged 1 commit into from
Sep 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!--
<!--
BEFORE OPENING A PULL REQUEST:
-> If you're adding multiple independent changes (e.g. adding a section about modding while also fixing a typo on another page) it's generally recommended to split these changes into separate pull requests.

Expand Down
8 changes: 4 additions & 4 deletions docs/Wiki/development/debugging/visualstudio.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ Northstar is easiest to debug through Visual Studio due to its cmake support.

* If you do not already have Visual Studio download it https://visualstudio.microsoft.com/
* Its recommended that you install the Community version because it is freely availalbe.
* You need to install the `Desktop development with C++` workflow to debug native programs
* You need to install the `Desktop development with C++` workflow to debug native programs
![](../../images/debugger-visualstudio-installer-workloads-cpp.png)

* Open Visual Studio
* Select `Open a project or solution`
* Select `Open a project or solution`
![](../../images/debugger-visualstudio-launcher.png)
* If you already have a solution open you can open a new project through the menu bar
* If you already have a solution open you can open a new project through the menu bar
![](../../images/debugger-visualstudio-menu-solution.png)
* Open `NorthstarLauncher.exe`
* You can now debug Northstar
* You can now debug Northstar
![](../../images/debugger-visualstudio-debug-menubar.png)
* You can find relevant debug symbols in [NorthstarLauncher releases](https://github.com/R2Northstar/NorthstarLauncher/releases)
10 changes: 5 additions & 5 deletions docs/Wiki/development/debugging/x64dbg.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,17 @@ If you are not experienced with x64dbg it its recommended to use [Visual Studio]
* Run `x96dbg.exe`
* You may receive a Windows SmartScreen prompt, x64dbg snapshots are not signed and will always cause these prompts
* When running for the first time it will ask you some questions. After this is complete rerun the executable.
* Select `x64dbg` in the Launcher
* Select `x64dbg` in the Launcher
![](../../images/debugger-x64dbg-launcher.png)

* Do make debugging easier it is suggested to change your settings to the following:
* Keeping System Breakpoint enabled is optional but useful
* Keeping System Breakpoint enabled is optional but useful
![](../../images/debugger-x64dbg-events.png)

* Skipping INT3 stepping is recommended to prevent generic breakpoints from stopping the program
* Skipping INT3 stepping is recommended to prevent generic breakpoints from stopping the program
![](../../images/debugger-x64dbg-engine.png)

* Make sure to select the exception before disabling breaking. If you are debugging a C++ Exception you need to ignore common exceptions that occur during runtime
* Make sure to select the exception before disabling breaking. If you are debugging a C++ Exception you need to ignore common exceptions that occur during runtime
![](../../images/debugger-x64dbg-exceptions.png)

* Open `NorthstarLauncher.exe` in x64dbg
Expand All @@ -38,5 +38,5 @@ Debugging Northstar under Linux is not trivial due to the direct dependency on O

To simplify the use of x64dbg and automate running Origin a community member has created a script: [ns-linux-dbg](https://github.com/R2NorthstarTools/ns-linux-dbg)

To run it simply invoke it: `./nsdbg.py`
To run it simply invoke it: `./nsdbg.py`
It supports a variety of options as well as vanilla wine and Proton, use the help flag to see all possible options: `./nsdbg.py --help`
2 changes: 1 addition & 1 deletion docs/Wiki/development/releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ Once `2.0` has been released, expectations for `3.0` tend to be lower as the num

## Other repos

Repos like navmeshes and DiscordRPC get their release unrelated to main Northstar release numbering as they usually only see a few release per year due to
Repos like navmeshes and DiscordRPC get their release unrelated to main Northstar release numbering as they usually only see a few release per year due to


### DiscordRPC
Expand Down
2 changes: 1 addition & 1 deletion docs/Wiki/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ A: This usually lies behind your computer's specs not being high enough in order

### Q: Why does my game tell me there's an issue with Origin when I don't have Origin? <a href="#ea-replaced-origin" id="faq-ea-replaced-origin"></a>

A: Titanfall2 (and other EA games) used to use a program called [Origin](<https://en.wikipedia.org/wiki/Origin_(service)>) to play games, however this has since been replaced by the EA App.
A: Titanfall2 (and other EA games) used to use a program called [Origin](<https://en.wikipedia.org/wiki/Origin_(service)>) to play games, however this has since been replaced by the EA App.
This change, however, did not update the game's error messages to say "EA App" instead of "Origin", so any time you see that there's an issue with Origin, you can replace mention of "Origin" with the "EA App".

### Q: When I launch Northstar, a small command prompt appears for a few seconds then closes as nothing else happens!
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Whether you're running a listen or dedicated server, you'll generally want to me
Additionally dedicated server settings and configs can be used on a listen server.\
Server startup arguments can be placed into `Titanfall2/ns_startup_args.txt`\
Convars can be placed into `R2Northstar/mods/Northstar.CustomServers/mod/cfg/autoexec_ns_server.cfg`
The only difference between a listen and dedicated server is that a listen can only run while the host is in the match.
The only difference between a listen and dedicated server is that a listen can only run while the host is in the match.

Below are a series of variables and commands you can use for server configuration:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Example: `+setplaylistvaroverrides "run_epilogue 0 featured_mode_amped_tacticals
| sns_melee_kill_value | int | 5 | |
| sns_reset_pulse_blade_cooldown_on_pulse_blade_kill | 0-1 | 1 | Enables getting Pulse Blade back after a Pulse Blade kill |

### Gun game playlist overrides
### Gun game playlist overrides

| PlaylistOverrides for GG | Accepted Values | Default Value | Description |
| ------------------------------------------ | --------------- | ------------- | ---------------------------------------------------------------------------------------------- |
Expand Down
2 changes: 1 addition & 1 deletion docs/Wiki/installing-northstar/basic-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Should you notice any issues/warnings/errors while running Northstar, check the

## Additional Stuff

You can launch Northstar via Steam, Origin, or EA using [launch options](troubleshooting.md#launch-opts).
You can launch Northstar via Steam, Origin, or EA using [launch options](troubleshooting.md#launch-opts).

If Northstar doesn't appear to be installed, or you have issues entering the lobby, try running vanilla files. It's hard to say what VPK mods could cause issues with Northstar at the moment, so it'd probably be easiest just to try running unmodded.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Note that none of these tools are directly part of the Northstar project and as
![FlightCore Mod browser](../../images/flightcore-mod-browser-window.png)

Fast and easy to use Northstar installer, updater, launcher, and mod-manager. Features built-in mod browser and allows for easy installation of pre-release versions of Northstar.\
Supports Windows and Linux.
Supports Windows and Linux.


Download and source code:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

FlightCore is a Northstar installer and mod manager which allows for installing, updating, and managing mods for the Northstar client made for Titanfall 2.

Something to note is that FlightCore works on both Windows and Linux. The setup process is similar for both, except for the installation folder, and how you install FlightCore.
Something to note is that FlightCore works on both Windows and Linux. The setup process is similar for both, except for the installation folder, and how you install FlightCore.

## Windows Installation

Expand All @@ -12,7 +12,7 @@ Install the FlightCore file directly from the [Northstar website](https://norths

Then, run the `.msi` file this downloads, and it will automatically install FlightCore for you.

## Linux Installation
## Linux Installation

For Linux, you want to download `flight-core_X.Y.Z_amd64.AppImage` (X Y Z being the version numbers of FlightCore) from [FlightCore's GitHub releases page](https://github.com/R2NorthstarTools/FlightCore/releases), put it in a place you prefer, then make sure to right click on it, click on properties, and tick `Executable as Program` (as shown below), then you can just double click it to open FlightCore.

Expand All @@ -24,7 +24,7 @@ For Linux, you want to download `flight-core_X.Y.Z_amd64.AppImage` (X Y Z being

This is the _Main Menu_ of FlightCore. It includes the _Play_, _Changelog_, _Mods_, and _Settings_ tabs, all of which will be covered in the guide.

## Play
## Play

![Play tab's information](../../images/flightcore-main-window-information.png)

Expand All @@ -46,7 +46,7 @@ The _Mods_ tab of Flightcore can display either mods installed locally, or a bro

`Online` displays the Mod browser, which sorts by newest uploads by default. Hitting install on a mod will automatically install it, and hitting the *i* next to it will open the mod's information page on ThunderStore in your browser.

## Settings
## Settings

![FlightCore's Settings tab](../../images/flightcore-settings.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The `Find Mods` button on Viper's mod screen allows you to search through [North

The `Release Notes` tab shows you the release notes for Northstar versions, which you can find [here](https://github.com/R2Northstar/Northstar/releases)

### Viper Menu
### Viper Menu

![Viper's main menu](../../images/viper-menu.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ VTOL is a mod manager for installing and managing mods for the Northstar client

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.
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)
Expand All @@ -17,7 +17,7 @@ Note that the portable is just a `.exe` file and not the installer, as such it w

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

Expand Down Expand Up @@ -46,15 +46,15 @@ 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"_.
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.
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
Expand Down Expand Up @@ -84,8 +84,8 @@ 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.
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.
Expand Down Expand Up @@ -121,7 +121,7 @@ For the dedicated server option, you can scroll through this tab to set many dif

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

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

### ThunderStore Packer

Expand Down Expand Up @@ -154,7 +154,7 @@ 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.
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)
Expand Down
Loading