mirror of
https://gitlab.com/OpenMW/openmw.git
synced 2025-03-14 01:19:59 +00:00
Merge branch '8090-improve-example-suite-doc' into 'master'
Draft: Simplify the game template doc around a custom launcher See merge request OpenMW/openmw!4295
This commit is contained in:
Armand Golpaygani
commit
5bbbdea61e
@ -13,12 +13,23 @@ With the exception of ``Pelagiad.ttf`` font file, the Template is released as
|
||||
Installation
|
||||
************
|
||||
|
||||
Download a fresh copy of OpenMW
|
||||
===============================
|
||||
|
||||
Get the `latest release <https://github.com/OpenMW/openmw/releases/latest>`_
|
||||
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 <https://gitlab.com/OpenMW/example-suite>`_ and requires
|
||||
OpenMW 0.47 or later.
|
||||
`its repository <https://gitlab.com/OpenMW/example-suite/-/archive/master/example-suite-master.zip>`_
|
||||
and requires OpenMW 0.47 or later.
|
||||
|
||||
After getting the Template, extract its ``/data`` folder to somewhere on your disk.
|
||||
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::
|
||||
|
||||
@ -27,96 +38,16 @@ 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
|
||||
=======================================
|
||||
Run the game
|
||||
************
|
||||
|
||||
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.
|
||||
After the installation, create a shortcut (or alias) for OpenMW and make sure the Template data is used::
|
||||
|
||||
.. code::
|
||||
# Windows
|
||||
openmw.exe --replace=config --config C:/example-suite-master --user-data C:/example-suite-master
|
||||
|
||||
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!
|
||||
# Linux / macOS
|
||||
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!
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user