aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/README.md2
-rw-r--r--docs/SUMMARY.md5
-rw-r--r--docs/hosting-a-server-with-northstar/dedicated-server/README.md (renamed from docs/hosting-a-server-with-northstar/dedicated-server.md)6
-rw-r--r--docs/hosting-a-server-with-northstar/dedicated-server/hosting-on-linux.md5
-rw-r--r--docs/hosting-a-server-with-northstar/dedicated-server/useful-launch-arguments.md5
-rw-r--r--docs/images/northstarbanner.pngbin0 -> 1060449 bytes
-rw-r--r--docs/modding/getting-started.md8
-rw-r--r--docs/modding/localisation_files.md10
-rw-r--r--docs/using-northstar/commands.md131
-rw-r--r--docs/using-northstar/gamemodes.md20
10 files changed, 180 insertions, 12 deletions
diff --git a/docs/README.md b/docs/README.md
index 965c481..dec8946 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,5 +1,7 @@
---
+coverY: 0
description: A Titanfall|2 mod to join and host custom servers.
+cover: images/northstarbanner.png
---
# Welcome to Northstar
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
index b1fa601..f0cc311 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
@@ -33,6 +35,7 @@
* [Tutorials](modding/tutorials/modding-tutorials.md)
* [Cheatsheet](modding/cheatsheet.md)
* [Squirrel](modding/squirrel/what-is-squirrel.md)
+* [Localisation](modding/localisation_files.md)
***
diff --git a/docs/hosting-a-server-with-northstar/dedicated-server.md b/docs/hosting-a-server-with-northstar/dedicated-server/README.md
index f8214bf..8cdfb1b 100644
--- a/docs/hosting-a-server-with-northstar/dedicated-server.md
+++ b/docs/hosting-a-server-with-northstar/dedicated-server/README.md
@@ -7,12 +7,8 @@ To start a dedicated server on Northstar, launch NorthstarLauncher.exe with the
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/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/images/northstarbanner.png b/docs/images/northstarbanner.png
new file mode 100644
index 0000000..7d11c56
--- /dev/null
+++ b/docs/images/northstarbanner.png
Binary files differ
diff --git a/docs/modding/getting-started.md b/docs/modding/getting-started.md
index 17f50aa..7ea7ef2 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="modding/tutorials/modding-tutorials.md" %}
+[modding-tutorials.md](modding/tutorials/modding-tutorials.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](modding/cheatsheet.md)
```json
{
@@ -63,4 +63,4 @@ Inside the `mod` folder, existing files found in the engine's virtual file syste
> TODO: Create and link Squirrel VM documentation
-`"Path"` indicates where the script is, `"RunOn"` is the Squirrel VM context (see [Squirrel VM](getting-started.md)) as an expression, and `"ClientCallback"` and `"ServerCallback"` specify a function call that can be `"Before"` and/or `"After"` map-spawn.
+`"Path"` indicates where the script is, `"RunOn"` is the Squirrel VM context (see [Squirrel VM](modding/getting-started.md)) as an expression, and `"ClientCallback"` and `"ServerCallback"` specify a function call that can be `"Before"` and/or `"After"` map-spawn.
diff --git a/docs/modding/localisation_files.md b/docs/modding/localisation_files.md
index e69de29..f6212ec 100644
--- a/docs/modding/localisation_files.md
+++ b/docs/modding/localisation_files.md
@@ -0,0 +1,10 @@
+# Localisation
+
+Northstar adds new strings to the game which can be localised to match the language you are using on your Titanfall 2 installation.
+
+## Files to translate
+
+There are the two files that need to be translated, use the English version as a base. After you finish make sure that the files are encoded in `UTF-16 LE` before opening a Pull Request.
+
+1. [Northstar.Client/mod/resource/northstar_client_localisation_english.txt](https://github.com/R2Northstar/NorthstarMods/blob/main/Northstar.Client/mod/resource/northstar_client_localisation_english.txt)
+2. [Northstar.Custom/mod/resource/northstar_custom_english.txt](https://github.com/R2Northstar/NorthstarMods/blob/main/Northstar.Custom/mod/resource/northstar_custom_english.txt)
diff --git a/docs/using-northstar/commands.md b/docs/using-northstar/commands.md
index 32f24d5..b4a06d2 100644
--- a/docs/using-northstar/commands.md
+++ b/docs/using-northstar/commands.md
@@ -35,4 +35,133 @@ In the future this keybind should hopefully be adjustable via `Controls > Settin
| `sv_cheats 0` | Disable cheats |
| `ns_masterserver_hostname` | Masterserver URL, default: `https://northstar.tf` |
| `ns_auth_allow_insecure 1` | Allows clients to connect without masterserver authorization |
-| `connect <ip address>:<port>` | Directly connect to a Northstar gameserver | \ No newline at end of file
+| `connect <ip address>:<port>` | Directly connect to a Northstar gameserver |
+
+### Server commands
+
+| Variable | Description | Default |
+|---------------------------------------------|-----------------------------------------------------------------------|---------|
+| `sv_AllWaysSupportsSaveRestore` | | 0 |
+| `sv_allTicksFinal` | | 0 |
+| `sv_allowSendTableTransmitToClients` | | 1 |
+| `sv_alltalk` | Wether both teams can talk to each other over voice chat. | 0 |
+| `sv_balanceTeams` | Wether the server will attempt to keep teams balanced between rounds. | 1 |
+| `sv_bounds_show_errors` | | 0 |
+| `sv_cheats` | Wether players can use cheat commands (i.e. noclip) . | 0 |
+| `sv_clampPlayerFrameTime` | | 0 |
+| `sv_clockcorrection` | | 1 |
+| `sv_clockcorrection_msecs` | | 75 |
+| `sv_compressPlaylists` | | 1 |
+| `sv_connectingClientDelay` | | 3 |
+| `sv_debug_deferred_trace` | | 0 |
+| `sv_debug_deferred_trace_overlay` | | 0 |
+| `sv_debug_prop_send` | | 0 |
+| `sv_debugmanualmode` | | 0 |
+| `sv_disconnectOnTooManySnapshotFrames` | | 1 |
+| `sv_dumpstringtables` | | 0 |
+| `sv_earlyPersistenceRead` | | 0 |
+| `sv_edgefriction` | | 2 |
+| `sv_everyThirdTick` | | 0 |
+| `sv_extra_client_connect_time` | | 60 |
+| `sv_gravity` | The amount of gravity the server has. | 750 |
+| `sv_hibernate_ms` | | 5 |
+| `sv_hibernate_ms_vgui` | | 5 |
+| `sv_hibernate_postgame_delay` | | 5 |
+| `sv_hibernate_when_empty` | Wether the server should hibernate when empty. | 0 |
+| `sv_instancebaselines` | | 1 |
+| `sv_kickPlayersTooFarInFuture` | Wether to kick players whose internal time is too far in the future. | 1 |
+| `sv_lerpAnims` | | 1 |
+| `sv_lobbyType` | | 1 |
+| `sv_massreport` | | 0 |
+| `sv_maxUserCmdsPerPlayerPerFrame` | | 10 |
+| `sv_max_prop_data_dwords_lobby` | | 100000 |
+| `sv_max_prop_data_dwords_multiplayer` | | 125000 |
+| `sv_max_prop_data_dwords_singleplayer` | | 300000 |
+| `sv_max_props_lobby` | | 50000 |
+| `sv_max_props_multiplayer` | | 75000 |
+| `sv_max_props_singleplayer` | | 200000 |
+| `sv_max_snapshots_lobby` | | 100 |
+| `sv_max_snapshots_multiplayer` | | 300 |
+| `sv_max_snapshots_singleplayer` | | 10 |
+| `sv_maxclientframes` | | 300 |
+| `sv_maxrate` | | 0 |
+| `sv_maxroutable` | | 1200 |
+| `sv_maxupdaterate` | | 60 |
+| `sv_minrate` | | 128000 |
+| `sv_minupdaterate` | | 20 |
+| `sv_noclipaccelerate` | The amount of acceleration in noclip. | 10000 |
+| `sv_noclipduringpause` | Wether to noclip during server pause. | 0 |
+| `sv_noclipspeed` | The speed for noclip. | 5 |
+| `sv_normalSimulationCommandThreshold` | | 3 |
+| `sv_parallel_sendsnapshot` | | 1 |
+| `sv_partyDediOnly` | | 0 |
+| `sv_pausable` | | 0 |
+| `sv_physics_maxvelocity` | | 4000.0 |
+| `sv_playerNameAppendCheater` | | 1 |
+| `sv_playerSimTimeBuffer` | | 0 |
+| `sv_precacheinfo` | | |
+| `sv_printClockCorrections` | | 0 |
+| `sv_printClockTiming` | | 0 |
+| `sv_props_funnel_into_portals` | | 1 |
+| `sv_props_funnel_into_portals_deceleration` | | 2.0f |
+| `sv_querylimit_per_sec` | | 10 |
+| `sv_quota_stringcmdspersecond` | | 60 |
+| `sv_rcon_banpenalty` | | 0 |
+| `sv_rcon_log` | Wether to log RCON commands. | 1 |
+| `sv_rcon_maxfailures` | | 10 |
+| `sv_rcon_minfailures` | | 5 |
+| `sv_rcon_minfailuretime` | | 30 |
+| `sv_regeneration_wait_time` | | 20.0 |
+| `sv_rejectClientConnects` | | 0 |
+| `sv_rejectConnections` | | 0 |
+| `sv_robust_explosions` | | 1 |
+| `sv_scarySnapDeltaPrints` | | 50 |
+| `sv_screenShake_enabled` | | 1 |
+| `sv_script_think_interval` | | 0.1 |
+| `sv_sendPlaylists` | | 1 |
+| `sv_separate_freq_change_prop_send` | | 1 |
+| `sv_shiftPlayerSimTimeBackwards` | | 1 |
+| `sv_showClientTickCmds` | | 0 |
+| `sv_showLargeSnapshotSize` | | 10000 |
+| `sv_showLargeSnapshots` | | 0 |
+| `sv_showUserCmds` | | 0 |
+| `sv_show_placement_help_in_preview` | | 0 |
+| `sv_showents` | | 0 |
+| `sv_showfiredbullets` | | 0 |
+| `sv_showhitboxes` | | -1 |
+| `sv_showlagcompensation` | | 0 |
+| `sv_shutdown` | Shuts down the server. | |
+| `sv_single_core_dedi` | | 0 |
+| `sv_skyname` | | |
+| `sv_soundscape_printdebuginfo` | | |
+| `sv_specaccelerate` | | 1000.0 |
+| `sv_specnoclip` | | 1 |
+| `sv_specspeed` | | 5 |
+| `sv_stats` | | 1 |
+| `sv_stressbots` | | 1 |
+| `sv_strugglecheck` | | 1.016 |
+| `sv_teststepsimulation` | | 0 |
+| `sv_thinktimecheck` | | 0 |
+| `sv_threaded_post_process_ai` | | 1 |
+| `sv_threaded_post_process_players` | | 1 |
+| `sv_turbophysics` | | 1 |
+| `sv_turbophysics_player` | | 1 |
+| `sv_unnecessaryConnectDelay` | | 60 |
+| `sv_updaterate_mp` | | 20 |
+| `sv_updaterate_sp` | | 20 |
+| `sv_useReputation` | | 1 |
+| `sv_use_edgefriction` | | 1 |
+| `sv_usercmd_before_entities` | | 1 |
+| `sv_usercmd_fairness_dediOnly` | | 0 |
+| `sv_usercmd_max_queued` | | 40 |
+| `sv_usercmd_num_per_iteration` | | 1 |
+| `sv_usercmd_shuffle_players` | | 1 |
+| `sv_visiblemaxplayers` | | -1 |
+| `sv_visualizetraces` | | 0 |
+| `sv_visualizetraces_duration` | | 0.5 |
+| `sv_voiceDebug` | | 0 |
+| `sv_voiceEcho` | | 0 |
+| `sv_voiceenable` | | 1 |
+| `sv_warnAboutCmdNumJumps` | | 20 |
+| `sv_weapon_despawn_time` | | 90 |
+| `sv_writeSendTableStreamFile` | | | \ No newline at end of file
diff --git a/docs/using-northstar/gamemodes.md b/docs/using-northstar/gamemodes.md
index 2614de3..08b0a07 100644
--- a/docs/using-northstar/gamemodes.md
+++ b/docs/using-northstar/gamemodes.md
@@ -1,26 +1,44 @@
# Gamemodes
+
Northstar comes included with some community made gamemodes.
## Sandbox
+
Like gmod but worse.
## Gun Game
+
Get a kill with each gun to win.
## Titan Tag
+
Earn points while in your titan. Destroy a titan to get your own.
## Infection
+
Survivors are infected when killed.
## Frontier War
+
Destroy the enemy's harvester and protect your own.
## Amped Killrace
+
Get kills to increase the length of your killrace. Collect the flag to start it. Set the record to win.
## Fastball
+
Hack control panels to win rounds and respawn your teammates.
+{% hint style="info" %}
+Some maps do not feature acontrol panels
+{% endhint %}
+
+| No issues | No control panels | Crashes to main menu |
+| ------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- |
+| <ul><li>Boomtown</li><li>Exoplanet</li><li>Black Water Canal</li><li>Eden</li><li>Angel City</li><li>War Games</li></ul> | <ul><li>Forwardbase</li><li>Homestead</li><li>Drydock</li><li>Complex</li><li>Colony</li><li>Glitch</li><li>Relic</li><li>Rise</li></ul> | <p></p><ul><li>Crash Site</li></ul> |
+
+
## Competitive CTF
-CTF with custom settings for Comp games. \ No newline at end of file
+
+CTF with custom settings for Comp games.
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-27 14:58:43 +0000