adam-gdovin / playcanvas-ts-template Goto Github PK

A simple TypeScript with WebPack template for PlayCanvas that can also sync with your playcanvas.com project based on playcanvas-editor-ts-template

This template uses the playcanvas-sync tool and webpack to push files to your PlayCanvas project and requires a little bit of setup with pcconfig.json.

1. Make a copy of template.pcconfig.json and rename to pcconfig.json. This is needed to configure playcanvas-sync to upload the file to correct PlayCanvas Editor project.
2. Complete/Update the following properties in pcconfig.json using these instructions:
   • PLAYCANVAS_API_KEY - Instructions to create an API key
   • PLAYCANVAS_PROJECT_ID - Where to find the project ID
   • PLAYCANVAS_BRANCH_ID Where to find the branch ID
3. On the command line, run npm install to install the packages.
4. On the command line, run the npm script npm run watch-push:webpack.
5. This will watch the src folder for changes, compile into build/bundle.js and build/loading.js and if successful, upload to your playcanvas.com project.

Please note, if you are adding new pc.ScriptTypes or attributes to existing ones, you will need to manually parse the script after upload in the PlayCanvas Editor. Please read this for more details.