Mojang / ore-ui

💎 Building blocks to construct game UIs using web tech.
https://react-facet.mojang.com/
MIT License
405 stars 19 forks source link

Rename RemoteFacet to SharedFacet #52

Closed xaviervia closed 2 years ago

xaviervia commented 2 years ago

We have been uncertain about the RemoteFacet name for a while now, since it suggests that the data for these facets is coming from a remote address, like a network connection. This is not the case (at least not the intention). The goal of the so called RemoteFacets is to encapsulate data that is shared with the "backend" (the game engine). From a technical standpoint, in Gameface at least, the memory holding this data is literally shared memory between the C++ host and the JavaScript environment.

As such, SharedFacet is a far more accurate name than RemoteFacet. It is also more clear, since it implies that other facets are not shared with the game engine, which is exactly the point of the other (so-called "local") facets.

This PR introduces a complete rename from RemoteFacet to SharedFacet.

Pending

xaviervia commented 2 years ago

Second part (documentation): https://github.com/Mojang/ore-ui/pull/53