sdsd
parent
a75fcbe999
commit
e4ec4c2bef
@ -1,7 +1,7 @@
|
||||
# Preface
|
||||
|
||||
Game servers typically offer a limited range of functionality that can be used by administrative tools like IW4MAdmin.
|
||||
This minimal functionality functionality is usually restricted to administrative commands.
|
||||
This minimal functionality is usually restricted to administrative commands.
|
||||
Unfortunately, modifying game mechanics or creating custom commands that interact directly with the game is not possible by default.
|
||||
Enter the **Game Interface**...
|
||||
|
||||
@ -11,7 +11,7 @@ The **Game Interface** is a set of utilities that allows IW4MAdmin and the Call
|
||||
Without getting too technical, the **Game Interface** uses a [bus](https://en.wikipedia.org/wiki/Software_bus) system to allow two way communication with **IW4MAdmin**.
|
||||
|
||||
This communication channel enables the creation of custom commands that can directly interact with the game through scripting.
|
||||
These custom commands can significantly enhance the gaming experience and improve the integration of IW4MAdmin with the game.
|
||||
These custom commands can significantly enhance the gaming experience and improve the integration of IW4MAdmin with the game server.
|
||||
|
||||
# What games are supported?
|
||||
|
||||
@ -29,10 +29,8 @@ Install the game interface by *copying the .gsc files to your game server instal
|
||||
For `Plutonium` games you can execute the provided `deploy.bat` (on Windows) to automatically copy the files.
|
||||
|
||||
The source .gsc files are provided in the `GameFiles` directory of your **IW4MAdmin** installation.
|
||||
| |
|
||||
|-|
|
||||
|⚠️ **Make sure to restart IW4MAdmin *and* your game server after installation** |
|
||||
| |
|
||||
|-|
|
||||
|
||||
## IW4x
|
||||
|
||||
@ -71,8 +69,10 @@ The source .gsc files are provided in the `GameFiles` directory of your **IW4MAd
|
||||
# How to add new commands
|
||||
|
||||
Utilize the `RegisterScriptCommandObject` function.
|
||||
**You must have working knowledge of GSC (Call of Duty® game scripting)**
|
||||
See [example_module.gsc](https://github.com/RaidMax/IW4M-Admin/blob/develop/GameFiles/GameInterface/example_module.gsc)
|
||||
See [example_module.gsc](https://github.com/RaidMax/IW4M-Admin/blob/develop/GameFiles/GameInterface/example_module.gsc)
|
||||
|
||||
|:information_source: **You must have working knowledge of [GSC (Call of Duty® game scripting code)](https://wiki.modme.co/wiki/black_ops_3/guides/Scripting-guide.html)** |
|
||||
|-|
|
||||
|
||||
# Troubleshooting
|
||||
|
||||
@ -80,10 +80,9 @@ See [example_module.gsc](https://github.com/RaidMax/IW4M-Admin/blob/develop/Game
|
||||
|
||||
Increase the `pollingRate` value in `Configuration/ScriptPluginSettings.json`.
|
||||
Increasing the polling rate adds more time between RCon requests for new data from the game server.
|
||||
| |
|
||||
|
||||
|⚠️ **Increasing the polling rate will cause Game Interface to respond slower to commands** |
|
||||
|-|
|
||||
|⚠️ **Do note that increasing this will cause Game Interface to respond slower to commands** |
|
||||
| |
|
||||
|
||||
```json
|
||||
"GameInterface.js": {
|
||||
@ -97,12 +96,11 @@ Increasing the polling rate adds more time between RCon requests for new data fr
|
||||
|
||||
Decrease the `pollingRate` value in `Configuration/ScriptPluginSettings.json`.
|
||||
Decreasing the polling rate reduces the time between RCon requests for new data from the game server.
|
||||
| |
|
||||
|-|
|
||||
|⚠️ **Do note that decreasing this may increase the likelihood of IW4MAMdmin being RCon throttled** |
|
||||
| |
|
||||
|
||||
*See below for bus mode options to reduce latency on supported games*.
|
||||
|⚠️ **Decreasing the polling rate will increase the likelihood of IW4MAMdmin being RCon throttled** |
|
||||
|-|
|
||||
|
||||
*See the `Bus Mode` section below for bus mode options to reduce latency on supported games*.
|
||||
|
||||
```json
|
||||
"GameInterface.js": {
|
||||
@ -127,15 +125,13 @@ File bus mode is supported on these games
|
||||
| Game | Notes |
|
||||
|-------|--------|
|
||||
| IW4 | |
|
||||
| T6 | Using [t6-gsc-utils](https://github.com/fedddddd/t6-gsc-utils#io) |
|
||||
| T6 | Requires [t6-gsc-utils](https://github.com/fedddddd/t6-gsc-utils#io) |
|
||||
|
||||
| |
|
||||
|⚠️ **Currently only works on local game servers** (game servers running on a different machine are not supported) |
|
||||
|-|
|
||||
|⚠️ **Currently only supported local game servers** (game servers running on a different machine are not supported) |
|
||||
| |
|
||||
|
||||
### Configuring bus mode
|
||||
|
||||
In your server configuration set the following values
|
||||
Set the following values in your server configuration
|
||||
`set sv_iw4madmin_integration_busmode "file"`
|
||||
`set sv_iw4madmin_integration_busdir "<absolute path to default gsc filesystem access>"`
|
||||
|
Loading…
Reference in New Issue
Block a user