https://github.com/justsleightly/vpm-package-listing-template
https://github.com/justsleightly/vpm-package-listing-template
unity vrchat vrchat-avatars vrchat-tool
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/justsleightly/vpm-package-listing-template
- Owner: JustSleightly
- Created: 2023-07-11T09:23:00.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-27T05:32:27.000Z (over 1 year ago)
- Last Synced: 2025-01-09T08:12:15.624Z (4 months ago)
- Topics: unity, vrchat, vrchat-avatars, vrchat-tool
- Language: HTML
- Homepage: https://notes.sleightly.dev/community-repos/
- Size: 82 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# VPM Package Listing Template [
](https://vrc.sleightly.dev/ "JustSleightly") [
](https://discord.sleightly.dev/ "Discord") [
](https://github.sleightly.dev/ "Github") [
](https://store.sleightly.dev/ "Store")
[](https://github.com/JustSleightly/VPM-Package-Listing-Template/stargazers) [](https://github.com/JustSleightly/VPM-Package-Listing-Template/tags) [](https://github.com/JustSleightly/VPM-Package-Listing-Template/releases) [](https://github.com/JustSleightly/VPM-Package-Listing-Template/issues) [](https://github.com/JustSleightly/VPM-Package-Listing-Template/commits/main) [](https://discord.sleightly.dev/)
A personalized template customized from [VRChat's Package Listing Template](https://github.com/vrchat-community/template-package-listing) 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 [](https://github.com/JustSleightly/VPM-Package-Listing-Template/generate)
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](https://docs.github.com/en/get-started/quickstart/)
## Setting up the Automation
You'll need to edit some of the files in this template, starting with [`source.json`](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](https://github.com/JustSleightly/VPM-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`](source.json). Customizing the landing page by hand is not required.