Skip to content

Commit cafd307

Browse files
GeckoEidechseGeckoEidechse
authored
Add deprecation notice (#310)
Add deprecation notices to all pages Add deprecation notice in main repo readme
1 parent 6d0ea06 commit cafd307

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+522
-2
lines changed

‎README.md

+7
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# Northstar Wiki Repo
22

3+
> [!WARNING]
4+
> The GitBook based NorthstarWiki has been deprecated in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
5+
>
6+
> Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
7+
>
8+
> The source for the NorthstarDocs can be found here: [https://github.com/R2Northstar/NorthstarDocs](https://github.com/R2Northstar/NorthstarDocs)
9+
310
This repo contains documentation around the [Northstar mod](https://github.com/R2Northstar), a Titanfall 2 mod to join and host custom community servers.
411

512
The `docs/` directory contains the content synchronised to the [GitBook Wiki page](https://r2northstar.gitbook.io/).

‎docs/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,15 @@ description: A Titanfall|2 mod to join and host custom servers.
44
cover: images/northstarbanner.png
55
---
66

7+
{% hint style="warning" %}
8+
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
9+
10+
Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
11+
12+
The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/./
13+
14+
{% endhint %}
15+
716
# Welcome to Northstar
817

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

‎docs/contributing.md

+9
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,15 @@
22
description: Contribution guidelines
33
---
44

5+
{% hint style="warning" %}
6+
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
7+
8+
Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
9+
10+
The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/contributing
11+
12+
{% endhint %}
13+
514
# Contributing
615

716
## Creating an issue <a href="#contributing" id="contributing"></a>

‎docs/development/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,15 @@ description: >-
44
it.
55
---
66

7+
{% hint style="warning" %}
8+
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
9+
10+
Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
11+
12+
The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/
13+
14+
{% endhint %}
15+
716
# Development
817

918
Check the subpages on the sidebar for various aspects of Northstar development.

‎docs/development/contributing-code-to-northstar.md

+9
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,15 @@
22
description: Useful information when contributing to Northstar
33
---
44

5+
{% hint style="warning" %}
6+
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
7+
8+
Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
9+
10+
The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/contributing-code-to-northstar
11+
12+
{% endhint %}
13+
514
# Contributing code to Northstar
615

716
{% hint style="info" %}

‎docs/development/debugging/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# Debugging
22

3+
{% hint style="warning" %}
4+
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
5+
6+
Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
7+
8+
The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/debugging/
9+
10+
{% endhint %}
11+
312
{% hint style="warning" %}
413
Debugging Northstar is only recommended to experienced developers.
514
If you need help figuring out an issue feel free to visit the Northstar Discord.

‎docs/development/debugging/visualstudio.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# Visual Studio
22

3+
{% hint style="warning" %}
4+
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
5+
6+
Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
7+
8+
The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/debugging/visualstudio
9+
10+
{% endhint %}
11+
312
Northstar is easiest to debug through Visual Studio due to its cmake support.
413

514

‎docs/development/debugging/x64dbg.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# x64dbg
22

3+
{% hint style="warning" %}
4+
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
5+
6+
Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
7+
8+
The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/debugging/x64dbg
9+
10+
{% endhint %}
11+
312
{% hint style="warning" %}
413
If you are not experienced with x64dbg it its recommended to use [Visual Studio](visualstudio.md).
514
{% endhint %}

‎docs/development/northstarmasterserver/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# NorthstarMasterServer
22

3+
{% hint style="warning" %}
4+
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
5+
6+
Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
7+
8+
The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/northstarmasterserver/
9+
10+
{% endhint %}
11+
312
{% hint style="warning" %}
413
The old NodeJS master server has been replaced in favour of the Go rewrite called Atlas.
514
{% endhint %}

‎docs/development/northstarmasterserver/deploy.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# Deploy
22

3+
{% hint style="warning" %}
4+
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
5+
6+
Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
7+
8+
The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/northstarmasterserver/deploy
9+
10+
{% endhint %}
11+
312
## Development
413

514
A Development Master Server uses http requests, it should be used for development purposes on your local machine.

‎docs/development/releases.md

+9
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,15 @@ description: >-
44
new releases
55
---
66

7+
{% hint style="warning" %}
8+
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
9+
10+
Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
11+
12+
The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/releases
13+
14+
{% endhint %}
15+
716
# Releases
817

918
{% hint style="info" %}

‎docs/development/repositories/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# Repositories
22

3+
{% hint style="warning" %}
4+
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
5+
6+
Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
7+
8+
The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/repositories/
9+
10+
{% endhint %}
11+
312
Northstar is split over multiple git repositories that fulfill different functions.
413

514
* [Atlas](https://github.com/R2Northstar/Atlas):\

‎docs/development/repositories/atlas.md

+9
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,15 @@
22
description: A new Northstar master server written in Go
33
---
44

5+
{% hint style="warning" %}
6+
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
7+
8+
Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
9+
10+
The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/repositories/atlas
11+
12+
{% endhint %}
13+
514
# Atlas
615

716
TODO

‎docs/development/repositories/northstarlauncher.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# NorthstarLauncher
22

3+
{% hint style="warning" %}
4+
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
5+
6+
Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
7+
8+
The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/repositories/northstarlauncher
9+
10+
{% endhint %}
11+
312
### Setup
413

514
Build instructions for the launcher can be found here:

‎docs/development/repositories/northstarmods.md

+9
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,15 @@
22
description: Core squirrel mods
33
---
44

5+
{% hint style="warning" %}
6+
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
7+
8+
Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
9+
10+
The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/repositories/northstarmods
11+
12+
{% endhint %}
13+
514
# NorthstarMods
615

716
TODO

‎docs/development/reviewing.md

+9
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,15 @@ description: >-
55
review in general.
66
---
77

8+
{% hint style="warning" %}
9+
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
10+
11+
Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
12+
13+
The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/reviewing
14+
15+
{% endhint %}
16+
817
# Reviewing
918

1019
For new pull requests to be merged into any of the Northstar repos, they need to reviewed to reduce the changes of introducing bugs as well as ensuring that in case of a feature it's something the community actually wants.

‎docs/development/testing.md

+9
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,15 @@ description: >-
44
maintainers
55
---
66

7+
{% hint style="warning" %}
8+
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
9+
10+
Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
11+
12+
The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/testing
13+
14+
{% endhint %}
15+
716
# Testing
817

918
{% hint style="info" %}

‎docs/faq.md

+9
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,15 @@
22
description: Frequently asked questions
33
---
44

5+
{% hint style="warning" %}
6+
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
7+
8+
Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
9+
10+
The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/faq
11+
12+
{% endhint %}
13+
514
# FAQ
615

716
## **If you have any issues please go to [the troubleshooting page.](installing-northstar/troubleshooting.md)**

‎docs/hosting-a-server-with-northstar/basic-listen-server.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# Hosting a Basic Listen Server
22

3+
{% hint style="warning" %}
4+
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
5+
6+
Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
7+
8+
The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/hosting-a-server-with-northstar/basic-listen-server
9+
10+
{% endhint %}
11+
312
## Requirements
413

514
Make sure to check that your server is reachable as [described here](./getting-started.md)

‎docs/hosting-a-server-with-northstar/dedicated-server/README.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# Hosting a Dedicated Server
22

3+
{% hint style="warning" %}
4+
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
5+
6+
Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
7+
8+
The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/hosting-a-server-with-northstar/dedicated-server/
9+
10+
{% endhint %}
11+
312
## Hosting a Dedicated Server
413

514
### Setup
@@ -18,4 +27,4 @@ Regarding RAM usage, dedicated servers also use significant amounts of RAM at th
1827

1928
See [troubleshoot](../troubleshooting.md)
2029

21-
For all settings see [Server settings](../server-settings/README.md)
30+
For all settings see [Server settings](../server-settings/README.md)

‎docs/hosting-a-server-with-northstar/dedicated-server/best-practices.md

+9
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,15 @@
22
description: Tweaks and tricks to improve both your experience in hosting and others' in playing on your server
33
---
44

5+
{% hint style="warning" %}
6+
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
7+
8+
Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
9+
10+
The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/hosting-a-server-with-northstar/dedicated-server/best-practices
11+
12+
{% endhint %}
13+
514
# Best practices
615

716
{% hint style="info" %}

‎docs/hosting-a-server-with-northstar/dedicated-server/hosting-on-linux.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# Hosting on Linux
22

3+
{% hint style="warning" %}
4+
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
5+
6+
Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
7+
8+
The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/hosting-a-server-with-northstar/dedicated-server/hosting-on-linux
9+
10+
{% endhint %}
11+
312
{% hint style="info" %}
413
This page is currently work-in-progress.
514
{% endhint %}

‎docs/hosting-a-server-with-northstar/dedicated-server/hosting-on-windows.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# Hosting on Windows
22

3+
{% hint style="warning" %}
4+
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
5+
6+
Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
7+
8+
The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/hosting-a-server-with-northstar/dedicated-server/hosting-on-windows
9+
10+
{% endhint %}
11+
312
## Minimum requirements
413

514
The current minimum requirements are as follows:

‎docs/hosting-a-server-with-northstar/getting-started.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# Getting started
22

3+
{% hint style="warning" %}
4+
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
5+
6+
Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
7+
8+
The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/hosting-a-server-with-northstar/getting-started
9+
10+
{% endhint %}
11+
312
**TL;DR:** Port forward `37015` (UDP), and no [CGNAT](getting-started.md#cgnat)
413

514
Make sure you already installed Northstar [as described here](../installing-northstar/basic-setup.md).

‎docs/hosting-a-server-with-northstar/local-only-server.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# Hosting a Local-Only Server
22

3+
{% hint style="warning" %}
4+
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
5+
6+
Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
7+
8+
The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/hosting-a-server-with-northstar/local-only-server
9+
10+
{% endhint %}
11+
312
If you just want to host server (listen or dedicated) for people in your local network (as in computer network, not the in-game Networks system), you can simply not enable port-forwarding and set `ns_auth_allow_insecure` to `1` in the `autoexec_ns_server.cfg`.
413

514
This way players can connect to your server directly by using the `connect` command with the local IP of your server, e.g. `connect 192.168.420.500` (replace with actual local IP of your server).

0 commit comments

Comments
 (0)