Skip to content

Commit 6ac740c

Browse files
committed
[Minor] update readme
1 parent aa91ae5 commit 6ac740c

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
# ModShardDiff
22

3-
A cli tool to export differences between two .win files from the same GameMaker-based game.
3+
A cli tool to export differences between two .win files from the same GameMaker-based game.
44

55
> [!NOTE]
66
> This tool relies heavily on [UTMT](https://github.com/UnderminersTeam/UndertaleModTool).
77
88
## What will I get from this tool ?
99

1010
MSD will export in seperate files the following:
11+
1112
- list of added and removed `Codes` in txt
1213
- list of added and removed `GameObjects` in txt
1314
- list of added and removed `Rooms` in txt
@@ -31,10 +32,10 @@ The diff for `Codes` and `GameObjects` is made using the `diff-match-patch` lib,
3132

3233
## How can I use it?
3334

34-
#### Using the CLI:
35+
### Using the CLI
3536

3637
To compare `data_modified.win` from `data_vanilla.win` and export the results in the folder `PATH/TO/EXPORT`, run `msd -n data_modified.win -r data_vanilla.win -o PATH/TO/EXPORT`.
3738

3839
## Known issues
3940

40-
This tool assumes that each element (`Codes`, `GameObjects`, `Sprites`, ...) is named with a unique name. If for any reasons, some elements share the same name (for instance two `Codes` using the same name), the tool will export only one (and maybe the one you are not interested in).
41+
This tool assumes that each element (`Codes`, `GameObjects`, `Sprites`, ...) is named with a unique name. If for any reasons, some elements share the same name (for instance two `Codes` using the same name), the tool will export only one (and maybe the one you are not interested in).

0 commit comments

Comments
 (0)