Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/appetizermonster/unity-packman
A tiny package dependency manager for Unity, powered by Github
https://github.com/appetizermonster/unity-packman
Last synced: about 2 months ago
JSON representation
A tiny package dependency manager for Unity, powered by Github
- Host: GitHub
- URL: https://github.com/appetizermonster/unity-packman
- Owner: appetizermonster
- License: mit
- Archived: true
- Created: 2016-09-14T14:57:45.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-01-13T04:02:01.000Z (about 8 years ago)
- Last Synced: 2024-04-27T03:43:15.062Z (9 months ago)
- Language: JavaScript
- Size: 47.9 KB
- Stars: 35
- Watchers: 5
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# unity-packman
A tiny package dependency manager for Unity, powered by Github
## Why package manager for Unity?
I am working with many Unity projects, and most of them use somewhat shared packages.
but there was no clever way to support package dependencies for programmers yet. so I started this project.
with `unity-packman`, all package dependencies will be installed in `Assets/Plugins/packman-pkgs` folder.
you don't need to copy packages manually.
## Requirements
- nodejs (>= 6.0.0) / npm
- git
## Getting Started
In your project directory (parent of Unity `Assets` folder).
```bash
npm install -g unity-packman
```
Below command will create `packman.json` for your project.
```bash
unity-packman init
```
Then, now you can install dependency like this:
```bash
unity-packman install appetizermonster/Unity3D-Co
```
## Extra Commands
- Install All Dependencies in `packman.json`
```bash
unity-packman install
```
- Remove Installed Dependency
```bash
unity-packman remove appetizermonster/Unity3D-Co
```
- Update `.gitignore` for unity-packman
```bash
unity-packman gitignore
```
- Copy modified assets back into repository directory (to commit changes)
```bash
unity-packman copyback appetizermonster/Unity3D-Co
```
## Structure of `packman.json`
```javascript
{
"name": "Unity3D-Co", // Package Name
"export": "Assets/Co", // Export Directory
"dependencies": [
"appetizermonster/Unity3D-RecompileDisabler" // Package URI
]
}
```
## Examples of Package URI
- Default
```
appetizermonster/Unity3D-Co
```
- Specific Commit (with SHA1 Hash)
```
appetizermonster/Unity3D-Co?commit=6236ae6ed9e57de626b31e8d1c0957e074cf9331
```
- Specific Branch
```
appetizermonster/Unity3D-Co?branch=develop
```
- Specific Tag
```
appetizermonster/Unity3D-Co?tag=v0.0.1
```
## TODO
- `prune` command
## Example Packages
- [appetizermonster/Unity3D-Co](https://github.com/appetizermonster/Unity3D-Co)
- [appetizermonster/Unity3D-RecompileDisabler](https://github.com/appetizermonster/Unity3D-RecompileDisabler)
## Contribution
Any contributions are welcome!, Please open an issue!
## License
MIT