Update README.md

This commit is contained in:
fed 2021-09-07 00:44:33 +02:00 committed by GitHub
parent f33ea85117
commit f0afe5ab7f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,9 +1,27 @@
# h2-mod ![license](https://img.shields.io/github/license/fedddddd/h2-mod.svg)
Mod for h2 (MW2:CR) [![open bugs](https://img.shields.io/github/issues/fedddddd/h2-mod/bug?label=bugs)](https://github.com/fedddddd/h2-mod/issues?q=is%3Aissue+is%3Aopen+label%3Abug)
# How
* Download the latest release from the [here](https://github.com/fedddddd/h2-mod/releases)
* Inject the dll into `MW2CR.exe` with any injector (Battle Net doesn't have to be running)
# Scripting # H2: Mod
Usual lua scripting, scripts go in `scripts/`
## Compile from source
- Clone the Git repo. Do NOT download it as ZIP, that won't work.
- Update the submodules and run `premake5 vs2019` or simply use the delivered `generate.bat`.
- Build via solution file in `build\h2-mod.sln`.
### Premake arguments
| Argument | Description |
|:----------------------------|:-----------------------------------------------|
| `--copy-to=PATH` | Optional, copy the EXE to a custom folder after build, define the path here if wanted. |
| `--dev-build` | Enable development builds of the client. |
<br/>
## 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.