unity_template/README.md

26 lines
982 B
Markdown

# Modern Unity Template
Includes .gitignore and .gitattributes, with LFS support.
## Git LFS file locking
This template is ready for Perforce-style file locking with the
[unity-git-locks (WAY fork)](https://github.com/wayexperience/unity-git-locks) plugin.
After cloning a project based on this template:
```sh
sh setup-locks.sh soft <your-forgejo-username>
```
That installs LFS, the `UnityYAMLMerge` driver, and a `git sync` alias
(push + release your finished locks). The shared lock policy is committed in
`ProjectSettings/GitLocksConfig.json`.
Then in Unity: add the plugin via Package Manager
(`https://github.com/wayexperience/unity-git-locks.git#v1.3.0`), set
**Asset Serialization = Force Text** and **Version Control = Visible Meta Files**,
and put your username under **Preferences > Git Locks**.
Soft mode (advisory locks, recommended) keeps files editable and only blocks the
push on files locked by others. Use `setup-locks.sh hard` for read-only enforcement.