com.iron-mountain.package-creator

1.0.7 • Public • Published

Package Creator

Version: 1.0.7

Description:

Tools for creating well documented Unity packages.

Use Cases:

  • Instantly document an assembly in Markdown or HTML format.

Dependencies:

  • com.unity.nuget.newtonsoft-json (3.1.0)

Directions for Use:

  1. In Unity, right click any file within a package and select "Open Package Creator".
  2. Use the Package Editor Window to edit package details.
  3. Click Apply.

Package Mirrors:

Key Scripts & Components:

  1. public class AssemblyFinder
  2. public class Instruction
  3. public static class ManifestFinder
  4. public class PackageDependency
  5. public static class PackageDocumentationGenerator
  6. public class PackageEditorWindow : EditorWindow
  7. public class PackageManifest
    • Properties:
      • public TextAsset TextAsset { get; set; }
      • public String RelativeDirectory { get; set; }
      • public String AbsoluteDirectory { get; set; }
      • public String AbsolutePath { get; }
    • Methods:
      • public void Save()
      • public String GetHTMLDocumentation(Boolean includeTitle)
      • public String GetMarkdownDocumentation(Boolean includeTitle)
      • public void GenerateREADME()
      • public void Export()
  8. public class PackageManifestSample
  9. public class PackageResource

Dependents (0)

Package Sidebar

Install

npm i com.iron-mountain.package-creator

Weekly Downloads

0

Version

1.0.7

License

ISC

Unpacked Size

139 kB

Total Files

19

Last publish

Collaborators

  • ludachrismonte