Update README

1 files changed, 83 insertions, 11 deletions

diff --git a/src/main/resources/assets/skyblocker/tabhud/readme.md b/src/main/resources/assets/skyblocker/tabhud/readme.md
index 52cf5778..2d3dcf67 100644
--- a/src/main/resources/assets/skyblocker/tabhud/readme.md
+++ b/src/main/resources/assets/skyblocker/tabhud/readme.md
@@ -11,14 +11,16 @@ my_pack
             └───standard
 ```
 The three dirs `screenA`, `screenB` and `standard` contain the screen definition JSON files as described below. `standard` describes the screens shown when just the TAB key is pressed, while `screenA/B` describe the screens shown when using the modifier keys A and B (default binds: N and B).
-The file names are used to describe where a screen is shown. They are case sensitive. For a full list of possible names see Appendix A. While this necessitates duplicate file contents and results in similar file names in different directories, it also allows for much control both when creating a complete layout or when only overriding specific screens.
+The file names are used to describe where a screen is shown. They are case sensitive. For a full list of possible names see Appendix A. While this scheme necessitates duplicate file contents and results in similar file names in different directories, it also allows for much control both when creating a complete layout or when only overriding specific screens.
 
 # Screen definition JSONs
 This file consists of one widgets section and one layout section.
 
 ## Widget section
 The widget section defines all of the widgets that a screen uses. It also defines an alias that is used in the layout section and possibly a widget's argument if its behaviour can be changed by one.
-For a full list of widgets, their names and their arguments see Appendix B
+For a full list of widgets, their names and their arguments see Appendix B.
+
+Be advised that most widgets only work correctly in some areas. The MinionWidget for example can't show your minions when you're not on the home island. General rule of thumb: If the info is displayed in the unmodded tab hud, the correlating widget works.
 
 ## Layout section
 The layout section defines how the widgets are arranged on the screen. This is done using a pipeline; an ordered list of stages where each stage moves the widgets in some way. The initial position of the widgets is undefined. As a rule of thumb, every stage (except "Place", see below) only moves the widget in one direction, so at least two operations need to be done executed on each widget for it to be in a well defined position. A full list of operations and their arguments is found in Appendix C.
@@ -26,19 +28,89 @@ The layout section defines how the widgets are arranged on the screen. This is d
 # Appendices
 
 ## Appendix A: Area identifiers
-- default: Any area not explicitly listed.
+Some are self-explaining, others have clarification
+- default: Any area without its own dedicated layout file.
+- unknown: The mod doesn't know where you are.
+- dungeon: Inside a dungon.
+- dungeon_hub: In the dungeon hub.
+- farming_island: The island with the barn, wheat, melons and pumpkins.
+- park: The island with the trees and the harp.
+- garden: The new(er) personal farming area
+- hub: The main hub area.
+- deep_caverns
+- home_island
+- guest_island
+- crimson_isle
+- dwarven_mines
+- crystal_hollows
+- end
+- gold_mine
+- spider_den
+- jerry_workshop
+- kuudra
+- rift
 
 ## Appendix B: Widget identifiers and arguments
-
-- EmptyWidget: Generic "No data available"
+Grouped by themes (roughly)
+
+- CookieWidget: Your super cookie.
+- EffectWidget: Currently active effects.
+- ElectionWidget: The current mayor election.
+- EssenceWidget: Your dungeon essences.
+- EmptyWidget: Generic "No data available" display.
+- EventWidget: Current events. Arg `inGarden: true|false`: Is this widget displayed in the garden area?
+- FireSaleWidget: Ongoing fire sales.
+- MinionWidget: The minions on your island.
+- ProfileWidget: Data about the player's profile.
 - SkillsWidget: The player's skill levels and stats
-- EventWidget: Info about current events. Arg `inGarden: true|false`: Is this widget displayed in the garden area?
+- TrapperWidget: Trapper pelts on the farming island.
 - UpgradeWidget: Currently running upgrades
-- ProfileWidget: Data about the player's profile
-- EffectWidget: Currently active effects
-- ElectionWidget: Info about the current mayor election
-- CookieWidget: Info about your super cookie
-- TODO: finish. see widgets package for possible values.
+
+#### Garden
+- ComposterWidget: The composter in the garden.
+- GardenServerWidget: Server widget specialized for the garden.
+- GardenSkillsWidget: Skills widget specialized for the garden.
+- JacobsContestWidget: The current Jacob's contest when in the garden.
+
+#### Mining
+- CommsWidget: Shows the king's commissions in the dwarven mines and the crystal hollows.
+- ForgeWidget: Items in the forge
+- PowderWidget: Gemstone and Mithril powder collection.
+
+#### Crimson Isle
+- QuestWidget: Crimson Isle faction quests.
+- ReputationWidget: Crimson Isle faction reputation.
+- VolcanoWidget: Volcano status on the crimson isle
+
+#### Dungeon In-game
+- DungeonBuffWidget: The dungeon buffs you've found in this run.
+- DungeonDeathWidget: Various dungeon stats (deaths, but also milestones, healing, damage taken).
+- DungeonDownedWidget: Downed people in the dungeon.
+- DungeonPlayerWidget: A single dungeon player. Arg `player: 1|2|3|4|5`: For which player should this widget display info? One for each player is recommended.
+- DungeonPuzzleWidget: A list of all dungeon puzzles and their status.
+- DungeonSecretWidget: How many secrets and crypts you've found in this run.
+- DungeonServerWidget: Server widget specialized for the dungeon.
+
+#### Rift
+- AdvertisementWidget: Shows rift ads.
+- GoodToKnowWidget:
+- RiftProfileWidget:
+- RiftProgressWidget:
+- RiftServerInfoWidget: Server widget specialized for the rift.
+- RiftStatsWidget: Server widget specialized for the rift.
+- ShenWidget:
+
+#### Player lists
+- PlayerListWidget: Generic list of players in the area.
+- IslandGuestsWidget: Players visiting you or the same private island as you.
+- IslandOwnersWidget: Owners of the island you're visiting.
+- IslandSelfWidget: Owners of your home island.
+
+#### Server info
+- ServerWidget: Generic server information.
+- GuestServerWidget: Server widget specialized for guesting.
+- IslandServerWidget: Server widget specialized for the home island.
+- ParkServerWidget: Server widget specialized for the park.
 
 ## Appendix C: Pipeline stages