A client sided mod which only manages documentation and region visualization

[Z0rdak]

Description

To easier visualize regions, it would be a huge quality of life feature to render the outlines of regions. In addition a in-game documentation would be a great help to new users of the mod and as reference in general.

Todos

• Brainstorming for client documentation (Patchouli?)

• Client needed for visualization? Or is a hacky solution for server possible? - How to render the outlines of blocks?

  • Are vanilla particles a solution? Flan mod uses something like this
  • Are new display entities in 1.19.4 a future solution, they are server-side and can display entities/blocks

• Create an interface to be implemented by the different regions types to get to border/hull blocks

• Switch highlighting on/off by CLI or by stick mode

• Add feature to display regions around the player

• Add feature to list regions around the player

• Add feature to list regions around a given position

Related Issues

• 47

• 6

[Z0rdak]

Considering WE integration for Region Visualization, see https://github.com/Z0rdak/Yet-Another-World-Protector/pull/82

[petersv5]

I proposed this mainly to reuse the WE visualization in worldeditcui, though the sui in WE also worked. It also allowed all the WE manipulators to work.

Some other options I can think of are holograms or particles.

[petersv5]

I would prefer not introducing yet another client side mod unless absolutely needed. WE-cui is almost mandatory for operating a server, so that is already accepted but I would prefer not adding more client side, at least not for just visualization.

For doing server side only display we could look into using the virtual blocks or virtual entities via Polymer. I am konsidering making a mock up with a couple of options:

• some kind of grid of blocks as the surface of the active region
• text showing the name of the region written repeatedly on the surface of the region. Potentially showing all regions as well

[Z0rdak]

Agreed. I would love to solve this server-sided.

Polymer looks great, but I'd really like to find a solution for both Fabric and Forge.

I am tending more and more towards considering adding this feature only for 1.19.4 and onwards, and use the vanilla server-sided display entities/blocks for this.