56 lines
3.6 KiB
Markdown
56 lines
3.6 KiB
Markdown
|
|
|
|
|
|
|
|
[](https://github.com/XLabsProject/iw4x-client/actions)
|
|
[](https://discord.gg/sKeVmR3)
|
|
[](https://www.patreon.com/xlabsproject)
|
|
|
|
# IW4x: Client
|
|
|
|
## How to compile
|
|
|
|
- Run `premake5 vs2022` or use the delivered `generate.bat`.
|
|
- Build via solution file in `build\iw4x.sln`.
|
|
|
|
## Premake arguments
|
|
|
|
| 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. |
|
|
| `--force-unit-tests` | Always compile unit tests. |
|
|
| `--force-exception-handler` | Install custom unhandled exception handler even for Debug builds. |
|
|
| `--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). |
|
|
| `--iw4x-zones` | Zonebuilder generates iw4x zones that cannot be loaded without IW4x specific patches. |
|
|
|
|
## Command line arguments
|
|
|
|
| Argument | Description |
|
|
|:------------------------|:-----------------------------------------------|
|
|
| `-tests` | Perform unit tests. |
|
|
| `-entries` | Print to the console a list of every asset as they are loaded from zonefiles. |
|
|
| `-stdout` | Redirect all logging output to the terminal iw4x is started from, or if there is none, creates a new terminal window to write log information in. |
|
|
| `-console` | Allow the game to display its own separate interactive console window. |
|
|
| `-dedicated` | Starts the game as a headless dedicated server. |
|
|
| `-scriptablehttp` | Enable HTTP related gsc functions. |
|
|
| `-bigminidumps` | Include all code sections from loaded modules in the dump. |
|
|
| `-reallybigminidumps` | Include data sections from all loaded modules in the dump. |
|
|
| `-dump` | Write info of loaded assets to the raw folder as they are being loaded. |
|
|
| `-monitor` | This flag is for internal use and it is used to indicate if an external console is present. |
|
|
| `-nointro` | Skip game's cinematic intro. |
|
|
| `-version` | Print IW4x build info on startup. |
|
|
| `-zonebuilder` | Start the interactive zonebuilder tool console instead of starting the game. |
|
|
| `-nosteam` | Disable friends feature and do not update Steam about the game's current status just like an invisible mode. |
|
|
|
|
|
|
## 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.
|