Add details on how to use BlockPaletteGenerator.cs (#1111)

This commit is contained in:
ORelio 2020-07-06 22:59:24 +02:00
parent d2125bebb3
commit 5eea7441b7

View file

@ -9,6 +9,18 @@ namespace MinecraftClient.Mapping.BlockPalettes
/// <summary>
/// Generator for MCC Block Palette mappings
/// </summary>
/// <remarks>
/// Example for generating MaterialXXX.cs and PaletteXXX.cs from blocks.json:
///
/// MinecraftClient.Mapping.BlockPalettes.BlockPaletteGenerator.JsonToClass(
/// @"C:\Path\To\blocks.json",
/// @"C:\Path\To\Output\PaletteXXX.cs",
/// @"C:\Path\To\Output\MaterialXXX.cs"
/// );
///
/// Place the above example inside the Main() method of Program.cs, adjust paths then compile and run.
/// Do not forget to remove the temporay call to JsonToClass() from Main() once you are done.
/// </remarks>
public static class BlockPaletteGenerator
{
/// <summary>