diff --git a/README.md b/README.md index 9749033..3d9bca6 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ toolchain must be installed. ## Usage 1. Ensure the game process is running (Being in the main menu should suffice). -2. Run the `cs2-dumper` executable (Note that some memflow connectors may require elevated privileges to work). +2. Run the `cs2-dumper` executable (Note that some memflow connectors may require elevated privileges). When running the executable without providing an optional memflow connector name, it will default to using the [memflow-native](https://github.com/memflow/memflow-native) cross-platform OS layer to read the memory of the game process. If you wish to use an existing memflow connector instead, pass the `connector` and optional `connector-args` arguments to the program. @@ -22,10 +22,11 @@ E.g. `./cs2-dumper -c pcileech -a device=fpga -vvv` ### Available Arguments - `-c, --connector `: The name of the memflow connector to use. -- `-a, --connector-args `: Additional arguments to pass to the connector. +- `-a, --connector-args `: Additional arguments to pass to the memflow connector. - `-f, --file-types `: The types of files to generate. Default: `cs`, `hpp`, `json`, `rs`. -- `-o, --output `: The output directory to write the generated files to. Default: `output`. - `-i, --indent-size `: The number of spaces to use per indentation level. Default: `4`. +- `-o, --output `: The output directory to write the generated files to. Default: `output`. +- `-p, --process-name `: The name of the game process. Default: `cs2.exe`. - `-v...`: Increase logging verbosity. Can be specified multiple times. - `-h, --help`: Print help. - `-V, --version`: Print version.