mirror of
https://github.com/maxartz15/template-unity-package.git
synced 2024-10-18 16:05:32 +02:00
55 lines
3.8 KiB
Markdown
55 lines
3.8 KiB
Markdown
# [Omiya Games](https://www.omiyagames.com/) - Template Unity Package
|
|
|
|
[](https://omiyagames.github.io/template-unity-package/) [](https://bitbucket.org/OmiyaGames/template-unity-package) [](https://ko-fi.com/I3I51KS8F)
|
|
|
|
|
|
|
|
**Template Unity Package** is a Github template [Omiya Games](https://www.omiyagames.com/) uses to start a new [Unity](https://unity.com/) 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](https://omiyagames.github.io/template-unity-package/)
|
|
- [*How to Split Up an Existing Unity Git Project into Smaller Unity Packages*](https://www.taroomiya.com/2020/04/29/how-to-split-up-an-existing-unity-git-project-into-smaller-unity-packages/) by [Taro Omiya](https://github.com/japtar10101)
|
|
|
|
This package uses [DocFX](https://dotnet.github.io/docfx/) and Github Actions to auto-generate its documentation from both the comments in the source code and the Markdown files in the [`Documentation~`](/Documentation~) directory. Consult the manual on [customizing documentation files](https://omiyagames.github.io/template-unity-package/manual/customizeDocumentation.html) for your own packages. There is also has a pre-made [Doxygen](https://github.com/doxygen/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](https://docs.unity3d.com/Manual/upm-ui-giturl.html)
|
|
|
|
Unity's own Package Manager supports [importing packages through a URL to a Git repo](https://docs.unity3d.com/Manual/upm-ui-giturl.html):
|
|
|
|
1. First, on this repository page, click the "Clone or download" button, and copy over this repository's HTTPS URL.
|
|
2. 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](https://openupm.com/)
|
|
|
|
Installing via [OpenUPM's command line tool](https://openupm.com/) 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](https://openupm.com/docs/getting-started.html#installing-openupm-cli), 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
|
|
|
|
- [Documentation](https://omiyagames.github.io/template-unity-package/)
|
|
- [Change Log](/CHANGELOG.md)
|
|
|
|
## LICENSE
|
|
|
|
Overall package is licensed under [MIT](/LICENSE.md), unless otherwise noted in the [3rd party licenses](/THIRD%20PARTY%20NOTICES.md) file and/or source code.
|
|
|
|
Copyright (c) 2019-2020 Omiya Games
|