Skip to content

Commit 404dca9

Browse files
update readme, add logo
1 parent f2fb5df commit 404dca9

File tree

2 files changed

+32
-13
lines changed

2 files changed

+32
-13
lines changed

README.md

Lines changed: 32 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,32 @@
11
# Rusty Witcher 3 Debugger
22

3+
<img src="./docs/rw3d.png" alt="Logo" width="300"/>
4+
35
A standalone Command Line Interface debugging tool for The Witcher 3 written in Rust.
46

57
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.
8+
The main features of it include recompiling game scripts at run time and monitoring scripts log, which can greatly help during mod development.
79

810
Parts of this code are based off of `Wolvenkit modding tool` by Traderain, rfuzzo and others
911
https://github.com/WolvenKit/WolvenKit
1012

1113
---
1214

1315

14-
## Usage examples
15-
Tool help.
16+
## Usage
17+
18+
Print help information.
1619
```ps1
17-
rw3d_cli.exe -h
20+
rw3d_cli.exe help
21+
rw3d_cli.exe help <SUBCOMMAND>
1822
```
1923

2024
Recompile game scripts.
2125
```ps1
2226
rw3d_cli.exe reload
2327
```
2428

25-
Recompile game scripts and automatically exit the program after the tool doesn't get any responses from the game in the span of 10 seconds after the last response.
26-
```ps1
27-
rw3d_cli.exe --response-timeout=10000 reload
28-
```
29-
30-
Remotely call an exec function from the game. Remember to use quotation marks when passing the argument if it has any spaces in it.
29+
Remotely call an exec function from the game. Remember to use quotation marks for the command argument.
3130
```ps1
3231
rw3d_cli.exe exec "additem('Aerondight', 1)"
3332
```
@@ -37,12 +36,32 @@ Remotely call an exec function from the game without waiting for tool messages o
3736
rw3d_cli.exe --no-wait --no-listen exec "gotoProlog()"
3837
```
3938

40-
Get the list of mods installed.
39+
Monitor game's scripts log and highlight lines that include specific keywords. You can set multiple key words to be highlighted with the same color.
40+
```ps1
41+
rw3d_cli.exe scriptslog --yellow="[My mod]" --yellow="[Also my mod]"
42+
```
43+
44+
Monitor game's scripts log and filter out non-highlighted lines.
45+
```ps1
46+
rw3d_cli.exe scriptslog --red="[My mod]" -f
47+
```
48+
49+
Print the list of mods installed.
4150
```ps1
4251
rw3d_cli.exe modlist
4352
```
4453

45-
Monitor game's scripts log and highlight specific lines. You can set multiple key words to be highlighted with the same color.
54+
Print the path to the root path of game's scripts.
4655
```ps1
47-
rw3d_cli.exe scriptslog --yellow="[My mod]" --yellow="[Also my mod]"
56+
rw3d_cli.exe rootpath
57+
```
58+
59+
Print the opcode for a script function
60+
```ps1
61+
rw3d_cli.exe opcode -f IsCiri -c CR4Player
62+
```
63+
64+
Print the list of config variables
65+
```ps1
66+
rw3d_cli.exe varlist
4867
```

docs/rw3d.png

366 KB
Loading

0 commit comments

Comments
 (0)