openmw-game-template.rst 3.96 KB
Newer Older
1
2
3
4
####################
OpenMW Game Template
####################

5
6
7
8
9
10
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/>`_.
11
12
13


Installation
14
************
15

16
17
18
19
20
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.
21
22
23


Define paths to .omwgame and data files
24
25
26
27
28
29
30
=======================================

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.
31

32
.. code::
33

34
35
36
    content=template.omwgame
    data="/home/someuser/example-suite/data"
    data="/home/someuser/example-suite"
37

38
39
40
41
42
    
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.
43

44
45
46
47
48
49
50
51
52
.. 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"
53
54
55


Define paths to essential models
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
================================

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


83
84
85
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.
86
87
88


Copying the UI files
89
90
91
92
93
94
====================

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.
95

96
.. code::
97

98
99
100
101
102
    openmw_box.skin.xml
    openmw_button.skin.xml
    openmw_font.xml
    openmw_windows.skin.xml
    Pelagiad.ttf
103
104
105


Run OpenMW
106
**********
107

108
After completing all the steps, run OpenMW and enjoy an empty island. It is not
109
empty though! It is full of potential to start making your very own game on the
110
OpenMW engine. Good luck! 
111