unity_template/README.md

23 lines
1.2 KiB
Markdown

# Modern Unity Template
A starting point for Unity projects under Git, set up for an art team coming from Perforce.
Includes:
- **`.gitattributes`** — Git LFS for all binary asset types, UnityYAMLMerge smart-merge for serialized
YAML, and **`lockable`** rules so un-mergeable assets (scenes, prefabs, models, textures, audio…) can be
locked. This is the team's locking policy, committed once so everyone shares it.
- **`.gitignore`** — the usual Unity ignores.
## File locking with Git Waypoint
This template is ready for Perforce-style file locking with **Git Waypoint**.
1. In Unity: **Window ▸ Package Manager ▸ + ▸ Add package from git URL**
`https://github.com/wayexperience/git-waypoint.git#upm`
2. **Project Settings ▸ Editor**: Asset Serialization = **Force Text**, Version Control = **Visible Meta Files**.
3. Open **Window ▸ Git Waypoint ▸ Settings**, set your Git name/email, and turn on **Automatic file locking**.
That's it — what's lockable is decided by the `lockable` rules in `.gitattributes` (above), so the whole team
locks the same files. Git Waypoint locks them automatically as you work and releases them when you push.
New to this? Read the guide: **Git per artisti** (internal).