iw4x-client/README.md

38 lines
1.6 KiB
Markdown
Raw Normal View History

2018-11-20 17:15:40 -05:00
![IW4x: Client](https://github.com/IW4x/iw4x-data/raw/master/assets/iw4x_logo.png)
2016-09-15 14:54:10 -04:00
2018-11-20 17:15:54 -05:00
# IW4x: Client
## Commit message style
```
[Module] Imperative summary
- points or text
[ci skip]
```
`[ci skip]` is optional.
2015-12-30 22:12:54 -05:00
## How to compile
2017-06-17 19:51:46 -04:00
- Run `premake5 vs2017` 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). |
| `--enable-dxsdk` | Enable DirectX SDK (required for GfxMap exporting). |