Rim/IW4M-Admin
Rim/IW4M-Admin
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 30 Wiki Activity

sss

RaidMax 2023-06-07 21:02:12 -05:00
parent 0404c0cb85
commit a75fcbe999
1 changed files with 24 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
GameInterface.md

@ -1,15 +1,17 @@
# Preface # Preface
Most game servers provided a limited set of functionality that IW4MAdmin can utilize. This restriction results in the game server exposing primarily administrative commands. Game servers typically offer a limited range of functionality that can be used by administrative tools like IW4MAdmin.
Modifying game mechanics and creating commands that interact directly with the game just isn't possible out of the box. This minimal functionality 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**... Enter the **Game Interface**...
# What is the game interface? # What is the game interface?
The **Game Interface** is a set of utilities that allows IW4MAdmin and the Call of Duty® game scripting engine to communicate with each other. The **Game Interface** is a set of utilities that allows IW4MAdmin and the Call of Duty® game scripting engine to communicate with each other.
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**. 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 allows creation of custom commands that directly interact with the game using scripting.
These custom commands enrich the experience and enhance the integration of **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.
# What games are supported? # What games are supported?
@ -27,7 +29,10 @@ 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. 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. 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**. | |
|-|
|⚠️ **Make sure to restart IW4MAdmin *and* your game server after installation** |
| |
## IW4x ## IW4x
@ -75,7 +80,10 @@ See [example_module.gsc](https://github.com/RaidMax/IW4M-Admin/blob/develop/Game
Increase the `pollingRate` value in `Configuration/ScriptPluginSettings.json`. 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 adds more time between RCon requests for new data from the game server.
**Do note that increasing this will cause Game Interface to respond slower to commands**. | |
|-|
|⚠️ **Do note that increasing this will cause Game Interface to respond slower to commands** |
| |
```json ```json
"GameInterface.js": { "GameInterface.js": {
@ -89,7 +97,11 @@ Increasing the polling rate adds more time between RCon requests for new data fr
Decrease the `pollingRate` value in `Configuration/ScriptPluginSettings.json`. 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. 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**. | |
|-|
|⚠️ **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*. *See below for bus mode options to reduce latency on supported games*.
```json ```json
@ -111,13 +123,17 @@ For those clients, the **Game Interface** has an alternative bus mode that uses
### File bus mode support ### File bus mode support
File bus mode is supported on these games File bus mode is supported on these games
**Currently only supported local game servers** (game servers running on a different machine are not supported)
| Game | Notes | | Game | Notes |
|-------|--------| |-------|--------|
| IW4 | | | IW4 | |
| T6 | Using [t6-gsc-utils](https://github.com/fedddddd/t6-gsc-utils#io) | | T6 | Using [t6-gsc-utils](https://github.com/fedddddd/t6-gsc-utils#io) |
| |
|-|
|⚠️ **Currently only supported local game servers** (game servers running on a different machine are not supported) |
| |
### Configuring bus mode ### Configuring bus mode
In your server configuration set the following values In your server configuration set the following values