From e99d41460b2f633e9c79c6459e2f144f5598004a Mon Sep 17 00:00:00 2001 From: Armand Golpaygani Date: Sat, 3 Aug 2024 00:01:17 +0200 Subject: [PATCH 1/4] Simplify the game template doc around a custom launcher --- .../modding/openmw-game-template.rst | 110 +++--------------- 1 file changed, 17 insertions(+), 93 deletions(-) diff --git a/docs/source/reference/modding/openmw-game-template.rst b/docs/source/reference/modding/openmw-game-template.rst index 68fa667911..014f40a577 100644 --- a/docs/source/reference/modding/openmw-game-template.rst +++ b/docs/source/reference/modding/openmw-game-template.rst @@ -13,12 +13,20 @@ With the exception of ``Pelagiad.ttf`` font file, the Template is released as Installation ************ +Download a fresh copy of OpenMW +=============================== + +Get the `latest release `_ +for your operating system. + + +Download the Template (Example Suite) +===================================== + The Template is installed the same way you would install a mod, with general instructions available at :doc:`mod-install`. It can be downloaded from -`its repository `_ and requires -OpenMW 0.47 or later. - -After getting the Template, extract its ``/data`` folder to somewhere on your disk. +`its repository `_ +and requires OpenMW 0.47 or later. .. note:: @@ -27,96 +35,12 @@ After getting the Template, extract its ``/data`` folder to somewhere on your di and use the Template as a foundation for a standalone game. -Define paths to .omwgame and data files -======================================= - -OpenMW needs to be told where to look for the Template files. This is done in -``openmw.cfg`` file where ``content=`` tells OpenMW which .omwgame file to use -and ``data=`` tells OpenMW what folders to look for meshes, textures, audio, -and other assets. The required lines would look like this, but with the paths -of course different on your system. - -.. code:: - - content=template.omwgame - data="/home/someuser/example-suite/data" - data="/home/someuser/example-suite" - - -Remove references to Morrowind files -==================================== - -In case you have Morrowind installed and have run OpenMW's installation wizard, -you need to remove or comment out the following lines from ``openmw.cfg``. -Not doing so will either produce errors or load Morrowind content, which you -probably do not want when you are making your own game. - -.. code:: - - fallback-archive=Morrowind.bsa - fallback-archive=Tribunal.bsa - fallback-archive=Bloodmoon.bsa - content=Morrowind.esm - content=Tribunal.esm - content=Bloodmoon.esm - data="/home/someuser/.wine/dosdevices/c:/Morrowind/Data Files" - - -Define paths to essential models -================================ - -Certain models, essential to OpenMW, cannot be assigned through OpenMW-CS but -are instead assigned through ``settings.cfg``. These models are player and NPC -animations, and meshes for the sky. In ``settings.cfg`` used by your OpenMW -install, add the following lines under the ``[Models]`` section. - -.. code:: - - xbaseanim = meshes/BasicPlayer.dae - baseanim = meshes/BasicPlayer.dae - xbaseanim1st = meshes/BasicPlayer.dae - baseanimkna = meshes/BasicPlayer.dae - baseanimkna1st = meshes/BasicPlayer.dae - xbaseanimfemale = meshes/BasicPlayer.dae - baseanimfemale = meshes/BasicPlayer.dae - baseanimfemale1st = meshes/BasicPlayer.dae - xargonianswimkna = meshes/BasicPlayer.dae - xbaseanimkf = meshes/BasicPlayer.dae - xbaseanim1stkf = meshes/BasicPlayer.dae - xbaseanimfemalekf = meshes/BasicPlayer.dae - xargonianswimknakf = meshes/BasicPlayer.dae - skyatmosphere = meshes/sky_atmosphere.dae - skyclouds = meshes/sky_clouds_01.osgt - skynight01 = meshes/sky_night_01.osgt - - -As a convenience the Template repository includes a ``settings.cfg`` containing -these same lines which can be copied and pasted. However, do not use the file -to simply overwrite the ``settings.cfg`` used by your OpenMW installation. - - -Copying the UI files -==================== - -The Template includes a ``resources/mygui`` folder. The contents of this folder -need to be copied to ``resources/mygui`` folder found in your OpenMW installation -folder. Overwrite any files aready in this folder. These files provide the -UI font, its definition, and some minor UI tweaks. - -.. code:: - - openmw_box.skin.xml - openmw_button.skin.xml - openmw_font.xml - openmw_windows.skin.xml - Pelagiad.ttf - - Run OpenMW Launcher ******************* -After completing all the steps, run OpenMW Launcher and make sure ``template.omwgame`` -is selected in *Data Files* tab. Then, run the game and enjoy an empty island. It is not -empty though! It is full of potential to start making your very own game on the -OpenMW engine. Good luck! +After completing all the steps, run OpenMW Launcher and make sure the Template data is used:: + openmw.exe --replace=config --config C:/example-suite --user-data C:/example-suite + +Then, run the game and enjoy an empty island. It is not empty though! It is +full of potential to start making your very own game on the OpenMW engine. Good luck! From aa4a0b5b12029d69f54fde5184fb912a31a89872 Mon Sep 17 00:00:00 2001 From: Armand Golpaygani Date: Sat, 3 Aug 2024 00:30:42 +0200 Subject: [PATCH 2/4] add the extraction step --- docs/source/reference/modding/openmw-game-template.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/source/reference/modding/openmw-game-template.rst b/docs/source/reference/modding/openmw-game-template.rst index 014f40a577..4b8fde1ee7 100644 --- a/docs/source/reference/modding/openmw-game-template.rst +++ b/docs/source/reference/modding/openmw-game-template.rst @@ -28,6 +28,9 @@ instructions available at :doc:`mod-install`. It can be downloaded from `its repository `_ and requires OpenMW 0.47 or later. +Extract the zip archive somewhere on your disk. We'll use C:/example-suite as +the extracted path for the rest of this page, but you can put it anywhere. + .. note:: It's adviseable to not put the Template files in the same folder as your @@ -40,7 +43,7 @@ Run OpenMW Launcher After completing all the steps, run OpenMW Launcher and make sure the Template data is used:: - openmw.exe --replace=config --config C:/example-suite --user-data C:/example-suite + C:/openmw-launcher.exe --replace=config --config C:/example-suite --user-data C:/example-suite Then, run the game and enjoy an empty island. It is not empty though! It is full of potential to start making your very own game on the OpenMW engine. Good luck! From 6efb276d8affe57d98bf2d6426328a342ba635de Mon Sep 17 00:00:00 2001 From: Armand Golpaygani Date: Sat, 3 Aug 2024 00:54:29 +0200 Subject: [PATCH 3/4] Clarify last paragraph --- .../reference/modding/openmw-game-template.rst | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/source/reference/modding/openmw-game-template.rst b/docs/source/reference/modding/openmw-game-template.rst index 4b8fde1ee7..9d80598432 100644 --- a/docs/source/reference/modding/openmw-game-template.rst +++ b/docs/source/reference/modding/openmw-game-template.rst @@ -38,12 +38,16 @@ the extracted path for the rest of this page, but you can put it anywhere. and use the Template as a foundation for a standalone game. -Run OpenMW Launcher -******************* +Run the game +************ -After completing all the steps, run OpenMW Launcher and make sure the Template data is used:: +After the installation, create a shortcut (or alias) for OpenMW and make sure the Template data is used:: - C:/openmw-launcher.exe --replace=config --config C:/example-suite --user-data C:/example-suite + # Windows + openmw.exe --replace=config --config C:/example-suite --user-data C:/example-suite + + # Linux / macOS + openmw --replace=config --config /path/to/example-suite --user-data /path/to/example-suite Then, run the game and enjoy an empty island. It is not empty though! It is full of potential to start making your very own game on the OpenMW engine. Good luck! From ed1df255092d4f4c96fdb1ac8cf4934d012fd07b Mon Sep 17 00:00:00 2001 From: Armand Golpaygani Date: Sat, 3 Aug 2024 03:29:34 +0200 Subject: [PATCH 4/4] update example-suite's directory name to match the default archive name --- docs/source/reference/modding/openmw-game-template.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/reference/modding/openmw-game-template.rst b/docs/source/reference/modding/openmw-game-template.rst index 9d80598432..f0b22e8b7d 100644 --- a/docs/source/reference/modding/openmw-game-template.rst +++ b/docs/source/reference/modding/openmw-game-template.rst @@ -28,7 +28,7 @@ instructions available at :doc:`mod-install`. It can be downloaded from `its repository `_ and requires OpenMW 0.47 or later. -Extract the zip archive somewhere on your disk. We'll use C:/example-suite as +Extract the zip archive on your disk. We'll use C:/example-suite-master as the extracted path for the rest of this page, but you can put it anywhere. .. note:: @@ -44,10 +44,10 @@ Run the game After the installation, create a shortcut (or alias) for OpenMW and make sure the Template data is used:: # Windows - openmw.exe --replace=config --config C:/example-suite --user-data C:/example-suite + openmw.exe --replace=config --config C:/example-suite-master --user-data C:/example-suite-master # Linux / macOS - openmw --replace=config --config /path/to/example-suite --user-data /path/to/example-suite + openmw --replace=config --config /path/to/example-suite-master --user-data /path/to/example-suite-master Then, run the game and enjoy an empty island. It is not empty though! It is full of potential to start making your very own game on the OpenMW engine. Good luck!