diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/SUMMARY.md | 1 | ||||
| -rw-r--r-- | docs/hosting-a-server-with-northstar/basic-listen-server.md | 2 | ||||
| -rw-r--r-- | docs/hosting-a-server-with-northstar/dedicated-server/best-practices.md | 10 | ||||
| -rw-r--r-- | docs/installing-northstar/basic-setup.md | 6 | ||||
| -rw-r--r-- | docs/installing-northstar/troubleshooting.md | 4 | ||||
| -rw-r--r-- | docs/modding/getting-started.md | 4 |
6 files changed, 21 insertions, 6 deletions
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index de1edf0..93f3b40 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -26,6 +26,7 @@ * [Prerequisites](hosting-a-server-with-northstar/prerequisites.md) * [Hosting a Basic Listen Server](hosting-a-server-with-northstar/basic-listen-server.md) * [Hosting a Dedicated Server](hosting-a-server-with-northstar/dedicated-server/README.md) + * [Best practices](hosting-a-server-with-northstar/dedicated-server/best-practices.md) * [Hosting on Linux](hosting-a-server-with-northstar/dedicated-server/hosting-on-linux.md) ## Modding diff --git a/docs/hosting-a-server-with-northstar/basic-listen-server.md b/docs/hosting-a-server-with-northstar/basic-listen-server.md index f34334c..3212650 100644 --- a/docs/hosting-a-server-with-northstar/basic-listen-server.md +++ b/docs/hosting-a-server-with-northstar/basic-listen-server.md @@ -5,7 +5,7 @@ To host a listen server on Northstar, go to the lobby and press the `Private Match` button to begin a private match. While this does allow you to host a server, other people won't be able to join it, so you'll need to port forward 2 ports to allow other people to join.\ The ports you'll need to forward are `37015` UDP, and `8081` TCP by default, if this works as it should, this should result in your server being displayed on the server browser, and other clients being able to connect to it.\ - + ## Server Configuration Whether you're running a listen or dedicated server, you'll generally want to mess with the configuration at least a bit. While I do think the default configuration settings are pretty ok, being able to change your server's name or password, or increasing your server's tickrate is often something you'll want to do. Server configuration can be modified in the file `R2Northstar/mods/Northstar.CustomServers/mod/cfg/autoexec_ns_server.cfg`, which will be executed on server startup. diff --git a/docs/hosting-a-server-with-northstar/dedicated-server/best-practices.md b/docs/hosting-a-server-with-northstar/dedicated-server/best-practices.md new file mode 100644 index 0000000..7e3541b --- /dev/null +++ b/docs/hosting-a-server-with-northstar/dedicated-server/best-practices.md @@ -0,0 +1,10 @@ +--- +description: Tweaks and tricks to improve both your experience in hosting and others' in playing on your server +--- + +# Best practices + + +{% hint style="info" %} +TODO: If you have experience in hosting Northstar servers and want to share your knowledge, please open a [pull request](https://github.com/R2Northstar/NorthstarWiki/pulls). +{% endhint %} diff --git a/docs/installing-northstar/basic-setup.md b/docs/installing-northstar/basic-setup.md index 48d47ef..fee513b 100644 --- a/docs/installing-northstar/basic-setup.md +++ b/docs/installing-northstar/basic-setup.md @@ -18,11 +18,11 @@ Firstly, note that the Northstar client is only available on PC and requires you Usually: `C:\Program Files\EA Games\Titanfall2` 3. Launch `NorthstarLauncher.exe` to start Northstar * After launching for the first time, you'll be greeted with a popup requesting to authenticate to the master server. Click _Yes_ (This can be changed in the mods menu later if desired)\ -  +  4. Select _Launch Northstar_\ -  +  5. From the multiplayer menu, you can use the server browser to select and join any of the public community hosted servers.\ -  +  Should you notice any issues/warnings/errors while running Northstar, check the troubleshooting page. diff --git a/docs/installing-northstar/troubleshooting.md b/docs/installing-northstar/troubleshooting.md index 778f3ef..23a22fc 100644 --- a/docs/installing-northstar/troubleshooting.md +++ b/docs/installing-northstar/troubleshooting.md @@ -1,5 +1,9 @@ # Troubleshooting +Generally try to first launch the vanilla game (i.e. not Northstar) if you encounter any issue and see if it also occurs there as well. Some problems can occur when the vanilla game was never launched before using Northstar. + +Also note that some solutions described below can also apply to the base game, like issues caused by 10th+ gen Intel CPUs. + ## Engine Error {% hint style="info" %} diff --git a/docs/modding/getting-started.md b/docs/modding/getting-started.md index 7ea7ef2..615c2af 100644 --- a/docs/modding/getting-started.md +++ b/docs/modding/getting-started.md @@ -43,11 +43,11 @@ Inside the `mod` folder, existing files found in the engine's virtual file syste ```json "Scripts": [ { - "Path": "path/to/my.nut", + "Path": "path/to/file.nut", "RunOn": "( CLIENT || SERVER ) && MP" }, { - "Path": "path/to/my_second.nut", + "Path": "path/to/another_file.nut", "RunOn": "( CLIENT || SERVER ) && MP", "ClientCallback": { "Before": "ClientPreMapspawnThing", |