Applied Energistics 2

Applied Energistics 2

156M Downloads

Add previous/next buttons to guidebook

Dino1694 opened this issue · 1 comments

commented

Describe the feature

As it being a "book" would suggest, I would expect a way to go to the next page, e.g. "Channels" has a back button to "Certus Growth" and a forward button to "Devices"
example ui(arrows on the side of the screen): mdbook

Reasons why it should be considered

intuitive addition(turn a page) to the guidebook being a book.
prior art

  • mdbook, stated above
  • minecraft books, (cursor(invisible in screenshot) hovered over right arrow)
    • image

Additional details

current ui:

  • in game
  • image
  • browser
  • image

Implementation notes:
These are places I found that likely need to change for the implementation of this. Keep in mind, I've never worked on this codebase before so take these notes with a grain of salt.
java ui (‎GuideScreen::init)
text for buttons (enum GuidebookText)
^note: change the history text to say history to disambiguate

for storing where the previous/next buttons should go for each page:
i.e. something like prevNext["Channels"] = new PrevNext(back = "Certus Growth", next = "Devices")
would probably be "class PrevNextIndex extends UniqueIndex<ResourceLocation, Pair<ResourceLocation, ResourceLocation>>"
Additionally, these files will probably be modified(to use that index): Guide.java, NavigationTree.java

typescript(website) ui: GuideShell.tsx and GuideNavBar.tsx to change

commented

It is not a book though...