Updated README.md
This commit is contained in:
54
README.md
54
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 `<module>` tag into .xml server configuration.
|
||||
Below you can find more info about this tag **attributes**.
|
||||
|
||||
```xml
|
||||
<!--The path to the module relative to .xml file-->
|
||||
<!--Client-side module must be placed in the exact game path from which it is loaded on the server, e.g: -->
|
||||
<!--Loading module on s-side: server/MyServerName/sqmodule.dll-->
|
||||
<!--Will cause the module to be searched in: game/Multiplayer/Modules/MyServerName/sqmodule.dll-->
|
||||
<!--[required]--> src="path/to/the/module"
|
||||
|
||||
<!--[required]--> type="client"|"server"
|
||||
|
||||
<!--By default module will be loaded without checksum validation-->
|
||||
<!--useful when you want to load only specific version of the module-->
|
||||
<!--[optional]--> md5="1a79a4d60de6718e8e5b326e338ae533"
|
||||
|
||||
<!--By default every module is required, you can override this by setting required to false-->
|
||||
<!--Useful for creating optional modules-->
|
||||
<!--[optional]--> required=true|false
|
||||
```
|
||||
|
||||
Example of loading client module:
|
||||
```xml
|
||||
<module src="sqmodule.x86.dll" type="client" />
|
||||
```
|
||||
|
||||
Example of loading server module:
|
||||
```xml
|
||||
<module src="sqmodule.x86.dll" type="server" />
|
||||
```
|
||||
|
||||
## 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)
|
||||
Reference in New Issue
Block a user