generated from vrchat-community/template-package
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
23 additions
and
53 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,62 +1,24 @@ | ||
| # VPM Package Template | ||
| # Anti Gravity Engine for VRChat Worlds | ||
|
|
||
| Starter for making Packages, including automation for building and publishing them. | ||
| This is an advanced player/pickupable gimmicks physics system. The main focus of this system is for making illusions and some impossible gravity which can't be achieved with normal approach. | ||
|
|
||
| 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. | ||
| Multi-package repo support is yet to come. | ||
| This system can't be used standalone and it requires some UDON scripting to make it works (especially on the logic to calculate players' appearing position and orientation). Please refer to the example worlds on how you implement your world's physics. | ||
|
|
||
| ## ▶ Getting Started | ||
| ## Getting Started | ||
|
|
||
| * Press [](https://github.com/vrchat-community/template-package/generate) | ||
| to start a new GitHub project based on this template, and follow the directions there. | ||
| * Clone this repository locally using git. | ||
| * Open the folder as a Unity 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. | ||
| To install this package, you should use [VRChat Creator Companion](https://vcc.docs.vrchat.com/). Step by step details TBD. | ||
|
|
||
| ## 🚇 Migrating Assets Package | ||
| * Full details at [Converting Assets to a VPM Package](https://vcc.docs.vrchat.com/guides/convert-unitypackage) | ||
| There are 2 demo scenes, you may refer them to start build your own world. | ||
| There is also a template file named `AntiGravityCustomHandlerTemplate.cs`, you can use it as a "clean" template to implement custom physics logic. | ||
|
|
||
| ## Working on Your Package | ||
| ## But... Wait! I want to see it in action! | ||
|
|
||
| You can delete the "Packages/com.vrchat.demo-template" directory or reuse it for your own package. | ||
| Update the `.gitignore` file in the "Packages" directory to include your package. It has an example of including the demo package which you can easily change out for your own package name. | ||
| There are already several worlds are utilizing this system. | ||
| - [Infinity Staircase](https://vrchat.com/home/world/wrld_b06797a2-801e-4a9a-a49d-1eb8ed06e031), the physically impossible part is implemented using AGE. | ||
| - [3D Maze Screensaver](https://vrchat.com/home/world/wrld_c259b81a-405a-46be-8b56-0b731992e4c4), pretty good at flipping players upside down. | ||
| - [The Anarchy Stronghold](https://vrchat.com/home/world/wrld_92f7c812-c14e-41c6-9f0a-8de1a04cd48b), on how to achieve infinite hallway which can meet back your friends in a loop. | ||
| - [Debug Jinja](https://vrchat.com/home/world/wrld_61f2fa45-e023-48dd-8c69-fdb658da9347), in a secret gimmick, you will know it once you found it. | ||
|
|
||
| You can open the Unity project and work on your package's files in your favorite Code Editor. Then commit and push your changes. Once you've set up the automation as described below, you can easily publish new versions. | ||
| ## License | ||
|
|
||
| ## Setting up the Automation | ||
|
|
||
| You'll need to make a few changes in [release.yml](.github/workflows/release.yml): | ||
| * Changed 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 example, this property reads: `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"` | ||
| * We highly recommend you keep the existing folder structure where the root of the project is a Unity Repo, and your packages are in the "Packages" directory, If you change this, you'll need to update the paths that assume your package is in the "Packages" directory, on lines 24, 38, 41 and 57. | ||
|
|
||
| That's it. 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). | ||
|
|
||
| ## 🎉 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](.github/workflows/build-listing.yml) action will make a new index of all the releases available, and publish them as a website hosted fore free on [GitHub Pages](https://pages.github.com/). 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](https://github.com/scriban/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](/.github/workflows/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](.github/workflows/build-listing.yml) | ||
|
|
||
| This is a composite action which builds a vpm-compatible [Repo Listing](https://vcc.docs.vrchat.com/vpm/repos) 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](https://github.com/vrchat-community/package-list-action) which has a [Nuke](https://nuke.build/) 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, which calls `RebuildHomePage` when it completes. If you wanted to make an action that just rebuilds the home page, you could call that directly instead - just copy the existing call and replace the target names. | ||
|
|
||
| ## Status | ||
|  | ||
| [MIT](LICENSE) |