Merge branch 'rtd' into 'master'

Show OpenMW version and Lua API revision in documentation

Closes #6149

See merge request OpenMW/openmw!3382

CHANGELOG.md

@@ -72,6 +72,7 @@
     Bug #7553: Faction reaction loading is incorrect
     Feature #3537: Shader-based water ripples
     Feature #5492: Let rain and snow collide with statics
+    Feature #6149: Dehardcode Lua API_REVISION
     Feature #6447: Add LOD support to Object Paging
     Feature #6491: Add support for Qt6
     Feature #6556: Lua API for sounds

CMakeLists.txt

@@ -71,6 +71,7 @@ message(STATUS "Configuring OpenMW...")
 set(OPENMW_VERSION_MAJOR 0)
 set(OPENMW_VERSION_MINOR 49)
 set(OPENMW_VERSION_RELEASE 0)
+set(OPENMW_LUA_API_REVISION 45)
 
 set(OPENMW_VERSION_COMMITHASH "")
 set(OPENMW_VERSION_TAGHASH "")
@@ -1041,7 +1042,6 @@ elseif(NOT APPLE)
         # Install global configuration files
         INSTALL(FILES "${INSTALL_SOURCE}/defaults.bin" DESTINATION "${SYSCONFDIR}" COMPONENT "openmw")
         INSTALL(FILES "${INSTALL_SOURCE}/openmw.cfg.install" DESTINATION "${SYSCONFDIR}" RENAME "openmw.cfg" COMPONENT "openmw")
-        INSTALL(FILES "${INSTALL_SOURCE}/resources/version" DESTINATION "${SYSCONFDIR}" COMPONENT "openmw")
         INSTALL(FILES "${INSTALL_SOURCE}/gamecontrollerdb.txt" DESTINATION "${SYSCONFDIR}" COMPONENT "openmw")
 
         IF(BUILD_OPENCS)

apps/bulletobjecttool/main.cpp

@@ -146,8 +146,7 @@ namespace
         config.filterOutNonExistingPaths(dataDirs);
 
         const auto resDir = variables["resources"].as<Files::MaybeQuotedPath>();
-        const auto v = Version::getOpenmwVersion(resDir);
-        Log(Debug::Info) << v.describe();
+        Log(Debug::Info) << Version::getOpenmwVersionDescription();
         dataDirs.insert(dataDirs.begin(), resDir / "vfs");
         const auto fileCollections = Files::Collections(dataDirs);
         const auto archives = variables["fallback-archive"].as<StringsVector>();

apps/launcher/maindialog.cpp

@@ -174,14 +174,13 @@ Launcher::FirstRunDialogResult Launcher::MainDialog::showFirstRunDialog()
 void Launcher::MainDialog::setVersionLabel()
 {
     // Add version information to bottom of the window
-    Version::Version v = Version::getOpenmwVersion(mGameSettings.value("resources").toUtf8().constData());
-
-    QString revision(QString::fromUtf8(v.mCommitHash.c_str()));
-    QString tag(QString::fromUtf8(v.mTagHash.c_str()));
+    QString revision(QString::fromUtf8(Version::getCommitHash().data(), Version::getCommitHash().size()));
+    QString tag(QString::fromUtf8(Version::getTagHash().data(), Version::getTagHash().size()));
 
     versionLabel->setTextInteractionFlags(Qt::TextSelectableByMouse);
-    if (!v.mVersion.empty() && (revision.isEmpty() || revision == tag))
-        versionLabel->setText(tr("OpenMW %1 release").arg(QString::fromUtf8(v.mVersion.c_str())));
+    if (!Version::getVersion().empty() && (revision.isEmpty() || revision == tag))
+        versionLabel->setText(
+            tr("OpenMW %1 release").arg(QString::fromUtf8(Version::getVersion().data(), Version::getVersion().size())));
     else
         versionLabel->setText(tr("OpenMW development (%1)").arg(revision.left(10)));
 

apps/navmeshtool/main.cpp

@@ -165,8 +165,7 @@ namespace NavMeshTool
             config.filterOutNonExistingPaths(dataDirs);
 
             const auto resDir = variables["resources"].as<Files::MaybeQuotedPath>();
-            Version::Version v = Version::getOpenmwVersion(resDir);
-            Log(Debug::Info) << v.describe();
+            Log(Debug::Info) << Version::getOpenmwVersionDescription();
             dataDirs.insert(dataDirs.begin(), resDir / "vfs");
             const auto fileCollections = Files::Collections(dataDirs);
             const auto archives = variables["fallback-archive"].as<StringsVector>();

apps/opencs/view/doc/view.cpp

@@ -774,7 +774,7 @@ void CSVDoc::View::tutorial()
 void CSVDoc::View::infoAbout()
 {
     // Get current OpenMW version
-    QString versionInfo = (Version::getOpenmwVersionDescription(mDocument->getResourceDir()) +
+    QString versionInfo = (Version::getOpenmwVersionDescription() +
 #if defined(__x86_64__) || defined(_M_X64)
         " (64-bit)")
                               .c_str();

apps/openmw/engine.cpp

@@ -423,6 +423,9 @@ void OMW::Engine::addArchive(const std::string& archive)
 void OMW::Engine::setResourceDir(const std::filesystem::path& parResDir)
 {
     mResDir = parResDir;
+    if (!Version::checkResourcesVersion(mResDir))
+        Log(Debug::Error) << "Resources dir " << mResDir
+                          << " doesn't match OpenMW binary, the game may work incorrectly.";
 }
 
 // Set start cell name
@@ -723,7 +726,7 @@ void OMW::Engine::prepareEngine()
 
     mWindowManager = std::make_unique<MWGui::WindowManager>(mWindow, mViewer, guiRoot, mResourceSystem.get(),
         mWorkQueue.get(), mCfgMgr.getLogPath(), mScriptConsoleMode, mTranslationDataStorage, mEncoding,
-        Version::getOpenmwVersionDescription(mResDir), shadersSupported, mCfgMgr);
+        Version::getOpenmwVersionDescription(), shadersSupported, mCfgMgr);
     mEnvironment.setWindowManager(*mWindowManager);
 
     mInputManager = std::make_unique<MWInput::InputManager>(mWindow, mViewer, mScreenCaptureHandler,

apps/openmw/main.cpp

@@ -58,27 +58,14 @@ bool parseOptions(int argc, char** argv, OMW::Engine& engine, Files::Configurati
 
     if (variables.count("version"))
     {
-        cfgMgr.readConfiguration(variables, desc, true);
-
-        Version::Version v
-            = Version::getOpenmwVersion(variables["resources"]
-                                            .as<Files::MaybeQuotedPath>()
-                                            .u8string()); // This call to u8string is redundant, but required to build
-                                                          // on MSVC 14.26 due to implementation bugs.
-        getRawStdout() << v.describe() << std::endl;
+        getRawStdout() << Version::getOpenmwVersionDescription() << std::endl;
         return false;
     }
 
     cfgMgr.readConfiguration(variables, desc);
 
     setupLogging(cfgMgr.getLogPath(), "OpenMW");
-
-    Version::Version v
-        = Version::getOpenmwVersion(variables["resources"]
-                                        .as<Files::MaybeQuotedPath>()
-                                        .u8string()); // This call to u8string is redundant, but required to build on
-                                                      // MSVC 14.26 due to implementation bugs.
-    Log(Debug::Info) << v.describe();
+    Log(Debug::Info) << Version::getOpenmwVersionDescription();
 
     Settings::Manager::load(cfgMgr);
 

apps/openmw/mwlua/luabindings.cpp

@@ -15,6 +15,7 @@
 #include <components/lua/luastate.hpp>
 #include <components/lua/utilpackage.hpp>
 #include <components/misc/strings/lower.hpp>
+#include <components/version/version.hpp>
 
 #include "../mwbase/environment.hpp"
 #include "../mwbase/statemanager.hpp"
@@ -128,7 +129,7 @@ namespace MWLua
     {
         auto* lua = context.mLua;
         sol::table api(lua->sol(), sol::create);
-        api["API_REVISION"] = 44;
+        api["API_REVISION"] = Version::getLuaApiRevision(); // specified in CMakeLists.txt
         api["quit"] = [lua]() {
             Log(Debug::Warning) << "Quit requested by a Lua script.\n" << lua->debugTraceback();
             MWBase::Environment::get().getStateManager()->requestQuit();

cmake/GitVersion.cmake

@@ -1,6 +1,6 @@
 execute_process (
     COMMAND ${GIT_EXECUTABLE} rev-list --tags --max-count=1
-    WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
+    WORKING_DIRECTORY ${OpenMW_SOURCE_DIR}
     RESULT_VARIABLE EXITCODE1
     OUTPUT_VARIABLE TAGHASH
     OUTPUT_STRIP_TRAILING_WHITESPACE
@@ -8,7 +8,7 @@ execute_process (
 
 execute_process (
     COMMAND ${GIT_EXECUTABLE} rev-parse HEAD
-    WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
+    WORKING_DIRECTORY ${OpenMW_SOURCE_DIR}
     RESULT_VARIABLE EXITCODE2
     OUTPUT_VARIABLE COMMITHASH
     OUTPUT_STRIP_TRAILING_WHITESPACE)
@@ -28,4 +28,5 @@ endif ()
 
 include(${MACROSFILE})
 
-configure_resource_file(${VERSION_IN_FILE} ${VERSION_FILE_PATH_BASE} ${VERSION_FILE_PATH_RELATIVE})
+configure_resource_file(${VERSION_RESOURCE_FILE_IN} ${OpenMW_BINARY_DIR} ${VERSION_RESOURCE_FILE_RELATIVE})
+configure_file("${OpenMW_SOURCE_DIR}/${VERSION_CPP_FILE}.in" "${OpenMW_BINARY_DIR}/${VERSION_CPP_FILE}")

components/CMakeLists.txt

@@ -6,21 +6,26 @@ if(APPLE)
 endif(APPLE)
 
 # Version file
-set (VERSION_IN_FILE "${OpenMW_SOURCE_DIR}/files/version.in")
-set (VERSION_FILE_PATH_BASE "${OpenMW_BINARY_DIR}")
-set (VERSION_FILE_PATH_RELATIVE resources/version)
+set (VERSION_RESOURCE_FILE_IN "${OpenMW_SOURCE_DIR}/files/version.in")
+set (VERSION_RESOURCE_FILE_RELATIVE "resources/version")
+set (VERSION_CPP_FILE "components/version/version.cpp")
+
 if (GIT_CHECKOUT)
     get_generator_is_multi_config(multi_config)
-    add_custom_target (git-version
+    add_custom_command (
+       OUTPUT "${OpenMW_BINARY_DIR}/${VERSION_CPP_FILE}"
+       DEPENDS "${OpenMW_SOURCE_DIR}/${VERSION_CPP_FILE}.in"
        COMMAND ${CMAKE_COMMAND}
             -DGIT_EXECUTABLE=${GIT_EXECUTABLE}
-            -DPROJECT_SOURCE_DIR=${PROJECT_SOURCE_DIR}
-            -DVERSION_IN_FILE=${VERSION_IN_FILE}
-            -DVERSION_FILE_PATH_BASE=${VERSION_FILE_PATH_BASE}
-            -DVERSION_FILE_PATH_RELATIVE=${VERSION_FILE_PATH_RELATIVE}
+            -DOpenMW_SOURCE_DIR=${OpenMW_SOURCE_DIR}
+            -DOpenMW_BINARY_DIR=${OpenMW_BINARY_DIR}
+            -DVERSION_RESOURCE_FILE_IN=${VERSION_RESOURCE_FILE_IN}
+            -DVERSION_RESOURCE_FILE_RELATIVE=${VERSION_RESOURCE_FILE_RELATIVE}
+            -DVERSION_CPP_FILE=${VERSION_CPP_FILE}
             -DOPENMW_VERSION_MAJOR=${OPENMW_VERSION_MAJOR}
             -DOPENMW_VERSION_MINOR=${OPENMW_VERSION_MINOR}
             -DOPENMW_VERSION_RELEASE=${OPENMW_VERSION_RELEASE}
+            -DOPENMW_LUA_API_REVISION=${OPENMW_LUA_API_REVISION}
             -DOPENMW_VERSION=${OPENMW_VERSION}
             -DMACROSFILE=${CMAKE_SOURCE_DIR}/cmake/OpenMWMacros.cmake
             "-DCMAKE_CONFIGURATION_TYPES=${CMAKE_CONFIGURATION_TYPES}"
@@ -28,9 +33,12 @@ if (GIT_CHECKOUT)
             -P ${CMAKE_CURRENT_SOURCE_DIR}/../cmake/GitVersion.cmake
             VERBATIM)
 else (GIT_CHECKOUT)
-    configure_resource_file(${VERSION_IN_FILE} ${VERSION_FILE_PATH_BASE} ${VERSION_FILE_PATH_RELATIVE})
+    configure_resource_file(${VERSION_RESOURCE_FILE_IN} ${OpenMW_BINARY_DIR} ${VERSION_RESOURCE_FILE_RELATIVE})
+    configure_file("${OpenMW_SOURCE_DIR}/${VERSION_CPP_FILE}.in" "${OpenMW_BINARY_DIR}/${VERSION_CPP_FILE}")
 endif (GIT_CHECKOUT)
 
+list (APPEND COMPONENT_FILES "${OpenMW_BINARY_DIR}/${VERSION_CPP_FILE}")
+
 # source files
 
 add_component_dir (lua
@@ -551,10 +559,6 @@ if (USE_QT)
     endif()
 endif()
 
-if (GIT_CHECKOUT)
-    add_dependencies (components git-version)
-endif (GIT_CHECKOUT)
-
 if (OSG_STATIC AND CMAKE_SYSTEM_NAME MATCHES "Linux")
     find_package(X11 REQUIRED COMPONENTS Xinerama Xrandr)
     target_link_libraries(components ${CMAKE_DL_LIBS} X11::X11 X11::Xinerama X11::Xrandr)

components/version/version.cpp

@@ -1,38 +0,0 @@
-#include "version.hpp"
-
-#include <filesystem>
-#include <fstream>
-
-namespace Version
-{
-
-    Version getOpenmwVersion(const std::filesystem::path& resourcePath)
-    {
-        std::ifstream stream(resourcePath / "version");
-
-        Version v;
-        std::getline(stream, v.mVersion);
-        std::getline(stream, v.mCommitHash);
-        std::getline(stream, v.mTagHash);
-        return v;
-    }
-
-    std::string Version::describe() const
-    {
-        std::string str = "OpenMW version " + mVersion;
-        std::string rev = mCommitHash;
-        if (!rev.empty())
-        {
-            rev = rev.substr(0, 10);
-            str += "\nRevision: " + rev;
-        }
-        return str;
-    }
-
-    std::string getOpenmwVersionDescription(const std::filesystem::path& resourcePath)
-    {
-        Version v = getOpenmwVersion(resourcePath);
-        return v.describe();
-    }
-
-}

components/version/version.cpp.in

@@ -0,0 +1,50 @@
+#include <components/version/version.hpp>
+
+#include <filesystem>
+#include <fstream>
+
+namespace Version
+{
+    std::string_view getVersion()
+    {
+        return "@OPENMW_VERSION@";
+    }
+
+    std::string_view getCommitHash()
+    {
+        return "@OPENMW_VERSION_COMMITHASH@";
+    }
+
+    std::string_view getTagHash()
+    {
+        return "@OPENMW_VERSION_TAGHASH@";
+    }
+
+    int getLuaApiRevision()
+    {
+        return @OPENMW_LUA_API_REVISION@;
+    }
+
+    std::string getOpenmwVersionDescription()
+    {
+        std::string str = "OpenMW version ";
+        str += getVersion();
+        if (!getCommitHash().empty())
+        {
+            str += "\nRevision: ";
+            str += getCommitHash().substr(0, 10);
+        }
+        return str;
+    }
+
+    bool checkResourcesVersion(const std::filesystem::path& resourcePath)
+    {
+        std::ifstream stream(resourcePath / "version");
+        std::string version, commitHash, tagHash;
+        std::getline(stream, version);
+        std::getline(stream, commitHash);
+        std::getline(stream, tagHash);
+        return getVersion() == version && getCommitHash() == commitHash && getTagHash() == tagHash;
+    }
+
+}

components/version/version.hpp

@@ -3,25 +3,19 @@
 
 #include <filesystem>
 #include <string>
+#include <string_view>
 
 namespace Version
 {
+    std::string_view getVersion();
+    std::string_view getCommitHash();
+    std::string_view getTagHash();
+    int getLuaApiRevision();
 
-    struct Version
-    {
-        std::string mVersion;
-        std::string mCommitHash;
-        std::string mTagHash;
-
-        std::string describe() const;
-    };
-
-    /// Read OpenMW version from the version file located in resourcePath.
-    Version getOpenmwVersion(const std::filesystem::path& resourcePath);
-
-    /// Helper function to getOpenmwVersion and describe() it
-    std::string getOpenmwVersionDescription(const std::filesystem::path& resourcePath);
+    // Prepares string that contains version and commit hash.
+    std::string getOpenmwVersionDescription();
 
+    bool checkResourcesVersion(const std::filesystem::path& resourcePath);
 }
 
 #endif // VERSION_HPP

docs/source/conf.py

@@ -66,6 +66,7 @@ copyright = u'2023, OpenMW Team'
 # The full version, including alpha/beta/rc tags.
 
 release = version = "UNRELEASED"
+luaApiRevision = "UNKNOWN"
 
 try:
     cmake_raw = open(project_root+'/CMakeLists.txt', 'r').read()
@@ -76,11 +77,18 @@ try:
         release = version = '.'.join((majorVersionMatch.group(1),
                                      minorVersionMatch.group(1),
                                      releaseVersionMatch.group(1)))
+    luaApiRevisionMatch = re.search('set\(OPENMW_LUA_API_REVISION (\d+)\)', cmake_raw)
+    if luaApiRevisionMatch:
+        luaApiRevision = luaApiRevisionMatch.group(1)
 
 except Exception as ex:
     print("WARNING: Version will be set to '{0}' because: '{1}'.".format(release, str(ex)))
     import traceback; traceback.print_exc()
 
+rst_prolog = f"""
+.. |luaApiRevision| replace:: {luaApiRevision}
+"""
+
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #language = cpp

docs/source/reference/lua-scripting/aipackages.rst

@@ -1,6 +1,8 @@
 Built-in AI packages
 ====================
 
+.. include:: version.rst
+
 Starting an AI package
 ----------------------
 

docs/source/reference/lua-scripting/api.rst

@@ -2,6 +2,8 @@
 Lua API reference
 #################
 
+.. include:: version.rst
+
 .. toctree::
     :hidden:
 

docs/source/reference/lua-scripting/engine_handlers.rst

@@ -1,6 +1,8 @@
 Engine handlers reference
 =========================
 
+.. include:: version.rst
+
 Engine handler is a function defined by a script, that can be called by the engine.
 
 

docs/source/reference/lua-scripting/events.rst

@@ -1,6 +1,8 @@
 Built-in events
 ===============
 
+.. include:: version.rst
+
 Actor events
 ------------
 

docs/source/reference/lua-scripting/index.rst

@@ -2,8 +2,10 @@
 OpenMW Lua scripting
 ####################
 
-.. warning::
-    OpenMW Lua scripting is in early stage of development. Also note that OpenMW Lua is not compatible with MWSE.
+.. note::
+    OpenMW Lua is not compatible with MWSE.
+
+.. include:: version.rst
 
 .. toctree::
     :caption: Table of Contents

docs/source/reference/lua-scripting/interface_activation.rst

@@ -1,6 +1,8 @@
 Interface Activation
 ====================
 
+.. include:: version.rst
+
 .. raw:: html
    :file: generated_html/scripts_omw_activationhandlers.html
 

docs/source/reference/lua-scripting/interface_ai.rst

@@ -1,6 +1,8 @@
 Interface AI
 ============
 
+.. include:: version.rst
+
 .. raw:: html
    :file: generated_html/scripts_omw_ai.html
 

docs/source/reference/lua-scripting/interface_camera.rst

@@ -1,6 +1,8 @@
 Interface Camera
 ================
 
+.. include:: version.rst
+
 .. raw:: html
    :file: generated_html/scripts_omw_camera_camera.html
 

docs/source/reference/lua-scripting/interface_controls.rst

@@ -1,6 +1,8 @@
 Interface Controls
 ==================
 
+.. include:: version.rst
+
 .. raw:: html
    :file: generated_html/scripts_omw_playercontrols.html
 

docs/source/reference/lua-scripting/interface_mwui.rst

@@ -1,6 +1,8 @@
 Interface MWUI
 ==============
 
+.. include:: version.rst
+
 .. raw:: html
    :file: generated_html/scripts_omw_mwui_init.html
 

docs/source/reference/lua-scripting/interface_settings.rst

@@ -1,6 +1,8 @@
 Interface Settings
 ==================
 
+.. include:: version.rst
+
 .. raw:: html
    :file: generated_html/scripts_omw_settings_player.html
 

docs/source/reference/lua-scripting/interface_ui.rst

@@ -1,6 +1,8 @@
 Interface UI
 ============
 
+.. include:: version.rst
+
 .. raw:: html
    :file: generated_html/scripts_omw_ui.html
 

docs/source/reference/lua-scripting/iterables.rst

@@ -1,6 +1,8 @@
 Iterable types
 ==============
 
+.. include:: version.rst
+
 List Iterable
 -------------
 

docs/source/reference/lua-scripting/openmw_ambient.rst

@@ -1,5 +1,7 @@
 Package openmw.ambient
 ======================
 
+.. include:: version.rst
+
 .. raw:: html
    :file: generated_html/openmw_ambient.html

docs/source/reference/lua-scripting/openmw_async.rst

@@ -1,5 +1,7 @@
 Package openmw.async
 ====================
 
+.. include:: version.rst
+
 .. raw:: html
    :file: generated_html/openmw_async.html

docs/source/reference/lua-scripting/openmw_aux_calendar.rst

@@ -1,5 +1,7 @@
 Package openmw_aux.calendar
 ===========================
 
+.. include:: version.rst
+
 .. raw:: html
    :file: generated_html/openmw_aux_calendar.html

docs/source/reference/lua-scripting/openmw_aux_time.rst

@@ -1,5 +1,7 @@
 Package openmw_aux.time
 =======================
 
+.. include:: version.rst
+
 .. raw:: html
    :file: generated_html/openmw_aux_time.html

docs/source/reference/lua-scripting/openmw_aux_ui.rst

@@ -1,5 +1,7 @@
 Package openmw_aux.ui
 =======================
 
+.. include:: version.rst
+
 .. raw:: html
    :file: generated_html/openmw_aux_ui.html

docs/source/reference/lua-scripting/openmw_aux_util.rst

@@ -1,5 +1,7 @@
 Package openmw_aux.util
 =======================
 
+.. include:: version.rst
+
 .. raw:: html
    :file: generated_html/openmw_aux_util.html

docs/source/reference/lua-scripting/openmw_camera.rst

@@ -1,5 +1,7 @@
 Package openmw.camera
 =====================
 
+.. include:: version.rst
+
 .. raw:: html
    :file: generated_html/openmw_camera.html

docs/source/reference/lua-scripting/openmw_core.rst

@@ -1,5 +1,7 @@
 Package openmw.core
 ===================
 
+.. include:: version.rst
+
 .. raw:: html
    :file: generated_html/openmw_core.html

docs/source/reference/lua-scripting/openmw_debug.rst

@@ -1,5 +1,7 @@
 Package openmw.debug
 ====================
 
+.. include:: version.rst
+
 .. raw:: html
    :file: generated_html/openmw_debug.html

docs/source/reference/lua-scripting/openmw_input.rst

@@ -1,6 +1,8 @@
 Package openmw.input
 ====================
 
+.. include:: version.rst
+
 .. raw:: html
    :file: generated_html/openmw_input.html
 

docs/source/reference/lua-scripting/openmw_nearby.rst

@@ -1,5 +1,7 @@
 Package openmw.nearby
 =====================
 
+.. include:: version.rst
+
 .. raw:: html
    :file: generated_html/openmw_nearby.html

docs/source/reference/lua-scripting/openmw_postprocessing.rst

@@ -1,5 +1,7 @@
 Package openmw.postprocessing
 =============================
 
+.. include:: version.rst
+
 .. raw:: html
    :file: generated_html/openmw_postprocessing.html

docs/source/reference/lua-scripting/openmw_self.rst

@@ -1,5 +1,7 @@
 Package openmw.self
 ===================
 
+.. include:: version.rst
+
 .. raw:: html
    :file: generated_html/openmw_self.html

docs/source/reference/lua-scripting/openmw_storage.rst

@@ -1,5 +1,7 @@
 Package openmw.storage
 ======================
 
+.. include:: version.rst
+
 .. raw:: html
    :file: generated_html/openmw_storage.html

docs/source/reference/lua-scripting/openmw_types.rst

@@ -1,5 +1,7 @@
 Package openmw.types
 ====================
 
+.. include:: version.rst
+
 .. raw:: html
    :file: generated_html/openmw_types.html

docs/source/reference/lua-scripting/openmw_ui.rst

@@ -1,5 +1,7 @@
 Package openmw.ui
 =================
 
+.. include:: version.rst
+
 .. raw:: html
    :file: generated_html/openmw_ui.html

docs/source/reference/lua-scripting/openmw_util.rst

@@ -1,5 +1,7 @@
 Package openmw.util
 ===================
 
+.. include:: version.rst
+
 .. raw:: html
    :file: generated_html/openmw_util.html

docs/source/reference/lua-scripting/openmw_world.rst

@@ -1,5 +1,7 @@
 Package openmw.world
 ====================
 
+.. include:: version.rst
+
 .. raw:: html
    :file: generated_html/openmw_world.html

docs/source/reference/lua-scripting/overview.rst

@@ -1,6 +1,8 @@
 Overview of Lua scripting
 #########################
 
+.. include:: version.rst
+
 Language and sandboxing
 =======================
 

docs/source/reference/lua-scripting/setting_renderers.rst

@@ -1,6 +1,8 @@
 Built-in Setting Renderers
 ==========================
 
+.. include:: version.rst
+
 textLine
 --------
 

docs/source/reference/lua-scripting/user_interface.rst

@@ -1,6 +1,8 @@
 User interface reference
 ========================
 
+.. include:: version.rst
+
 Layouts
 -------
 

docs/source/reference/lua-scripting/version.rst

@@ -0,0 +1,2 @@
+| `OpenMW version:` |version|
+| `core.API_REVISION:` |luaApiRevision| `* <openmw_core.html##(core).API_REVISION>`_

files/lua_api/openmw/core.lua

@@ -7,7 +7,7 @@
 
 
 ---
--- The revision of OpenMW Lua API. It is an integer that is incremented every time the API is changed.
+-- The revision of OpenMW Lua API. It is an integer that is incremented every time the API is changed. See the actual value at the top of the page.
 -- @field [parent=#core] #number API_REVISION
 
 ---