Skip to content

Latest commit

 

History

History
72 lines (49 loc) · 2.52 KB

README.md

File metadata and controls

72 lines (49 loc) · 2.52 KB

MasterMemoryHelper


Generate MasterMemory required script or generate binary data from csv for one click.

Created for personal use.

Current version:



QuickStart



  • Install

image

Go to Window -> Package Manager on Unity then choose add package from git URL.


  • Create Configuration file

type https://github.com/piti6/MasterMemoryHelper.git and select add.

image

Create configuration asset for setup.

image

All paths are relative path of Assets folder.

  • Script Input Path (Required)

    • Path for MasterMemory definition c# script.
  • Script Output Path (Required)

    • Path for Generated MasterMemory/MessagePack-CSharp Resolver/Formatter c# script.
  • Csv Input Path (Required)

    • Path for input csv data.
  • Binary Output Path (Required)

    • Path for binary data converted from csv. (used on runtime)
  • Namespace (Required)

    • Namespace for generated scripts. (both MasterMemory/MessagePack-CSharp namespace will affected)
  • Prefix Class Name (Optional)

    • Prefix class name for MasterMemory.
  • Database Builder Type (Required)

    • Type of custom DatabaseBuilder. if this is first time you imported package on project, you should generate DatabaseBuilder first.
    • After generate scripts by MasterMemoryHelper -> GenerateScripts, you should select type to use csv to binary converter.
  • Memory Database Type (Required)

    • Type of custom MemoryDatabase. if this is first time you imported package on project, you should generate MemoryDatabase first.
    • After generate scripts by MasterMemoryHelper -> GenerateScripts, you should select type to use csv to binary converter.

  • Usage

    • MasterMemoryHelper -> GenerateScripts
      • You should run this command when c# script definition file has changed.
    • MasterMemoryHelper -> GenerateBinaryFromCsv
      • You should run this command when csv data has changed.

  • Limitation

    • On script definition, Getter-Only property is only format that is currently supported. (Cause currently I do not need to modify master data at all)