/template-vrc-package

Primary LanguageHTML

VPM Package Template

Starter for making Packages, including automation for building and publishing them.

Once you're all set up, you'll be able to push changes to this repository and have .zip and .unitypackage versions automatically generated, and a listing made which works in the VPM for delivering updates for this package. If you want to make a listing with a variety of packages, check out our template-package-listing repo.

▶ Getting Started

  • Press Use This Template to start a new GitHub project based on this template.
    • Choose a fitting repository name and description.
    • Set the visibility to 'Public'. You can also choose 'Private' and change it later.
    • You don't need to select 'Include all branches.'
  • Clone this repository locally using Git.
  • Add the folder to Unity Hub and open it as a Unity Project.
  • After opening the project, wait while the VPM resolver is downloaded and added to your project.
    • This gives you access to the VPM Package Maker and Package Resolver tools.

🚇 Migrating Assets Package

Full details at Converting Assets to a VPM Package

Working on Your Package

  • Delete the "Packages/com.vrchat.demo-template" directory or reuse it for your own package.
    • If you reuse the package, don't forget to rename it!
  • Update the .gitignore file in the "Packages" directory to include your package.
    • For example, change !com.vrchat.demo-template to !com.username.package-name.
    • .gitignore files normally exclude the contents of your "Packages" directory. This .gitignore in this template show how to include the demo package. You can easily change this out for your own package name.
  • Open the Unity project and work on your package's files in your favorite code editor.
  • When you're ready, commit and push your changes.
  • Once you've set up the automation as described below, you can easily publish new versions.

Setting up the Automation

You'll need to make a few changes in release.yml:

  • Change the paths property on line 7 to point to the directory where your package's source files are. Leave the /** at the end so GitHub knows to run this action whenever any file in that directory is changed.
    • In the template, this property is paths: Packages/com.vrchat.demo-template/**
  • Change the packageName property on line 10 to include the name of your package, like packageName: "com.vrchat.demo-template"

You'll also need to make a change to build-listing.yml:

  • Change CurrentPackageName in line 4 from com.vrchat.demo-template to your own package name.

Finally, go to the "Settings" page for your repo, then choose "Pages", and look for the heading "Build and deployment". Change the "Source" dropdown from "Deploy from a branch" to "GitHub Actions".

That's it! Some other notes:

  • We highly recommend you keep the existing folder structure of this template.
    • The root of the project should be a Unity project.
    • Your packages should be in the "Packages" directory.
    • If you deviate from this folder structure, you'll need to update the paths that assume your package is in the "Packages" directory on lines 24, 38, 41 and 57.
  • If you want to store and generate your web files in a folder other than "Website" in the root, you can change the listPublicDirectory item here in build-listing.yml.

🎉 Publishing a Release

A release will be automatically built whenever you push changes to your main branch which update files in the package folder you specified in release.yml. The version specified in your package.json file will be used to define the version of the release.

📃 Rebuilding the Listing

Whenever you make a change to a release - automatically publishing it, or manually creating, editing or deleting one, the Build Repo Listing action will make a new index of all the releases available, and publish them as a website hosted fore free on GitHub Pages. This listing can be used by the VPM to keep your package up to date, and the generated index page can serve as a simple landing page with info for your package. The URL for your package will be in the format https://username.github.io/repo-name.

🏠 Customizing the Landing Page

The action which rebuilds the listing also publishes a landing page. The source for this page is in Website/index.html. The automation system uses Scriban to fill in the objects like {{ this }} with information from the latest release's manifest, so it will stay up-to-date with the name, id and description that you provide there. You are welcome to modify this page however you want - just use the existing {{ template.objects }} to fill in that info wherever you like. The entire contents of your "Website" folder are published to your GitHub Page each time.

Technical Stuff

You are welcome to make your own changes to the automation process to make it fit your needs, and you can create Pull Requests if you have some changes you think we should adopt. Here's some more info on the included automation:

Build Release Action

release.yml

This is a composite action combining a variety of existing GitHub Actions and some shell commands to create both a .zip of your Package and a .unitypackage. It creates a release which is named for the version in the package.json file found in your target Package, and publishes the zip, the unitypackage and the package.json file to this release.

Build Repo Listing

build-listing.yml

This is a composite action which builds a vpm-compatible Repo Listing based on the releases you've created. In order to find all your releases and combine them into a listing, it checks out another repository which has a Nuke project which includes the VPM core lib to have access to its types and methods. This project will be expanded to include more functionality in the future - for now, the action just calls its BuildRepoListing target.