From 700ae369d108f46a75f2227aa98d2b6fc0105511 Mon Sep 17 00:00:00 2001 From: GeckoEidechse Date: Sun, 2 Jan 2022 20:07:05 +0000 Subject: GitBook: [#27] Expand hosting dedicated server section --- docs/SUMMARY.md | 4 +++- .../dedicated-server.md | 18 ------------------ .../dedicated-server/README.md | 14 ++++++++++++++ .../dedicated-server/hosting-on-linux.md | 5 +++++ .../dedicated-server/useful-launch-arguments.md | 5 +++++ docs/modding/getting-started.md | 6 +++--- 6 files changed, 30 insertions(+), 22 deletions(-) delete mode 100644 docs/hosting-a-server-with-northstar/dedicated-server.md create mode 100644 docs/hosting-a-server-with-northstar/dedicated-server/README.md create mode 100644 docs/hosting-a-server-with-northstar/dedicated-server/hosting-on-linux.md create mode 100644 docs/hosting-a-server-with-northstar/dedicated-server/useful-launch-arguments.md diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index b1fa601..0f5e92a 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -25,7 +25,9 @@ * [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.md) +* [Hosting a Dedicated Server](hosting-a-server-with-northstar/dedicated-server/README.md) + * [Useful Launch arguments](hosting-a-server-with-northstar/dedicated-server/useful-launch-arguments.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/dedicated-server.md b/docs/hosting-a-server-with-northstar/dedicated-server.md deleted file mode 100644 index f8214bf..0000000 --- a/docs/hosting-a-server-with-northstar/dedicated-server.md +++ /dev/null @@ -1,18 +0,0 @@ -# Hosting a Dedicated Server - -## Setup - -Dedicated servers allow you to host a Northstar server without having to use a full client, making them more lightweight and easier to host for longer periods of time. Dedicated servers are still in development for Northstar, so while they do work, expect some bugs and general jank.\ -To start a dedicated server on Northstar, launch NorthstarLauncher.exe with the argument `-dedicated`, this can be done manually, but releases also provide the batch file `r2ds.bat`, which will also do this.\ -When using a dedicated server, arguments are read from `ns_startup_args_dedi.txt`, rather than `ns_startup_args.txt`. - -## Dedicated Server Caveats -At the moment, dedicated servers still require DirectX 11 to work, which typically requires a physical GPU, though they use almost no GPU processing power while in use, this can be an issue especially on GPU-less setups, so the launch argument `-softwared3d11` can be used to force DirectX to run in software mode.\ -While this is absolutely not ideal, it's the best solution for truely headless dedicated servers at the moment, and surprisingly hardly uses any CPU time, though it can use roughly up to 1GB of RAM.\ -Regarding RAM usage, dedicated servers also use significant amounts of RAM at the moment, often requiring 1.5-2GB, though I expect this to lower as development continues. - -## Hosting on Linux - -> **TODO:** If you got experience with hosting a dedicated server on Linux as well as setting up a dedicated server in container environments please extend this section. - -[This issue thread on Github](https://github.com/R2Northstar/Northstar/issues/49) contains some instructions to succesfully host a dedicated server on Linux. diff --git a/docs/hosting-a-server-with-northstar/dedicated-server/README.md b/docs/hosting-a-server-with-northstar/dedicated-server/README.md new file mode 100644 index 0000000..8cdfb1b --- /dev/null +++ b/docs/hosting-a-server-with-northstar/dedicated-server/README.md @@ -0,0 +1,14 @@ +# Hosting a Dedicated Server + +## Setup + +Dedicated servers allow you to host a Northstar server without having to use a full client, making them more lightweight and easier to host for longer periods of time. Dedicated servers are still in development for Northstar, so while they do work, expect some bugs and general jank.\ +To start a dedicated server on Northstar, launch NorthstarLauncher.exe with the argument `-dedicated`, this can be done manually, but releases also provide the batch file `r2ds.bat`, which will also do this.\ +When using a dedicated server, arguments are read from `ns_startup_args_dedi.txt`, rather than `ns_startup_args.txt`. + +## Dedicated Server Caveats + +At the moment, dedicated servers still require DirectX 11 to work, which typically requires a physical GPU, though they use almost no GPU processing power while in use, this can be an issue especially on GPU-less setups, so the launch argument `-softwared3d11` can be used to force DirectX to run in software mode.\ +While this is absolutely not ideal, it's the best solution for truely headless dedicated servers at the moment, and surprisingly hardly uses any CPU time, though it can use roughly up to 1GB of RAM.\ +Regarding RAM usage, dedicated servers also use significant amounts of RAM at the moment, often requiring 1.5-2GB, though I expect this to lower as development continues. + diff --git a/docs/hosting-a-server-with-northstar/dedicated-server/hosting-on-linux.md b/docs/hosting-a-server-with-northstar/dedicated-server/hosting-on-linux.md new file mode 100644 index 0000000..3b2a1bc --- /dev/null +++ b/docs/hosting-a-server-with-northstar/dedicated-server/hosting-on-linux.md @@ -0,0 +1,5 @@ +# Hosting on Linux + +> **TODO:** If you got experience with hosting a dedicated server on Linux as well as setting up a dedicated server in container environments please extend this section. + +[This issue thread on Github](https://github.com/R2Northstar/Northstar/issues/49) contains some instructions to succesfully host a dedicated server on Linux. diff --git a/docs/hosting-a-server-with-northstar/dedicated-server/useful-launch-arguments.md b/docs/hosting-a-server-with-northstar/dedicated-server/useful-launch-arguments.md new file mode 100644 index 0000000..b9476e0 --- /dev/null +++ b/docs/hosting-a-server-with-northstar/dedicated-server/useful-launch-arguments.md @@ -0,0 +1,5 @@ +# Useful Launch arguments + +{% hint style="info" %} +TODO +{% endhint %} diff --git a/docs/modding/getting-started.md b/docs/modding/getting-started.md index 17f50aa..4eb6c11 100644 --- a/docs/modding/getting-started.md +++ b/docs/modding/getting-started.md @@ -6,8 +6,8 @@ This guide assumes you have basic understanding with programming and know how to If you'd like a more lengthy set of tutorials covering many topics. Look at: -{% content-ref url="tutorials/modding-tutorials.md" %} -[modding-tutorials.md](tutorials/modding-tutorials.md) +{% content-ref url="squirrel/what-is-squirrel.md" %} +[what-is-squirrel.md](squirrel/what-is-squirrel.md) {% endcontent-ref %} > TODO: Actually link tools @@ -24,7 +24,7 @@ In order to get started with making your mod, create a folder in `R2Northstar/mo After making this folder, inside it add a folder named `mod` and a file named `mod.json`. -Provided is a template `mod.json`, for a detailed list of values read [Cheatsheet](cheatsheet.md) +Provided is a template `mod.json`, for a detailed list of values read [Cheatsheet](tutorials/modding-tutorials.md) ```json { -- cgit v1.2.3