diff --git a/README.md b/README.md index b6b7144..17efc79 100644 --- a/README.md +++ b/README.md @@ -3,18 +3,58 @@ ## Table of contents - [Usage requirements](#usage-requirements) +- [Installing module](#installing-module) +- [Loading module](#loading-module) - [Build requirements](#build-requirements) - [Build instructions](#build-instructions) - [CMake options](#cmake-options) -- [Loading module](#loading-module) ## Usage requirements -**_NOTE:_** Client modules aren't downloaded by default. - +This package is essential only for **Windows** platform, and it is installed by default by g2o installer. \ In order to use the module, the user have to install: \ -[Microsoft Visual C++ 2015-2019 Redistributable (x86)](https://aka.ms/vs/16/release/vc_redist.x86.exe) \ -This package is essential only for **Windows** platform. +[Microsoft Visual C++ 2015-2022 Redistributable (x86)](https://aka.ms/vs/17/release/vc_redist.x86.exe) + +## Installing module + +**_NOTE:_** Client modules aren't downloaded by default by g2o server. +You have to put them manually into: `Game/Multiplayer/Modules` directory. + +In order to install the module you can either [download the prebuilt binary](../../releases) from releases, or [build the module yourself](#build-instructions). +Be sure to install the module with matching CPU architecture for your server app. + +## Loading module + +To load the module, you have to put `` tag into .xml server configuration. +Below you can find more info about this tag **attributes**. + +```xml + + + + + src="path/to/the/module" + + type="client"|"server" + + + + md5="1a79a4d60de6718e8e5b326e338ae533" + + + + required=true|false +``` + +Example of loading client module: +```xml + +``` + +Example of loading server module: +```xml + +``` ## Build requirements @@ -85,7 +125,3 @@ You can set these options, by either manually editing the file, or by using cmak - **INSTALL_AFTER_BUILD** this cache option allows you to run cmake install step after a successfull build. By default it's disabled. - -## Loading module - -[Read more here](https://gothic-online.com.pl/script/52) \ No newline at end of file