Skip to content

Commit

Permalink
add readme attempt
Browse files Browse the repository at this point in the history
  • Loading branch information
Cvolton committed Nov 26, 2024
1 parent 8acd094 commit 724aa01
Showing 1 changed file with 5 additions and 40 deletions.
45 changes: 5 additions & 40 deletions about.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,44 +2,9 @@

Adds node IDs to layers for other mods to base their UI on, for preserving mod compatibility. See the [Github repository](https://github.com/geode-sdk/NodeIDs) for contributing.

Has IDs for:
## Why is this needed?
Back in the ancient times we had to get objects by their indices - whenever you wanted to get the play button in the main menu, you had to know it was the 3rd button added there.

- CommentCell
- CreatorLayer
- CustomizeObjectLayer (Windows and Android only)
- ChallengeNode
- ChallengesPage
- CharacterColorPage
- DailyLevelNode
- DailyLevelPage
- EditLevelLayer
- EditorPauseLayer
- EditorUI
- FLAlertLayer
- GauntletNode
- GauntletSelectLayer
- GJCommentListLayer
- GJDropDownLayer
- GJGarageLayer
- GJListLayer
- GJScoreCell
- InfoLayer
- LeaderboardsLayer
- LevelAreaInnerLayer
- LevelBrowserLayer
- LevelCell
- LevelEditorLayer
- LevelInfoLayer
- LevelLeaderboard
- LevelPage
- LevelSearchLayer
- LevelSelectLayer
- MoreOptionsLayer
- OptionsLayer
- PauseLayer
- PlayLayer
- ProfilePage
- RewardsPage
- SecretRewardsLayer
- SetGroupIDLayer
- UILayer
At first this approach seemed to work well, but then several issues were found - what if a mod adds its own button before all others? What if it removes a button RobTop added? Now the 3rd button might be something completely different!

Geode provides a solution - Node IDs. Now you don't need to bother with numbers at all! Instead you grab "play-button" and you're always guaranteed to get the correct button, even if some other mod completely reorganizes the main menu.

0 comments on commit 724aa01

Please sign in to comment.