Skip to content

Commit 1aa6c2b

Browse files
update README
1 parent afdb61a commit 1aa6c2b

1 file changed

Lines changed: 35 additions & 2 deletions

File tree

README.md

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,36 @@
1-
# Rusty Witcher Debugger
1+
# Rusty Witcher 3 Debugger
22

3-
A Rust port of the Witcher 3 debugger module found in Wolvenkit.
3+
A standalone Command Line Interface debugging tool for The Witcher 3 written in Rust.
4+
5+
This tool is intented for Witcher 3 modders who make mainly script based mods.
6+
The main feature of it is to easily recompile game scripts at run time, which can greatly save time during development.
7+
8+
Parts of this code are based off of `Wolvenkit modding tool` by Traderain, rfuzzo and others
9+
https://github.com/WolvenKit/WolvenKit
10+
11+
12+
## Usage examples
13+
Tool help
14+
```ps1
15+
rw3d_cli.exe -h
16+
```
17+
18+
Recompile game scripts
19+
```ps1
20+
rw3d_cli.exe reload
21+
```
22+
23+
Remotely call an exec function from the game
24+
```ps1
25+
rw3d_cli.exe exec additem('Aerondight', 1)
26+
```
27+
28+
Remotely call an exec function from the game without waiting for tool messages or any game response
29+
```ps1
30+
rw3d_cli.exe --no-info-wait --no-listen exec gotoProlog()
31+
```
32+
33+
Recompile game scripts and automatically exit the program after the tool doesn't get any responses from the game in the span of 5 seconds after the last response
34+
```ps1
35+
rw3d_cli.exe --response-timeout=5000 reload
36+
```

0 commit comments

Comments
 (0)