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

Add deprecation notice #310

Merged
merged 3 commits into from
Oct 4, 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
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# Northstar Wiki Repo

> [!WARNING]
> The GitBook based NorthstarWiki has been deprecated in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
>
> Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
>
> The source for the NorthstarDocs can be found here: [https://github.com/R2Northstar/NorthstarDocs](https://github.com/R2Northstar/NorthstarDocs)

This repo contains documentation around the [Northstar mod](https://github.com/R2Northstar), a Titanfall 2 mod to join and host custom community servers.

The `docs/` directory contains the content synchronised to the [GitBook Wiki page](https://r2northstar.gitbook.io/).
Expand Down
9 changes: 9 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,15 @@ description: A Titanfall|2 mod to join and host custom servers.
cover: images/northstarbanner.png
---

{% hint style="warning" %}
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.

Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)

The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/./

{% endhint %}

# Welcome to Northstar

{% embed url="https://www.youtube.com/watch?v=en06Y6CPMQg" %}
Expand Down
9 changes: 9 additions & 0 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@
description: Contribution guidelines
---

{% hint style="warning" %}
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.

Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)

The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/contributing

{% endhint %}

# Contributing

## Creating an issue <a href="#contributing" id="contributing"></a>
Expand Down
9 changes: 9 additions & 0 deletions docs/development/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,15 @@ description: >-
it.
---

{% hint style="warning" %}
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.

Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)

The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/

{% endhint %}

# Development

Check the subpages on the sidebar for various aspects of Northstar development.
Expand Down
9 changes: 9 additions & 0 deletions docs/development/contributing-code-to-northstar.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@
description: Useful information when contributing to Northstar
---

{% hint style="warning" %}
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.

Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)

The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/contributing-code-to-northstar

{% endhint %}

# Contributing code to Northstar

{% hint style="info" %}
Expand Down
9 changes: 9 additions & 0 deletions docs/development/debugging/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Debugging

{% hint style="warning" %}
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.

Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)

The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/debugging/

{% endhint %}

{% hint style="warning" %}
Debugging Northstar is only recommended to experienced developers.
If you need help figuring out an issue feel free to visit the Northstar Discord.
Expand Down
9 changes: 9 additions & 0 deletions docs/development/debugging/visualstudio.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Visual Studio

{% hint style="warning" %}
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.

Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)

The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/debugging/visualstudio

{% endhint %}

Northstar is easiest to debug through Visual Studio due to its cmake support.


Expand Down
9 changes: 9 additions & 0 deletions docs/development/debugging/x64dbg.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# x64dbg

{% hint style="warning" %}
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.

Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)

The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/debugging/x64dbg

{% endhint %}

{% hint style="warning" %}
If you are not experienced with x64dbg it its recommended to use [Visual Studio](visualstudio.md).
{% endhint %}
Expand Down
9 changes: 9 additions & 0 deletions docs/development/northstarmasterserver/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# NorthstarMasterServer

{% hint style="warning" %}
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.

Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)

The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/northstarmasterserver/

{% endhint %}

{% hint style="warning" %}
The old NodeJS master server has been replaced in favour of the Go rewrite called Atlas.
{% endhint %}
Expand Down
9 changes: 9 additions & 0 deletions docs/development/northstarmasterserver/deploy.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Deploy

{% hint style="warning" %}
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.

Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)

The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/northstarmasterserver/deploy

{% endhint %}

## Development

A Development Master Server uses http requests, it should be used for development purposes on your local machine.
Expand Down
9 changes: 9 additions & 0 deletions docs/development/releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,15 @@ description: >-
new releases
---

{% hint style="warning" %}
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.

Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)

The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/releases

{% endhint %}

# Releases

{% hint style="info" %}
Expand Down
9 changes: 9 additions & 0 deletions docs/development/repositories/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Repositories

{% hint style="warning" %}
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.

Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)

The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/repositories/

{% endhint %}

Northstar is split over multiple git repositories that fulfill different functions.

* [Atlas](https://github.com/R2Northstar/Atlas):\
Expand Down
9 changes: 9 additions & 0 deletions docs/development/repositories/atlas.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@
description: A new Northstar master server written in Go
---

{% hint style="warning" %}
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.

Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)

The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/repositories/atlas

{% endhint %}

# Atlas

TODO
9 changes: 9 additions & 0 deletions docs/development/repositories/northstarlauncher.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# NorthstarLauncher

{% hint style="warning" %}
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.

Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)

The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/repositories/northstarlauncher

{% endhint %}

### Setup

Build instructions for the launcher can be found here:
Expand Down
9 changes: 9 additions & 0 deletions docs/development/repositories/northstarmods.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@
description: Core squirrel mods
---

{% hint style="warning" %}
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.

Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)

The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/repositories/northstarmods

{% endhint %}

# NorthstarMods

TODO
Expand Down
9 changes: 9 additions & 0 deletions docs/development/reviewing.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,15 @@ description: >-
review in general.
---

{% hint style="warning" %}
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.

Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)

The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/reviewing

{% endhint %}

# Reviewing

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.
Expand Down
9 changes: 9 additions & 0 deletions docs/development/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,15 @@ description: >-
maintainers
---

{% hint style="warning" %}
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.

Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)

The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/testing

{% endhint %}

# Testing

{% hint style="info" %}
Expand Down
9 changes: 9 additions & 0 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@
description: Frequently asked questions
---

{% hint style="warning" %}
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.

Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)

The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/faq

{% endhint %}

# FAQ

## **If you have any issues please go to [the troubleshooting page.](installing-northstar/troubleshooting.md)**
Expand Down
9 changes: 9 additions & 0 deletions docs/hosting-a-server-with-northstar/basic-listen-server.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Hosting a Basic Listen Server

{% hint style="warning" %}
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.

Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)

The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/hosting-a-server-with-northstar/basic-listen-server

{% endhint %}

## Requirements

Make sure to check that your server is reachable as [described here](./getting-started.md)
Expand Down
11 changes: 10 additions & 1 deletion docs/hosting-a-server-with-northstar/dedicated-server/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Hosting a Dedicated Server

{% hint style="warning" %}
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.

Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)

The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/hosting-a-server-with-northstar/dedicated-server/

{% endhint %}

## Hosting a Dedicated Server

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

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

For all settings see [Server settings](../server-settings/README.md)
For all settings see [Server settings](../server-settings/README.md)
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@
description: Tweaks and tricks to improve both your experience in hosting and others' in playing on your server
---

{% hint style="warning" %}
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.

Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)

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

{% endhint %}

# Best practices

{% hint style="info" %}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Hosting on Linux

{% hint style="warning" %}
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.

Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)

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

{% endhint %}

{% hint style="info" %}
This page is currently work-in-progress.
{% endhint %}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Hosting on Windows

{% hint style="warning" %}
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.

Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)

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

{% endhint %}

## Minimum requirements

The current minimum requirements are as follows:
Expand Down
9 changes: 9 additions & 0 deletions docs/hosting-a-server-with-northstar/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Getting started

{% hint style="warning" %}
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.

Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)

The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/hosting-a-server-with-northstar/getting-started

{% endhint %}

**TL;DR:** Port forward `37015` (UDP), and no [CGNAT](getting-started.md#cgnat)

Make sure you already installed Northstar [as described here](../installing-northstar/basic-setup.md).
Expand Down
9 changes: 9 additions & 0 deletions docs/hosting-a-server-with-northstar/local-only-server.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Hosting a Local-Only Server

{% hint style="warning" %}
The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.

Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)

The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/hosting-a-server-with-northstar/local-only-server

{% endhint %}

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

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).
Expand Down
Loading