From c5f5984c098083b62ce3e9d6ba9e6e63b84829f1 Mon Sep 17 00:00:00 2001 From: Ryan Tucker Date: Sat, 16 Jun 2018 14:44:49 -0700 Subject: [PATCH] Started migrating installation guide from the wiki. Fixed a bunch of errors that popped up on my local build. --- docs/source/manuals/index.rst | 1 + docs/source/manuals/installation/index.rst | 11 ++++ .../installation/install-game-files.rst | 5 ++ .../manuals/installation/install-openmw.rst | 63 +++++++++++++++++++ .../manuals/openmw-cs}/record-filters.rst | 2 +- .../manuals/openmw-cs}/record-types.rst | 0 .../manuals/openmw-cs}/tables.rst | 0 docs/source/manuals/openmw-cs/tour.rst | 2 +- .../reference/modding/settings/cells.rst | 2 +- .../reference/modding/settings/saves.rst | 2 +- 10 files changed, 84 insertions(+), 4 deletions(-) create mode 100644 docs/source/manuals/installation/index.rst create mode 100644 docs/source/manuals/installation/install-game-files.rst create mode 100644 docs/source/manuals/installation/install-openmw.rst rename docs/{cs-manual/source => source/manuals/openmw-cs}/record-filters.rst (99%) rename docs/{cs-manual/source => source/manuals/openmw-cs}/record-types.rst (100%) rename docs/{cs-manual/source => source/manuals/openmw-cs}/tables.rst (100%) diff --git a/docs/source/manuals/index.rst b/docs/source/manuals/index.rst index 2bf1fff5e..e6f0cbef2 100644 --- a/docs/source/manuals/index.rst +++ b/docs/source/manuals/index.rst @@ -5,3 +5,4 @@ User Manuals :maxdepth: 2 openmw-cs/index + installation/index diff --git a/docs/source/manuals/installation/index.rst b/docs/source/manuals/installation/index.rst new file mode 100644 index 000000000..f22e77449 --- /dev/null +++ b/docs/source/manuals/installation/index.rst @@ -0,0 +1,11 @@ +Installation Guide +################## + +In order to use OpenMW, you must install both the engine and the game files for a compatible game. + +.. toctree:: + :maxdepth: 2 + + install-openmw + install-game-files + diff --git a/docs/source/manuals/installation/install-game-files.rst b/docs/source/manuals/installation/install-game-files.rst new file mode 100644 index 000000000..11c746f44 --- /dev/null +++ b/docs/source/manuals/installation/install-game-files.rst @@ -0,0 +1,5 @@ +================== +Install Game Files +================== + +Coming Soon... \ No newline at end of file diff --git a/docs/source/manuals/installation/install-openmw.rst b/docs/source/manuals/installation/install-openmw.rst new file mode 100644 index 000000000..fab00ab9b --- /dev/null +++ b/docs/source/manuals/installation/install-openmw.rst @@ -0,0 +1,63 @@ +============== +Install OpenMW +============== + +The (easier) Binary Way +======================= + +If you're not sure what any of the different methods mean, you should probably stick to this one. +Simply download the latest version for your operating system from +`github.com/OpenMW/openmw/releases `_ +and run the install package once downloaded. It's now installed! + + .. note:: + There is no need to uninstall previous versions + as OpenMW automatically installs into a separate directory for each new version. + Your saves and configuration are compatible and accessible between versions. + +The (bleeding edge) Source Way +============================== + +Visit the `Development Environment Setup `_ +section of the Wiki for detailed instructions on how to build the engine. + +The Ubuntu Way +============== + +A `Launchpad PPA `_ is available. +Add it and install OpenMW:: + + $ sudo add-apt-repository ppa:openmw/openmw + $ sudo apt-get update + $ sudo apt-get install openmw openmw-launcher + +.. note:: + OpenMW-CS must be installed separately by typing:: + + $ sudo apt-get install openmw-cs + +The Arch Linux Way +================== + +The binary package is available in the official [community] Repositories. +To install, simply run the following as root (or in sudo):: + + # pacman -S openmw + +The Void Linux Way +================== + +The binary package is available in the official Repository +To install simply run the following as root (or in sudo):: + + # xbps-install openmw + +The Debian Way +============== + +OpenMW is available from the unstable (sid) repository of Debian contrib +and can be easily installed if you are using testing or unstable. +However, it depends on several packages which are not in stable, +so it is not possible to install OpenMW in Wheezy without creating a FrankenDebian. +This is not recommended or supported. + diff --git a/docs/cs-manual/source/record-filters.rst b/docs/source/manuals/openmw-cs/record-filters.rst similarity index 99% rename from docs/cs-manual/source/record-filters.rst rename to docs/source/manuals/openmw-cs/record-filters.rst index 3379f557f..a579d8dd8 100644 --- a/docs/cs-manual/source/record-filters.rst +++ b/docs/source/manuals/openmw-cs/record-filters.rst @@ -144,7 +144,7 @@ Writing expressions The syntax for expressions is as follows: -.. code-block:: +.. code:: () diff --git a/docs/cs-manual/source/record-types.rst b/docs/source/manuals/openmw-cs/record-types.rst similarity index 100% rename from docs/cs-manual/source/record-types.rst rename to docs/source/manuals/openmw-cs/record-types.rst diff --git a/docs/cs-manual/source/tables.rst b/docs/source/manuals/openmw-cs/tables.rst similarity index 100% rename from docs/cs-manual/source/tables.rst rename to docs/source/manuals/openmw-cs/tables.rst diff --git a/docs/source/manuals/openmw-cs/tour.rst b/docs/source/manuals/openmw-cs/tour.rst index 83b7aae27..e45b6164f 100644 --- a/docs/source/manuals/openmw-cs/tour.rst +++ b/docs/source/manuals/openmw-cs/tour.rst @@ -294,7 +294,7 @@ Increase the Count to 1. Save the addon, then test to ensure it works - e.g. start a new game and lockpick the chest. Placing in plain sight -===================== +====================== Let's hide the Ring of Night vision in the cabin of the [Ancient Shipwreck] (https://en.uesp.net/wiki/Morrowind:Ancient_Shipwreck), a derelict vessel diff --git a/docs/source/reference/modding/settings/cells.rst b/docs/source/reference/modding/settings/cells.rst index 171ddb7c8..43a984ca7 100644 --- a/docs/source/reference/modding/settings/cells.rst +++ b/docs/source/reference/modding/settings/cells.rst @@ -188,7 +188,7 @@ target framerate Affects the time to be set aside each frame for graphics preloading operations. The game will distribute the preloading over several frames so as to not go under the specified framerate. For best results, set this value to the monitor's refresh rate. If you still experience stutters on turning around, you can try a lower value, although the framerate during loading will suffer a bit in that case. pointers cache size ------------------- +------------------- :Type: integer :Range: >0 diff --git a/docs/source/reference/modding/settings/saves.rst b/docs/source/reference/modding/settings/saves.rst index fdb25fb79..5add36c0c 100644 --- a/docs/source/reference/modding/settings/saves.rst +++ b/docs/source/reference/modding/settings/saves.rst @@ -34,7 +34,7 @@ for each saved game in the Load menu. Currently, the counter includes time spent This setting can only be configured by editing the settings configuration file. max quicksaves ----------- +-------------- :Type: integer :Range: >0