VPM Package Listing Template

A personalized template customized from VRChat's Package Listing Template primarily for me to instantiate extra package listings for myself more quickly, but also includes a handful of minor pull requests/updates.

▶ Getting Started

• Press to start a new GitHub project based on this template.
  • Choose a fitting repository name and description.
  • Set the visibility can be either 'Public' or 'Private', as the published page will be public either way.
  • You don't need to select 'Include all branches.'
• Edit this project on GitHub in your web browser, or clone it repository locally using Git.
  • If you're unfamiliar with Git and GitHub, visit GitHub's documentation

Setting up the Automation

You'll need to edit some of the files in this template, starting with source.json:

• Fill out general information about your listing, such as the name, id, author, description, etc.
• Update the url field on line 4, replacing justsleightly with your GitHub username, and VPM-Package-Listing-Template with your repo name.
• Update the url and text within infoLink (on line 11) with what you'd like hyperlinked on the listing page.
• If you'd like to include packages hosted on GitHub, specify them in githubRepos.
  • githubRepos must include only public GitHub repositories
• If you'd like to include packages hosted elsewhere as a .zip file, specify them in packages.
  • You can safely remove either githubRepos or packages if you're not using them.
• 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".

📃 Rebuilding the Listing

The listing will rebuild whenever .github/workflows/build-listing.yml is:

1. Triggered manually from the Actions tab
2. Triggered automatically when a commit is pushed to source.json on the main branch
3. Triggered automatically from an external repository workflow such as in this package template

🏠 Customizing the Landing Page

The contents of the Website directory can be customized to change the appearance of the landing page. Most of the information will be automatically filled in with information from source.json. Customizing the landing page by hand is not required.