1
0
Fork 1
mirror of https://github.com/TES3MP/openmw-tes3mp.git synced 2025-01-15 17:49:55 +00:00
openmw-tes3mp/README.md

158 lines
10 KiB
Markdown
Raw Normal View History

2015-01-10 16:36:36 +00:00
OpenMW
======
[![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)
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.
OpenMW also comes with OpenMW-CS, a replacement for Bethesda's Construction Set.
2020-04-07 10:55:17 +00:00
* Version: 0.47.0
* License: GPLv3 (see [LICENSE](https://github.com/OpenMW/openmw/blob/master/LICENSE) for more information)
* Website: https://www.openmw.org
2015-01-10 15:45:20 +00:00
* IRC: #openmw on irc.freenode.net
Font Licenses:
2020-07-26 20:53:46 +00:00
* DejaVuLGCSansMono.ttf: custom (see [files/mygui/DejaVuFontLicense.txt](https://github.com/OpenMW/openmw/blob/master/files/mygui/DejaVuFontLicense.txt) for more information)
Current Status
--------------
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.
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.
Getting Started
2015-01-10 16:36:36 +00:00
---------------
* [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)
* [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)
2015-01-10 15:27:15 +00:00
The data path
2015-01-10 16:36:36 +00:00
-------------
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).
2015-01-10 15:27:15 +00:00
Command line options
2015-01-10 16:36:36 +00:00
--------------------
2012-02-14 08:39:58 +00:00
2015-01-11 12:50:50 +00:00
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)
2015-02-03 12:42:47 +00:00
--data-local arg set local data directory (highest
2015-01-11 12:50:50 +00:00
priority)
--fallback-archive arg (=fallback-archive)
2015-02-03 12:42:47 +00:00
set fallback BSA archives (later
2015-01-11 12:50:50 +00:00
archives have higher priority)
--resources arg (=resources) set resources directory
2015-01-20 14:44:47 +00:00
--start arg set initial cell
2015-02-03 12:42:47 +00:00
--content arg content file(s): esm/esp, or
2015-01-11 12:50:50 +00:00
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
2015-01-20 14:44:47 +00:00
--script-all-dialogue [=arg(=1)] (=0) compile all dialogue scripts at startup
2015-02-03 12:42:47 +00:00
--script-console [=arg(=1)] (=0) enable console-only script
2015-01-11 12:50:50 +00:00
functionality
2015-02-03 12:42:47 +00:00
--script-run arg select a file containing a list of
console commands that is executed on
2015-01-11 12:50:50 +00:00
startup
2015-02-03 12:42:47 +00:00
--script-warn [=arg(=1)] (=1) handling of warnings when compiling
2015-01-11 12:50:50 +00:00
scripts
0 - ignore warning
1 - show warning but consider script as
correctly compiled anyway
2 - treat warnings as errors
2015-01-20 14:44:47 +00:00
--script-blacklist arg ignore the specified script (if the use
of the blacklist is enabled)
--script-blacklist-use [=arg(=1)] (=1)
enable script blacklisting
2015-03-03 10:54:35 +00:00
--load-savegame arg load a save game file on game startup
(specify an absolute filename or a
filename relative to the current
2015-02-04 21:17:30 +00:00
working directory)
2015-01-11 12:50:50 +00:00
--skip-menu [=arg(=1)] (=0) skip main menu on game startup
2015-02-03 12:42:47 +00:00
--new-game [=arg(=1)] (=0) run new game sequence (ignored if
2015-01-11 12:50:50 +00:00
skip-menu=0)
2015-02-03 12:42:47 +00:00
--fs-strict [=arg(=1)] (=0) strict file system handling (no case
2015-01-11 12:50:50 +00:00
folding)
2015-02-03 12:42:47 +00:00
--encoding arg (=win1252) Character encoding used in OpenMW game
2015-01-11 12:50:50 +00:00
messages:
2015-02-03 12:42:47 +00:00
win1250 - Central and Eastern European
such as Polish, Czech, Slovak,
Hungarian, Slovene, Bosnian, Croatian,
Serbian (Latin script), Romanian and
2015-01-11 12:50:50 +00:00
Albanian languages
2015-02-03 12:42:47 +00:00
win1251 - Cyrillic alphabet such as
Russian, Bulgarian, Serbian Cyrillic
2015-01-11 12:50:50 +00:00
and other languages
2015-02-03 12:42:47 +00:00
win1252 - Western European (Latin)
2015-01-11 12:50:50 +00:00
alphabet, used by default
--fallback arg fallback values
--no-grab Don't grab mouse cursor
2015-02-03 12:42:47 +00:00
--export-fonts [=arg(=1)] (=0) Export Morrowind .fnt fonts to PNG
2015-01-20 14:44:47 +00:00
image and XML file in current directory
2015-01-11 12:50:50 +00:00
--activate-dist arg (=-1) activation distance override
--random-seed arg (=<impl defined>) seed value for random number generator
2020-07-05 12:46:58 +00:00
VR
======
This fork is a VR port of openmw using the openxr VR standard.
2020-07-05 13:04:17 +00:00
You can grab the latest binaries/sources under [Releases](https://gitlab.com/madsbuvi/openmw/-/releases)
2020-07-23 07:57:14 +00:00
Or grab a development build from the artifacts of any pipeline of the openxr_vr build on the gitlab.
2020-07-05 12:46:58 +00:00
Current Status
--------------
The VR fork was written on windows with access only to the Oculus Rift headset. Consequentially the current state of the port may have any number of Oculus specific idiosyncrasies, only has default bindings for the Oculus Touch controllers, and will not compile on linux.
Users with the vive, the index, or any other openxr supporting VR headsets are encourage to suggest or contribute bindings for their respective headsets.
Compatibility with general mods should be high, but this has not been thoroughly tested. Shaders have not been tested at all and may spawn spiders inside your headset.
Installation (openmw vr)
------------------------
2020-07-21 11:38:28 +00:00
Installing the VR port is similar to openmw, but you should manually edit settings.cfg under my games/openmw to input your real life height under the VR section so the game can correctly scale you.
2020-07-05 12:46:58 +00:00
Reference VR settings exist in settings-default.cfg.
Installation (OpenXR)
---------------------
If openxr fails to load, it's nonetheless possible your VR headset offers a preview release of openxr.
[This article](https://uploadvr.com/oculus-rift-basic-openxr-support/) from uploadvr explains how to enable the oculus preview on windows.
Note that although the article states you need to opt into public test channels, this is no longer necessary. And you no longer need to write your own json file, you can point to the one present in the oculus' runtime's directory.
2020-07-05 13:04:17 +00:00
Building
--------
2020-07-21 11:38:28 +00:00
The fork should build with the same instructions as building openmw.
2020-07-05 13:14:45 +00:00
Oculus Touch controls
---------------------
[Here](https://imgur.com/a/PNgfLGz) is a simple graphic showing the default bindings for the oculus touch controllers.
Ambiguous buttons souch as Y and B fire the alternative action when you hold instead of tap.
The R-Trigger by default uses the readied tool/spell, but activates objects and actors instead when Pointer mode is active.
While in menus the A and B keys, and the thumbsticks change behaviour to navigate menus. But past the main menu you can navigate using point and click.
Known Issues
------------
- The loading screen does not show any backgrounds
- Movies play upside down
- Cannot point and click in the main menu, you must use the right hand controller as explained above
2020-10-18 21:59:17 +00:00
- Performance is shite, you will likely have to play without fancy shadows or water shaders.
- Audio is not automatically captured.
- Work around this by adding the line `device = OpenAL Soft on Headphones (2- Rift Audio)` under `[Sound]` in settings.cfg. Replace the device string with the string corresponding to your device. You can find a list of device strings in openmw.log after running it once.