2019-09-16 14:11:23 -04:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2019-09-19 04:30:49 -04:00
|
|
|
[](https://ci.appveyor.com/project/iw4x/iw4x-client/branch/develop)
|
2019-12-10 16:13:09 -05:00
|
|
|
[](https://discord.gg/sKeVmR3)
|
2021-02-16 09:36:50 -05:00
|
|
|
[](https://www.patreon.com/xlabsproject)
|
2016-09-15 14:54:10 -04:00
|
|
|
|
2018-11-20 17:15:54 -05:00
|
|
|
# IW4x: Client
|
|
|
|
|
|
2016-11-12 06:45:07 -05:00
|
|
|
## Commit message style
|
|
|
|
|
|
|
|
|
|
```
|
2016-11-15 14:53:11 -05:00
|
|
|
[Module] Imperative summary
|
2016-11-12 06:45:07 -05:00
|
|
|
|
|
|
|
|
- points or text
|
|
|
|
|
|
|
|
|
|
[ci skip]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
`[ci skip]` is optional.
|
|
|
|
|
|
2015-12-30 22:12:54 -05:00
|
|
|
## How to compile
|
|
|
|
|
|
2019-09-16 14:11:23 -04:00
|
|
|
- Run `premake5 vs2019` or use the delivered `generate.bat`.
|
2016-01-03 09:22:10 -05:00
|
|
|
- Build via solution file in `build\iw4x.sln`. (You can use the `build.bat` script to do it quick and easy.)
|
2015-12-30 22:12:54 -05:00
|
|
|
|
|
|
|
|
## Premake arguments
|
|
|
|
|
|
2018-11-20 17:16:01 -05:00
|
|
|
| Argument | Description |
|
|
|
|
|
|:----------------------------|:-----------------------------------------------|
|
|
|
|
|
| `--copy-to=PATH` | Optional, copy the DLL to a custom folder after build, define the path here if wanted. |
|
|
|
|
|
| `--copy-pdb` | Copy debug information for binaries as well to the path given via --copy-to. |
|
|
|
|
|
| `--ac-disable` | Disable anticheat. |
|
|
|
|
|
| `--ac-debug-detections` | Log anticheat detections. |
|
|
|
|
|
| `--ac-debug-load-library` | Log libraries that get loaded. |
|
|
|
|
|
| `--force-unit-tests` | Always compile unit tests. |
|
2016-09-16 03:04:00 -04:00
|
|
|
| `--force-exception-handler` | Install custom unhandled exception handler even for Debug builds. |
|
2018-11-20 17:16:01 -05:00
|
|
|
| `--force-minidump-upload` | Upload minidumps even for Debug builds. |
|
|
|
|
|
| `--disable-bitmessage` | Disable use of BitMessage completely. |
|
|
|
|
|
| `--disable-base128` | Disable base128 encoding for minidumps. |
|
|
|
|
|
| `--no-new-structure` | Do not use new virtual path structure (separating headers and source files). |
|
2021-07-16 13:08:50 -04:00
|
|
|
| `--iw4x-zones` | Zonebuilder generates iw4x zones that cannot be loaded without IW4x specific patches. |
|
2019-09-16 14:11:23 -04:00
|
|
|
|
2021-05-29 09:12:55 -04:00
|
|
|
## Command line arguments
|
|
|
|
|
|
|
|
|
|
| Argument | Description |
|
|
|
|
|
|:----------------------------|:-----------------------------------------------|
|
|
|
|
|
| `-tests` | Perform unit tests. |
|
|
|
|
|
| `-entries` | Prints fast file info to the console. |
|
|
|
|
|
| `-stdout` | Redirect stdout to the external console. |
|
|
|
|
|
| `-console` | Enables external console. |
|
|
|
|
|
| `-dedicated` | Dedicated server. |
|
|
|
|
|
| `-scriptablehttp` | Adds HTTP console commands. |
|
|
|
|
|
| `-bigdumps` | Enables dumps. |
|
|
|
|
|
| `-reallybigdumps` | Unused. |
|
|
|
|
|
| `-bigminidumps` | Mini dumps. |
|
|
|
|
|
| `-reallybigminidumps` | Big mini dumps. |
|
|
|
|
|
| `-dump` | Prints asset info to a .ents file. |
|
|
|
|
|
| `-monitor` | Enables monitor. |
|
|
|
|
|
| `-nointro` | Skips game's intro. |
|
|
|
|
|
| `-version` | Prints IW4X version. |
|
|
|
|
|
| `-zonebuilder` | Enables zone builder. |
|
|
|
|
|
| `-nosteam` | Disables Steam features. |
|
|
|
|
|
|
|
|
|
|
|
2019-09-16 14:11:23 -04:00
|
|
|
## Disclaimer
|
|
|
|
|
|
|
|
|
|
This software has been created purely for the purposes of
|
|
|
|
|
academic research. It is not intended to be used to attack
|
|
|
|
|
other systems. Project maintainers are not responsible or
|
|
|
|
|
liable for misuse of the software. Use responsibly.
|
