Skip to content

Latest commit

 

History

History
12 lines (7 loc) · 1.36 KB

CONTRIBUTING.md

File metadata and controls

12 lines (7 loc) · 1.36 KB

Contributing

Due to the way a Unity package is structured, you can't directly open this repo in a Unity project. Instead, you'll have to clone the repository locally and then add it as a local dependency to an existing Unity project:

  1. Create a new Unity project (or use an existing one, if you'd prefer to do so).
  2. Clone this repository into the Packages folder of the Unity project. This should result in a kongregate-web folder adjacent to the project's manifest.json file.

You will now be able to make changes to the local copy of the repository and test the changes in the Unity project you just setup. Doing this also allows Unity to generate meta files for any new files you add, which is necessary in order to correctly import the package into other Unity projects.

Alternatively, if you already have a project setup that uses the published version of kongregate-web and want to use it to test your changes, you can clone the repo into your project's Packages folder without modifying your manifest.json. Unity will automaticaly use the local copy of the package over the one on GitHub, making it easy to test your changes. Just make sure to remove the local copy of kongregate-web once you're done to verify that you've updated your manifest.json to point to the new version once you're done!

We appreciate pull requests, bug reports, and feature requests ❤️