„README.md“ ändern

README.md

@@ -1,2 +1,39 @@
-# docker-openmw-tes3mp
+# OpenMW TES3MP in Docker optimized for Unraid
+TES3MP is a project adding multiplayer functionality to OpenMW, a free and open source engine recreation of the popular Bethesda Softworks game "The Elder Scrolls III: Morrowind".
 
+As of version 0.7.0, TES3MP is fully playable, providing very extensive player, NPC, world and quest synchronization, as well as state saving and loading, all of which are highly customizable via serverside Lua scripts.
+
+Remaining gameplay problems mostly relate to AI and the synchronization of clientside script variables.
+
+Update Notice: Simply restart the container if a newer version of the game is available.
+
+Also visit the Homepage of the creator and consider Donating: https://tes3mp.com/
+
+## Env params
+| Name | Value | Example |
+| --- | --- | --- |
+| DATA_DIR | Main Data folder | /openmw |
+| GAME_V | Preferred game version goes here (set to ‘latest’ to download the latest and check on every startup if there is a newer version available) | latest |
+| GAME_PARAMS | Extra startup Parameters if needed (leave empty if not needed) | |
+| UID | User Identifier | 99 |
+| GID | Group Identifier | 100 |
+| UMASK | Umask value | 0000 |
+| DATA_PERM | Data permissions for /chrome folder | 770 |
+
+## Run example
+```
+docker run --name OpenMW-TES3MP -d \
+	-p 25565:25565/tcp \
+	-p 25565:25565/udp
+	--env 'GAME_V=latest' \
+	--env 'UID=99' \
+	--env 'GID=100' \
+	--env 'UMASK=0000' \
+	--env 'DATA_PERM=770' \
+	--volume /mnt/cache/appdata/openmw-tes3mp:/openmw \
+	ich777/docker-openmw-tes3mp
+```
+
+This Docker was mainly edited for better use with Unraid, if you don't use Unraid you should definitely try it!
+
+#### Support Thread: https://forums.unraid.net/topic/79530-support-ich777-gameserver-dockers/