Skip to content

willneedit/Unity-Template

Repository files navigation

Unity Project Template

This is a project template for Unity 2021-3.15f1 or later, ready to go together with git. Additionally, to deal with the license hassles with the Unity Asset Store's assets (like, bought assets are NOT to be distributed, of course...).

Setup

  1. Rename the folder "Sample-Project" in the assets
  2. IMPORTANT: Edit .gitignore, line 11. Replace "Sample-Project" to this folder's new name, too.
  3. Optional for package creation: Edit create-package-branch.sh as appropiate, too
  4. In Assets/<YourRenamedFoledr>/package.json, edit the package description file as appropiate.
  5. Start Unity, to update the .meta files, too.
  6. Optional: Edit the AssetStoreLoader.cs to update its Asset Store shopping list (the asset store items which you want to be included).
  7. In the next update, the Loader either...
    1. includes the Asset Store item if it was already downloaded on your computer, or
    2. starts up your favourite browser to load the required Asset Store pages, to claim your required Asset Store items, or if neccessary, buy it.
  8. Once finished, exit Unity first, then commit the changes.

Use

  1. Develop with/for Unity as you like.
  2. When your work is ready for use as a Unity package, save your work, exit Unity and your IDE, commit your unstaged changes, and run create-package-branch.sh.
    1. This script creates a detached 'package' branch, roots your work on Assets/<YourRenamedFoledr>, ready to use as a package in another project, be it like that project's referene or as a submodule residing in that project's Packages/ .
    2. Set a tag/branch, otherwise the branch head will be lost, sooner or later.
  3. When you have to continue your work, simply checkout the branch you previously used.

Reminder

  1. The Assets/ root folder is NOT covered by git, bacause Unity and its packages is likely to heap samples, template files and so on and clutter your projects. If you really need the auto-generated files in Assets/, move into the folder you renamed to in step #1.

About

Ready-made Unity project template

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published