mirror of https://github.com/maxartz15/template-unity-package.git synced 2024-11-23 22:45:34 +01:00

Go to file

max 0e8054c25d Initial commit		2020-08-23 15:58:28 +02:00
.github	Initial commit	2020-08-23 15:58:28 +02:00
Documentation~	Initial commit	2020-08-23 15:58:28 +02:00
Editor	Initial commit	2020-08-23 15:58:28 +02:00
Runtime	Initial commit	2020-08-23 15:58:28 +02:00
Samples~/Example1	Initial commit	2020-08-23 15:58:28 +02:00
Tests	Initial commit	2020-08-23 15:58:28 +02:00
.gitignore	Initial commit	2020-08-23 15:58:28 +02:00
CHANGELOG.md	Initial commit	2020-08-23 15:58:28 +02:00
LICENSE.md	Initial commit	2020-08-23 15:58:28 +02:00
package.json	Initial commit	2020-08-23 15:58:28 +02:00
README.md	Initial commit	2020-08-23 15:58:28 +02:00
THIRD PARTY NOTICES.md	Initial commit	2020-08-23 15:58:28 +02:00

README.md

Omiya Games - Template Unity Package

Template Unity Package is a Github template Omiya Games uses to start a new Unity package. To use this template for your own purposes, we recommend:

Clicking on the green "Use this template" button to create a new online repository on Github directly, or
Click the "Releases" link, and download the latest archive as zip or gzip file.

From there, consult the following documentation to get a better idea of what files should be edited and/or renamed, and how:

This project's own documentation
How to Split Up an Existing Unity Git Project into Smaller Unity Packages by Taro Omiya

This package uses DocFX and Github Actions to auto-generate its documentation from both the comments in the source code and the Markdown files in the Documentation~ directory. Consult the manual on customizing documentation files for your own packages. There is also has a pre-made Doxygen settings file in the same directory to run Doxywizard through.

Install

There are two common methods for installing this package.

Through Unity Package Manager

Unity's own Package Manager supports importing packages through a URL to a Git repo:

First, on this repository page, click the "Clone or download" button, and copy over this repository's HTTPS URL.
Then click on the + button on the upper-left-hand corner of the Package Manager, select "Add package from git URL..." on the context menu, then paste this repo's URL!

While easy and straightforward, this method has a few major downside: it does not support dependency resolution and package upgrading when a new version is released. To add support for that, the following method is recommended:

Through OpenUPM

Installing via OpenUPM's command line tool is recommended because it supports dependency resolution, upgrading, and downgrading this package. Given this package is just an example, thought, it hadn't been added into OpenUPM yet. So the rest of these instructions are hypothetical...for now...

If you haven't already installed OpenUPM, you can do so through Node.js's npm (obviously have Node.js installed in your system first):

npm install -g openupm-cli

Then, to install this package, just run the following command at the root of your Unity project:

openupm add com.omiyagames.template

Resources

LICENSE

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