mirror of
https://gitlab.com/ProcyonLotor/vrchat-template.git
synced 2026-08-25 10:43:53 +05:00
Added README
This commit is contained in:
31
README.md
Normal file
31
README.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# VRChat Unity project template
|
||||
Omni-template for making VRChat content
|
||||
|
||||
## Synopsis
|
||||
The template have:
|
||||
- Unity Editor settings for work with Git
|
||||
- Git settings for work with Unity Editor
|
||||
- Bootstrapper for automated SDK packages download
|
||||
- Compatible with CreatorCompanion (but it may fuck up line endings!)
|
||||
|
||||
> If VPM Resolver is not present, Bootstapper will install latest version of it which might not be compatible with older Unity versions.
|
||||
> Add `com.vrchat.core.vpm-resolver` to git, if you want to lock it
|
||||
> (you might need to adjust `Packages/.gitignore` file for this).
|
||||
|
||||
The repository have separate branches for separate content types, the only difference between them is default packages in `Packages/vpm-manifest.json`
|
||||
> Branches structure
|
||||
> ```
|
||||
> -master-+---------------------->
|
||||
> |\
|
||||
> | \-world-------------->
|
||||
> \
|
||||
> \-avatar------------->
|
||||
> ```
|
||||
|
||||
## How to use
|
||||
1. Fork this repo from the branch you want
|
||||
2. Open the project in Unity
|
||||
3. Let VPM resolve all packages
|
||||
4. Load an example and check that everything works without errors
|
||||
|
||||
> After opening the project in Unity Editor you might want to add **all** new untracked files to Git.
|
||||
Reference in New Issue
Block a user