Commit 32af7ab2 authored by Matjaž Lamut's avatar Matjaž Lamut
Browse files

Add proper formatting, add some links and extra information to the Template installation articles.

parent 10391198
......@@ -2,80 +2,110 @@
OpenMW Game Template
####################
What is it?
-----------
OpenMW Game Template, or simply, the Template, is a set of base assets required by OpenMW to run. These include template.omwgame along with models, textures, fonts, and UI content.
The Template can be used as a foundation for a standalone game in OpenMW, without requiring any of the original, copyrighted Morrowind assets. With the exception of Pelagiad.ttf font, the Template is released under Public Domain.
OpenMW Game Template, or simply, the Template, is a set of base assets required
for OpenMW to run. These include ``template.omwgame`` along with models, textures,
fonts, and UI content. The Template can be used as a foundation for a standalone
game in OpenMW, without requiring any of the original, copyrighted Morrowind assets.
With the exception of ``Pelagiad.ttf`` font file, the Template is released as
`public domain <https://creativecommons.org/publicdomain/zero/1.0/>`_.
Installation
------------
************
The Template can be downloaded from https://gitlab.com/OpenMW/example-suite and requires OpenMW 0.47 or later. First, extract the /data folder to anywhere on your disk. Then, you need to "install" the Template by manually configuring OpenMW.
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.
After getting the Template, extract the ``/data`` folder to anywhere on your disk.
Then, you install the Template by manually configuring OpenMW.
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.
First, you need to tell OpenMW where to look for the Template content files. This is done in openmw.cfg file by adding the following lines. content tells OpenMW which .omwgame file to use. data tells OpenMW where to look
for meshes, textures, audio, and other assets.
.. code::
content=template.omwgame
data="/home/mr_documentation/example-suite/data"
data="/home/mr_documentation/example-suite"
content=template.omwgame
data="/home/someuser/example-suite/data"
data="/home/someuser/example-suite"
In case you also have Morrowind installed and have run OpenMW's installation wizard, you need to remove or comment out the following lines in openmw.cfg. Not doing so will either produce errors or load Morrowind content as well, which you probably don't want to do if you are making your own game.
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.
content=Morrowind.esm
content=Tribunal.esm
content=Bloodmoon.esm
data="/home/mr_documentation/.wine/dosdevices/c:/Morrowind/Data Files"
fallback-archive=Morrowind.bsa
fallback-archive=Tribunal.bsa
fallback-archive=Bloodmoon.bsa
.. 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 include 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.
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
Template repository includes a settings.cfg containing these same lines that you can copy-paste. Do not use this file to overwrite the settings.cfg file used by your OpenMW installation.
================================
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 includes a ``settings.cfg`` containing these same
lines which can be copied and pasted. However, do not use this 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.
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. When prompted whether you wish to owerwrite files, say "I do!". 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
openmw_box.skin.xml
openmw_button.skin.xml
openmw_font.xml
openmw_windows.skin.xml
Pelagiad.ttf
Run OpenMW
----------
**********
After completing all the steps, run OpenMW and enjoy an empty island. You can now use this setup to start adding your own content and develop your own game using OpenMW. Good luck!
After completing all the steps, run OpenMW and enjoy an empty island. It is not
empty though! It is full of pontential to start making your very own game on the
OpenMW engine. Good luck!
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment