Skip to content

Commit

Permalink
document renderer icon usage in config, closes #55
Browse files Browse the repository at this point in the history
  • Loading branch information
granny committed Dec 12, 2024
1 parent 7321d93 commit 4ea0f71
Showing 1 changed file with 11 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,17 @@ public final class WorldConfig extends AbstractConfig {

@Key("render.renderers")
@Comment("""
Renderers to use. Each renderer will render a different
type of map. The built-in renderers include:
vintage_story, basic, biomes, flowermap, inhabited, night, nether_roof, and vanilla""")
Renderers to use. Each renderer will render a different type of map. The value is the icon
that the renderer should use in the Web UI. These are any "*.png" files under "web/images/icon/"
The built-in renderers include (key):
vintage_story, basic, biomes, flowermap, inhabited, night, nether_roof, and vanilla
The built-in icons include (value):
overworld_basic, overworld_biomes, overworld_night,
nether_basic, nether_biomes, nether_night, nether_roof,
the_end_basic, the_end_biomes, the_end_night,
flowermap, inhabited, vanilla""")
public Map<@NotNull String, @NotNull String> RENDER_RENDERERS = new LinkedHashMap<>() {{
put("vintage_story", "overworld_basic");
}};
Expand Down

0 comments on commit 4ea0f71

Please sign in to comment.