template-unity-package/Documentation~/index.md

Omiya Games - Template Unity Package

Template Unity Package is a Github template Omiya Games uses to start a new Unity package. Developers intending to utilize this project as a starting point to develop their own package should visit the Github page and:

• If they plan on creating a new online repository on Github directly, click on the green "Use this template" button to get started, or
• Click the "Releases" link, and download the latest archive as zip or gzip file.

Structure

The project follows Unity's recommend file and folder format, albeit with a few changes:

<root>
  ├── package.json
  ├── README.md
  ├── CHANGELOG.md
  ├── LICENSE.md
  ├── THIRD PARTY NOTICES.md
  ├── .gitignore
  ├── Runtime
  │   ├── OmiyaGames.Template.asmdef
  │   └── RuntimeExample.cs
  ├── Editor
  │   ├── OmiyaGames.Template.Editor.asmdef
  │   └── EditorExample.cs
  └── Tests
  │   ├── Runtime
  │   │   ├── OmiyaGames.Template.Tests.asmdef
  │   │   └── RuntimeExampleTest.cs
  │   └── Editor
  │       ├── OmiyaGames.Template.Editor.Tests.asmdef
  │       └── EditorExampleTest.cs
  ├── Samples~
  │   └── Example1
  │       └── Example.txt
  ├── Documentation~
  |   ├── index.md
  |   ├── Doxyfile
  |   ├── docfx.json
  |   ├── toc.yml
  |   ├── filterConfig.yml
  |   ├── manual
  |   |   ├── toc.yml
  |   |   ├── customizeDocumentation.md
  |   |   ├── customizePackage.md
  |   |   ├── customizeSamples.md
  |   |   └── README.md
  |   └── resources
  |       ├── preview.png
  |       └── README.md
  └── .github
      ├── FUNDING.yml
      ├── ISSUE_TEMPLATE
      |   ├── bug_report.md
      |   ├── feature_request.md
      |   ├── documentation-template.md
      |   └── research_template.md
      └── workflows
          ├── documentation.yml
          └── mirror.yml

Common Text Formats

Note that this sprawling list of files contains a large number of common, human-readable (i.e. non-code, data-storing) text formats. If some of these file extensions are unfamiliar, the following resources describes how to edit and format the most common text files used in this project:

• JSON (*.json, *.asmdef)
  • Although the Wikipedia page might be easier understand.
• YAML (*.yml)
  • Again, the Wikipedia page.
• Markdown (*.md)
  • They also provide a cheatsheet!
• Bonus: .gitignore

About the Manual

As many of these files are intended to be edited and/or renamed, this manual has been split up into three parts. The links below briefly covers how to update this package's files for your own package development.

• Customizing Package Files
• Adding Source Code and Assets
• Adding Importable Assets
• Customizing Documentation

As an aside, the author of this manual provided a more thorough guide with graphics on their own blog: How to Split Up an Existing Unity Git Project into Smaller Unity Packages. It's worth reviewing if the manual seems a little sparse. Finally, changes in the project is documented under the change log page.

LICENSE

Overall package is licensed under MIT, unless otherwise noted in the 3rd party licenses file and/or source code.