From bd0f8573cdcd316a82934057a3b7e6fe9ba98655 Mon Sep 17 00:00:00 2001 From: Diject Date: Sat, 3 Jan 2026 20:21:13 +0300 Subject: [PATCH] Update README.md --- README.md | 114 ++++++++++++------------------------------------------ 1 file changed, 24 insertions(+), 90 deletions(-) diff --git a/README.md b/README.md index ad3e9b1e19..2fb836b2e4 100644 --- a/README.md +++ b/README.md @@ -1,112 +1,46 @@ OpenMW ====== -OpenMW is an open-source open-world RPG 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. - -* Version: 0.51.0 * License: GPLv3 (see [LICENSE](https://gitlab.com/OpenMW/openmw/-/raw/master/LICENSE) for more information) * Website: https://www.openmw.org -* IRC: #openmw on irc.libera.chat -* Discord: https://discord.gg/bWuqq2e - Font Licenses: * DejaVuLGCSansMono.ttf: custom (see [files/data/fonts/DejaVuFontLicense.txt](https://gitlab.com/OpenMW/openmw/-/raw/master/files/data/fonts/DejaVuFontLicense.txt) for more information) * DemonicLetters.ttf: SIL Open Font License (see [files/data/fonts/DemonicLettersFontLicense.txt](https://gitlab.com/OpenMW/openmw/-/raw/master/files/data/fonts/DemonicLettersFontLicense.txt) for more information) * MysticCards.ttf: SIL Open Font License (see [files/data/fonts/MysticCardsFontLicense.txt](https://gitlab.com/OpenMW/openmw/-/raw/master/files/data/fonts/MysticCardsFontLicense.txt) for more information) -Current Status --------------- +About this fork +---------------- -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/?milestone_title=openmw-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. +This is a fork of OpenMW 0.51 designed for extracting map images from Morrowind. -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. +The tool generates a world height map at a resolution of 32x32 pixels per cell, local map tiles at 256x256 pixels per cell, and a world map composed of these tiles. -Getting Started ---------------- +Usage +----- -* [Official forums](https://forum.openmw.org/) -* [Installation instructions](https://openmw.readthedocs.io/en/latest/manuals/installation/index.html) -* [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) +1. In the `openmw-launcher` (from this fork or any OpenMW >= 0.49), select the content list you want to extract the map from. +2. On the Display tab, it is recommended to set the game to windowed mode with the minimum resolution (640x480) so the extraction can run in the background. Warning: minimizing the game window will pause the process. +3. Run the `openmw` executable from this fork (with or without command-line options) and wait for the generation to complete. -The data path -------------- +When extraction finishes, the message "Map extraction complete." will be shown; at that point, you can close the game. -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). +By default textures are written to `./textures/advanced_world_map/` inside the application directory. -Command line options --------------------- +Note about scripts +------------------ - Syntax: openmw - Allowed options: - --config arg additional config directories - --replace arg settings where the values from the - current source should replace those - from lower-priority sources instead of - being appended - --user-data arg set user data directory (used for - saves, screenshots, etc) - --resources arg (=resources) set resources directory - --help print help message - --version print version information and quit - --data arg (=data) set data directories (later directories - have higher priority) - --data-local arg set local data directory (highest - priority) - --fallback-archive arg (=fallback-archive) - set fallback BSA archives (later - archives have higher priority) - --start arg set initial cell - --content arg content file(s): esm/esp, or - omwgame/omwaddon/omwscripts - --groundcover arg groundcover content file(s): esm/esp, - or omwgame/omwaddon - --no-sound [=arg(=1)] (=0) disable all sounds - --script-all [=arg(=1)] (=0) compile all scripts (excluding dialogue - scripts) at startup - --script-all-dialogue [=arg(=1)] (=0) compile all dialogue scripts at startup - --script-console [=arg(=1)] (=0) enable console-only script - functionality - --script-run arg select a file containing a list of - console commands that is executed on - startup - --script-warn [=arg(=1)] (=1) handling of warnings when compiling - scripts - 0 - ignore warnings - 1 - show warnings but consider script as - correctly compiled anyway - 2 - treat warnings as errors - --load-savegame arg load a save game file on game startup - (specify an absolute filename or a - filename relative to the current - working directory) - --skip-menu [=arg(=1)] (=0) skip main menu on game startup - --new-game [=arg(=1)] (=0) run new game sequence (ignored if - skip-menu=0) - --encoding arg (=win1252) Character encoding used in OpenMW game - messages: +Files with the `.omwscripts` extension are not loaded by this build. If a mod packages `.omwscripts` into other formats, those scripts may not work correctly because many standard API calls are removed. - win1250 - Central and Eastern European - such as Polish, Czech, Slovak, - Hungarian, Slovene, Bosnian, Croatian, - Serbian (Latin script), Romanian and - Albanian languages +Command-line options (fork-specific) +----------------------------------- - win1251 - Cyrillic alphabet such as - Russian, Bulgarian, Serbian Cyrillic - and other languages +--world-map-output="" Directory to save the world map texture. Default: `./textures/advanced_world_map/custom/` +--local-map-output="" Directory to save local map textures. Default: `./textures/advanced_world_map/local/` +--overwrite-maps Allow overwriting existing local map files. By default local maps are not overwritten. +--tilemap-downscale-factor=4 Downscale factor for tilemap generation (must be power of 2). Default: 4. - win1252 - Western European (Latin) - alphabet, used by default - --fallback arg fallback values - --no-grab [=arg(=1)] (=0) Don't grab mouse cursor - --export-fonts [=arg(=1)] (=0) Export Morrowind .fnt fonts to PNG - image and XML file in current directory - --activate-dist arg (=-1) activation distance override - --random-seed arg (=) seed value for random number generator +Notes +----- + +This fork was created for personal use and is not intended for major development. Much of the code in this repository was generated with assistance of an LLM; the author does not know C++ at all.