Skip to content

Commit aa91ae5

Browse files
committed
[Minor] adding known issues paragraph
1 parent 3368f5c commit aa91ae5

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# ModShardDiff
22

3-
A cli tool to export differences between two .win files.
3+
A cli tool to export differences between two .win files from the same GameMaker-based game.
4+
5+
> [!NOTE]
6+
> This tool relies heavily on [UTMT](https://github.com/UnderminersTeam/UndertaleModTool).
47
58
## What will I get from this tool ?
69

@@ -30,4 +33,8 @@ The diff for `Codes` and `GameObjects` is made using the `diff-match-patch` lib,
3033

3134
#### Using the CLI:
3235

33-
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`.
36+
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`.
37+
38+
## Known issues
39+
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).

0 commit comments

Comments
 (0)