docs/README.md


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

---
description: A Titanfall|2 mod to join and host custom servers.
---

# Welcome to Northstar

{% embed url="https://www.youtube.com/watch?v=en06Y6CPMQg" %}

## Releases and installation guide:

Get the newest Northstar release here:

{% embed url="https://github.com/R2Northstar/Northstar/releases" %}

Install instructions can be found here:

{% content-ref url="installing-northstar/basic-setup.md" %}
[basic-setup.md](installing-northstar/basic-setup.md)
{% endcontent-ref %}

## Modding instructions

For modding guides, documentation on Northstar API features and documentation on Respawn Squirrel look at:

{% content-ref url="modding/getting-started.md" %}
[getting-started.md](modding/getting-started.md)
{% endcontent-ref %}

## Contact and contributing

**Please remember:** You should expect to encounter bugs and crashes with Northstar.\
Northstar is mostly being developed by a single person as a mod to Titanfall|2.\
If you do encounter issues that this guide doesn't have a fix for, you can get support in the Discord linked below.

{% embed url="https://northstar.tf/discord" %}

For contributing check:

{% content-ref url="contributing.md" %}
[contributing.md](contributing.md)
{% endcontent-ref %}

All the source code related to Northstar can be found here:

{% embed url="https://northstar.tf" %}