https://github.com/kurone-kito/vpm-project-template

🐱 My template for the VPM project (for VRChat worlds creation); since 2024.2
https://github.com/kurone-kito/vpm-project-template

template-project udonsharp unity-template vpm vrchat

Last synced: about 2 months ago
JSON representation

🐱 My template for the VPM project (for VRChat worlds creation); since 2024.2

• Host: GitHub
• URL: https://github.com/kurone-kito/vpm-project-template
• Owner: kurone-kito
• License: mit
• Created: 2024-02-01T17:04:51.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-10-21T03:45:00.000Z (2 months ago)
• Last Synced: 2024-10-22T01:44:57.510Z (2 months ago)
• Topics: template-project, udonsharp, unity-template, vpm, vrchat
• Language: HTML
• Homepage: https://kurone-kito.github.io/vpm-project-template/
• Size: 654 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.ja.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.ja.md

Awesome Lists containing this project

README

        
# 🐱 VPM Project template for VRChat World

My template for the VPM project (for VRChat worlds creation)

## 💭 Difference from original template

- Added some linters e.g. CSpell, EditorConfig, Markdownlint

- Added some actions e.g. CodeQL, CodeRabbit.AI, Dependabot

- Auto invoke the VPM registry update when the package is updated

- Improved a deployment process with GPG signing

- Improved a GitHub Actions for testing and building

- Improved the git attributes and ignore files

- and more...

## ▶ Getting Started

### 1. Import the registry via the VRChat Creator Companion (VCC)

Visit the **[VPM Catalogue page](https://kurone-kito.github.io/vpm/)** and click on the **Add to VCC** button.

### 2. Import the package to your project

1. Click on the "Manage Project" button in the VCC

2. Find the "VRChat Example Package" package and click on the "(+) Add package" button

### 3. Use the package, enjoy :D

## 🤖 Setting up the Automation

Create a repository variable with the name and value described below.

For details on how to create repository variables, see [Creating Configuration Variables for a Repository](https://docs.github.com/en/actions/learn-github-actions/variables#creating-configuration-variables-for-a-repository).

Make sure you are creating a **repository variable**, and not a **repository secret**.

- `PACKAGE_NAME`: the name of your package, like `com.vrchat.demo-template`.

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](.github/workflows/build-listing.yml#L17).

## Contributing

Welcome to contribute to this repository! For more details,

please refer to [CONTRIBUTING.md](.github/CONTRIBUTING.md).

## License

This repository is licensed under the [MIT License](LICENSE).