From 5c461ebce7a7b8786aafbc624f459fc55a50aee1 Mon Sep 17 00:00:00 2001
From: "Dr. Jaska" <drjaska83@gmail.com>
Date: Sat, 1 Mar 2025 17:13:17 +0000
Subject: [PATCH] Slightly improve make help output

---
 Makefile                   | 13 +++++++++----
 misc/logos/xonotic.desktop | 23 +++++++++++++++++++++++
 2 files changed, 32 insertions(+), 4 deletions(-)

diff --git a/Makefile b/Makefile
index d7d329d..8a22289 100644
--- a/Makefile
+++ b/Makefile
@@ -26,8 +26,13 @@ help:
 	@echo
 	@printf "     \e[1;33m===== Xonotic Makefile for stable and beta releases =====\e[m\n"
 	@echo
-	@printf "The DarkPlaces Engine builds will be named \e[1m$(CLIENT) \e[mand \e[1m$(SERVER)\e[m\n"
-	@printf "and will be preferred by \e[1mxonotic-linux-sdl.sh \e[mand \e[1mxonotic-linux-dedicated.sh \e[mscripts.\n"
+	@printf "The DarkPlaces Engine builds will be named \e[1;32m$(CLIENT) \e[mand \e[1;32m$(SERVER)\e[m\n"
+	@printf "and will be preferred by \e[1;32mxonotic-linux-sdl.sh \e[mand \e[1;32mxonotic-linux-dedicated.sh \e[mscripts\n"
+	@echo   "which should be used to play with the SDL client or host a dedicated server (respectively)."
+	@echo
+	@echo   "Moving binaries or data files outside of this directory is not officially supported as"
+	@echo   "this isn't compatible with the included updater and the working directory may be incorrect."
+	@printf "The above \e[1;32mscripts\e[m may be called from elsewhere via symlinks, .desktop files, or other scripts.\n"
 	@echo
 	@printf "More info is available at \e[1;36mhttps://gitlab.com/xonotic/xonotic/-/wikis/Compiling\e[m\n"
 	@echo
@@ -42,8 +47,8 @@ help:
 	@echo   "  make update-stable         Update to the latest stable release via rsync"
 	@echo   "  make update-beta           Update to the latest beta autobuild via rsync"
 	@echo
-	@printf "  make server                Compile \e[1m$(SERVER)\e[m\n"
-	@printf "  make client                Compile \e[1m$(CLIENT)\e[m\n"
+	@printf "  make server                Compile \e[1;32m$(SERVER)\e[m\n"
+	@printf "  make client                Compile \e[1;32m$(CLIENT)\e[m\n"
 	@echo   "  make both"
 	@echo
 
diff --git a/misc/logos/xonotic.desktop b/misc/logos/xonotic.desktop
index f1af0da..705e82c 100644
--- a/misc/logos/xonotic.desktop
+++ b/misc/logos/xonotic.desktop
@@ -6,7 +6,30 @@ Comment=Multiplayer, deathmatch oriented first person shooter
 Comment[de]=Deathmatch- und Mehrspieler-orientierter Ego-Shooter
 Comment[fr]=Jeu de tir à la première personne multijoueur
 Icon=xonotic
+
+# Note to packagers and/or .desktop file installers:
+#
+# Xonotic by default expects basedir's root to be the PWD which can lead to
+# issues when calling the engine directly without xonotic-linux-sdl.sh
+#
+# Options:
+# 1)
+#   Create a symlink from PATH binaries to the location of xonotic-linux-sdl.sh
+#   This relies on xonotic-linux-sdl.sh changing PWD to where Xonotic is
+# 2)
+#   Opt into the absolute path Exec and fix its path
+#   This also relies on xonotic-linux-sdl.sh changing PWD to where Xonotic is
+# 3)
+#   Recompile Xonotic with DP_FS_BASEDIR=/path/to/xonotic/ , for example
+#   with DP_FS_BASEDIR=/usr/share/xonotic/ it's no longer necessary
+#   to change your PWD and xonotic-sdl can be anywhere in PATH
+# 4)
+#   DIY your own wrapper script with "-basedir" "/path/to/Xonotic" arguments
+#   or just place the arguments in this file
+#
+#Exec=/absolute/path/to/xonotic-linux-sdl.sh
 Exec=xonotic-sdl
+
 Terminal=false
 PrefersNonDefaultGPU=true
 StartupNotify=false