Skip to content

Commit 2cb3d9b

Browse files
updated README
1 parent ad711f2 commit 2cb3d9b

1 file changed

Lines changed: 11 additions & 2 deletions

File tree

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,11 @@ https://github.com/WolvenKit/WolvenKit
1717

1818
## Usage
1919

20-
In order to use this tool make sure the game is running and that it was launched with following arguments: -net -debugscripts.
20+
In order to use this tool one of two requirements must be met:
21+
1. The game must have been launched with following debug arguments[^1]: -net -debugscripts.
22+
2. A REDkit project must be opened
23+
24+
[^1]: You can either create a shortcut to the executable and add those arguments at the end or configure launch parameters in Steam/GOG.
2125

2226
Print help information.
2327
```ps1
@@ -30,11 +34,16 @@ Recompile game scripts.
3034
rw3d_cli.exe reload
3135
```
3236

33-
Recompile game scripts while developing a mod using REDkit.
37+
Recompile scripts specifically for an active REDkit project.
3438
```ps1
3539
rw3d_cli.exe --target=editor reload
3640
```
3741

42+
Recompile scripts specifically for a game being launched with debug arguments.
43+
```ps1
44+
rw3d_cli.exe --target=game reload
45+
```
46+
3847
Remotely call an exec function from the game. Remember to use quotation marks for the command argument.
3948
```ps1
4049
rw3d_cli.exe exec "spawn('Nekker', 3)"

0 commit comments

Comments
 (0)