Updated README.md
This commit is contained in:
51
README.md
51
README.md
@@ -6,8 +6,7 @@
|
|||||||
- [Build requirements](#build-requirements)
|
- [Build requirements](#build-requirements)
|
||||||
- [Build instructions](#build-instructions)
|
- [Build instructions](#build-instructions)
|
||||||
- [CMake options](#cmake-options)
|
- [CMake options](#cmake-options)
|
||||||
- [Loading client module](#loading-client-module)
|
- [Loading module](#loading-module)
|
||||||
- [Loading server module](#loading-server-module)
|
|
||||||
|
|
||||||
## Usage requirements
|
## Usage requirements
|
||||||
|
|
||||||
@@ -87,50 +86,6 @@ 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
|
- **INSTALL_AFTER_BUILD** this cache option allows you to run
|
||||||
cmake install step after a successfull build. By default it's disabled.
|
cmake install step after a successfull build. By default it's disabled.
|
||||||
|
|
||||||
## Loading client module
|
## Loading module
|
||||||
|
|
||||||
### Global (client modules will be shared across multiple servers)
|
[Read more here](https://gothic-online.com.pl/script/52)
|
||||||
|
|
||||||
**_NOTE:_** You always gives a path to a module relative to a .xml file. \
|
|
||||||
**_NOTE:_** The client module must be located in top server directory. \
|
|
||||||
**_NOTE:_** The client module must be located in Game/Multiplayer/Modules directory. \
|
|
||||||
**_NOTE:_** This approach can cause problems when different server is using older/newer version \
|
|
||||||
of the client module.
|
|
||||||
|
|
||||||
To load your module, you have to add reference in .xml file (for example: __config.xml__).
|
|
||||||
|
|
||||||
```xml
|
|
||||||
<module src="NameOfTheModule.dll" type="client" />
|
|
||||||
```
|
|
||||||
|
|
||||||
### Server specific
|
|
||||||
|
|
||||||
**_NOTE:_** You always gives a path to a module relative to a .xml file. \
|
|
||||||
**_NOTE:_** The client module must be located in ServerFolder/YourServerName. \
|
|
||||||
**_NOTE:_** The client module must be located in Game/Multiplayer/Modules/YourServerName directory.
|
|
||||||
|
|
||||||
Loading client module this way will help you to prevent situations when different \
|
|
||||||
server is using the older/newer version of the module than yours.
|
|
||||||
|
|
||||||
To load your module, you have to add reference in .xml file (for example: __config.xml__).
|
|
||||||
|
|
||||||
```xml
|
|
||||||
<module src="YourServerName/NameOfTheModule.dll" type="client" />
|
|
||||||
```
|
|
||||||
|
|
||||||
# Loading server module
|
|
||||||
|
|
||||||
|
|
||||||
**_NOTE:_** You always gives a path to a module relative to a .xml file.
|
|
||||||
|
|
||||||
You can put your server module in any directory you want, only client modules \
|
|
||||||
must be placed in specific directories.
|
|
||||||
|
|
||||||
To load your module, you have to add reference in .xml file (for example: __config.xml__).
|
|
||||||
|
|
||||||
```xml
|
|
||||||
<!-- For windows server -->
|
|
||||||
<module src="NameOfTheModule.dll" type="server" />
|
|
||||||
<!-- For linux server -->
|
|
||||||
<module src="./NameOfTheModule.so" type="server" />
|
|
||||||
```
|
|
||||||
Reference in New Issue
Block a user