Skip to content

Commit 51acad1

Browse files
authored
Update README.md
1 parent 1770f38 commit 51acad1

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,6 @@ It allows you to edit all sorts of Flags and Event Work data from save files.
1414

1515
**Note: The lists may contain unused data, which will be filtered out later, as documentation on the flags progresses.**
1616

17-
### Dump all Flags
18-
19-
This action will export the entire flag database with the current flag states (True/False) and event work values, with additional description (when available).
20-
This action is mainly for researching flag states and diffing previous/current states to discover and document the flag usages, that will be added as human readable information.
21-
2217
### Edit Flags
2318

2419
This action opens the main window of the plugin.
@@ -34,6 +29,11 @@ After finishing editing, export your save data from the base application.
3429
**No safety checks are done at all, so any combination of changes may cause issues like softlocks, crashes and permanent data loss.**
3530
**Save data backups are strongly recommended before going into flags editing.**
3631

32+
### Dump all Flags
33+
34+
This action will export the entire flag database with the current flag states (True/False) and event work values, with additional description (when available).
35+
This action is mainly for researching flag states and diffing previous/current states to discover and document the flag usages, that will be added as human readable information.
36+
3737
## Supported Games
3838
All mainline games are supported (limited descriptions for many of them)
3939

@@ -77,15 +77,15 @@ The flags resources database can also be localized, but it is not recommended at
7777
Those files are simple _tsv_ text files located at [_flagslist_](/flagslist) folder.
7878

7979
The header of the files, with some examples:
80-
| Raw Idx | Event Type | Location | Complement | Text Description | Valid Values | Internal Name |
80+
| Raw Idx | Event Type | Location | Complement | Text Description | Valid Values | Identifier |
8181
|---------|------------|--------------|------------|----------------------------------------------|---------------------------------|-------------------------|
8282
| 0x0008 | ITEM GIFT | Violet City | Gym | Received TM31 (Mud Slap) from Leader Falkner | | EVENT_GOT_TM31_MUD_SLAP |
8383
| 0x0034 | | Victory Road | 1F | Rival state | 0:Will battle you,1:Disappeared | wVictoryRoadSceneID |
8484

8585
The following columns should **NOT** be modified, as they are part of internal logic
8686
- Raw Idx
8787
- Event Type
88-
- Internal Name
88+
- Identifier
8989

9090
The localizable columns are:
9191
- Location (the major location for this event flag, like a town name, city, dungeon)
@@ -105,7 +105,7 @@ All research work can be checked here
105105
To contribute, create a copy of the above, fill the info you researched, and contact back with the information of what needs to be merged.
106106

107107
Priority for community contribution would be the 3DS games.
108-
B2W2 had some progress right now.
108+
Switch games had some progress right now.
109109

110110
## Credits
111111

0 commit comments

Comments
 (0)