README.md 7.4 KB
Newer Older
scrawl's avatar
scrawl committed
1 2
OpenMW
======
3

4
[![Build Status](https://api.travis-ci.org/OpenMW/openmw.svg)](https://travis-ci.org/OpenMW/openmw) [![Build status](https://ci.appveyor.com/api/projects/status/github/openmw/openmw?svg=true)](https://ci.appveyor.com/project/psi29a/openmw)  [![Coverity Scan Build Status](https://scan.coverity.com/projects/3740/badge.svg)](https://scan.coverity.com/projects/3740) [![pipeline status](https://gitlab.com/OpenMW/openmw/badges/master/pipeline.svg)](https://gitlab.com/OpenMW/openmw/commits/master)
5

6
OpenMW is an open-source game engine that supports playing Morrowind by Bethesda Softworks. You need to own the game for OpenMW to play Morrowind.
scrawl's avatar
scrawl committed
7

8
OpenMW also comes with OpenMW-CS, a replacement for Bethesda's Construction Set.
9

10
* Version: 0.46.0
Miloslav Číž's avatar
Miloslav Číž committed
11
* License: GPLv3 (see [LICENSE](https://github.com/OpenMW/openmw/blob/master/LICENSE) for more information)
12
* Website: https://www.openmw.org
scrawl's avatar
scrawl committed
13
* IRC: #openmw on irc.freenode.net
14

15
Font Licenses:
Miloslav Číž's avatar
Miloslav Číž committed
16
* DejaVuLGCSansMono.ttf: custom (see [files/mygui/DejaVu Font License.txt](https://github.com/OpenMW/openmw/blob/master/files/mygui/DejaVu%20Font%20License.txt) for more information)
17

scrawl's avatar
scrawl committed
18 19 20
Current Status
--------------

21
The main quests in Morrowind, Tribunal and Bloodmoon are all completable. Some issues with side quests are to be expected (but rare). Check the [bug tracker](https://gitlab.com/OpenMW/openmw/issues?label_name%5B%5D=1.0) for a list of issues we need to resolve before the "1.0" release. Even before the "1.0" release however, OpenMW boasts some new [features](https://wiki.openmw.org/index.php?title=Features), such as improved graphics and user interfaces. 
scrawl's avatar
scrawl committed
22 23 24

Pre-existing modifications created for the original Morrowind engine can be hit-and-miss. The OpenMW script compiler performs more thorough error-checking than Morrowind does, meaning that a mod created for Morrowind may not necessarily run in OpenMW. Some mods also rely on quirky behaviour or engine bugs in order to work. We are considering such compatibility issues on a case-by-case basis - in some cases adding a workaround to OpenMW may be feasible, in other cases fixing the mod will be the only option. If you know of any mods that work or don't work, feel free to add them to the [Mod status](https://wiki.openmw.org/index.php?title=Mod_status) wiki page.

25
Getting Started
scrawl's avatar
scrawl committed
26
---------------
27 28 29 30 31 32

* [Official forums](https://forum.openmw.org/)
* [Installation instructions](https://wiki.openmw.org/index.php?title=Installation_Instructions)
* [Build from source](https://wiki.openmw.org/index.php?title=Development_Environment_Setup)
* [Testing the game](https://wiki.openmw.org/index.php?title=Testing)
* [How to contribute](https://wiki.openmw.org/index.php?title=Contribution_Wanted)
33 34
* [Report a bug](https://gitlab.com/OpenMW/openmw/issues) - read the [guidelines](https://wiki.openmw.org/index.php?title=Bug_Reporting_Guidelines) before submitting your first bug!
* [Known issues](https://gitlab.com/OpenMW/openmw/issues?label_name%5B%5D=Bug)
35

scrawl's avatar
scrawl committed
36
The data path
scrawl's avatar
scrawl committed
37
-------------
38

39
The data path tells OpenMW where to find your Morrowind files. If you run the launcher, OpenMW should be able to pick up the location of these files on its own, if both Morrowind and OpenMW are installed properly (installing Morrowind under WINE is considered a proper install).
40

scrawl's avatar
scrawl committed
41
Command line options
scrawl's avatar
scrawl committed
42
--------------------
Marc Zinnschlag's avatar
Marc Zinnschlag committed
43

scrawl's avatar
scrawl committed
44 45 46 47 48 49
    Syntax: openmw <options>
    Allowed options:
      --help                                print help message
      --version                             print version information and quit
      --data arg (=data)                    set data directories (later directories
                                            have higher priority)
50
      --data-local arg                      set local data directory (highest
scrawl's avatar
scrawl committed
51 52
                                            priority)
      --fallback-archive arg (=fallback-archive)
53
                                            set fallback BSA archives (later
scrawl's avatar
scrawl committed
54 55
                                            archives have higher priority)
      --resources arg (=resources)          set resources directory
56
      --start arg                           set initial cell
57
      --content arg                         content file(s): esm/esp, or
scrawl's avatar
scrawl committed
58 59 60 61 62
                                            omwgame/omwaddon
      --no-sound [=arg(=1)] (=0)            disable all sounds
      --script-verbose [=arg(=1)] (=0)      verbose script output
      --script-all [=arg(=1)] (=0)          compile all scripts (excluding dialogue
                                            scripts) at startup
63
      --script-all-dialogue [=arg(=1)] (=0) compile all dialogue scripts at startup
64
      --script-console [=arg(=1)] (=0)      enable console-only script
scrawl's avatar
scrawl committed
65
                                            functionality
66 67
      --script-run arg                      select a file containing a list of
                                            console commands that is executed on
scrawl's avatar
scrawl committed
68
                                            startup
69
      --script-warn [=arg(=1)] (=1)         handling of warnings when compiling
scrawl's avatar
scrawl committed
70 71 72 73 74
                                            scripts
                                            0 - ignore warning
                                            1 - show warning but consider script as
                                            correctly compiled anyway
                                            2 - treat warnings as errors
75 76 77 78
      --script-blacklist arg                ignore the specified script (if the use
                                            of the blacklist is enabled)
      --script-blacklist-use [=arg(=1)] (=1)
                                            enable script blacklisting
Marc Zinnschlag's avatar
Marc Zinnschlag committed
79 80 81
      --load-savegame arg                   load a save game file on game startup
                                            (specify an absolute filename or a
                                            filename relative to the current
82
                                            working directory)
scrawl's avatar
scrawl committed
83
      --skip-menu [=arg(=1)] (=0)           skip main menu on game startup
84
      --new-game [=arg(=1)] (=0)            run new game sequence (ignored if
scrawl's avatar
scrawl committed
85
                                            skip-menu=0)
86
      --fs-strict [=arg(=1)] (=0)           strict file system handling (no case
scrawl's avatar
scrawl committed
87
                                            folding)
88
      --encoding arg (=win1252)             Character encoding used in OpenMW game
scrawl's avatar
scrawl committed
89
                                            messages:
90 91 92 93 94

                                            win1250 - Central and Eastern European
                                            such as Polish, Czech, Slovak,
                                            Hungarian, Slovene, Bosnian, Croatian,
                                            Serbian (Latin script), Romanian and
scrawl's avatar
scrawl committed
95
                                            Albanian languages
96 97 98

                                            win1251 - Cyrillic alphabet such as
                                            Russian, Bulgarian, Serbian Cyrillic
scrawl's avatar
scrawl committed
99
                                            and other languages
100 101

                                            win1252 - Western European (Latin)
scrawl's avatar
scrawl committed
102 103 104
                                            alphabet, used by default
      --fallback arg                        fallback values
      --no-grab                             Don't grab mouse cursor
105
      --export-fonts [=arg(=1)] (=0)        Export Morrowind .fnt fonts to PNG
106
                                            image and XML file in current directory
scrawl's avatar
scrawl committed
107
      --activate-dist arg (=-1)             activation distance override