You can download the latest release from Releases or compile it yourself. Note that compiling it yourself requires your Rust compiler version to be at least 1.74.0 or newer.

Usage

Ensure the game is running (Being in the main menu should suffice).
Run the cs2-dumper executable.

Note: If you run the executable without specifying an optional memflow connector name, it will automatically use the memflow-native OS layer to read the memory of the game process. If you wish to use an existing memflow connector instead, such as pcileech or kvm, you can pass the connector and optional connector-args arguments to the program. These connectors can be installed and managed using the memflowup tool.

E.g (for pcileech). cs2-dumper -c pcileech -a :device=FPGA -vv

Certain connectors, such as the kvm connector on Linux or the pcileech / winio connectors on Windows, require elevated privileges to work. So either run the cs2-dumper executable with sudo on Linux or as an administrator on Windows.

Available Arguments

-c, --connector <connector>: The name of the memflow connector to use.
-a, --connector-args <connector-args>: Additional arguments to pass to the memflow connector.
-f, --file-types <file-types>: The types of files to generate. Default: cs, hpp, json, rs.
-i, --indent-size <indent-size>: The number of spaces to use per indentation level. Default: 4.
-o, --output <output>: The output directory to write the generated files to. Default: output.
-p, --process-name <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.

Running Tests

To run the few basic provided tests, use the following command: cargo test -- --nocapture.

License

Licensed under the MIT license (LICENSE).