From e9727479694db6bf35fa80fd17080524cfe6bb0b Mon Sep 17 00:00:00 2001
From: smallmodel <15067410+smallmodel@users.noreply.github.com>
Date: Mon, 9 Sep 2024 23:43:29 +0200
Subject: [PATCH] Update documentation

This adds an example for using fs_homepath
---
 docs/getting_started_running.md | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/docs/getting_started_running.md b/docs/getting_started_running.md
index f1e32f7c..0ff0e46c 100644
--- a/docs/getting_started_running.md
+++ b/docs/getting_started_running.md
@@ -27,7 +27,12 @@ This is by design since ioquake3 and has two advantages:
 - On a multi-user system, each user will have their own configuration file
 - It doesn't overwrite the existing MOHAA configuration in the MOHAA installation directory.
 
-The location of user-writable data can be changed manually by setting the `fs_homepath` variable in the command-line argument. The value can be a relative path (relative to the current working directory) or an absolute path.
+The location of user-writable data can be changed manually by setting the `fs_homepath` variable in the command-line argument. This is useful when running a dedicated server that can only use the game directory to store/read data. The value can be a relative path (relative to the current working directory) or an absolute path. Example:
+- `+set fs_homepath Z:\openmohaa_data` data will be written inside the fully qualified path `Z:\openmohaa_data`
+- `+set fs_homepath homedata` will use the subfolder `homedata` in the process current working directory to write data (will be created automatically)
+- `+set fs_homepath .` not recommended, will write data inside the process current working directory
+
+The game directory is intended to be read-only, which is the reason why the home path exists. This prevents existing files in the game directory from being accidentally overwritten.
 
 Note that the configuration file isn't created nor written automatically on a dedicated server (**omohaaded**).