Options
All
  • Public
  • Public/Protected
  • All
Menu

playcanvas-node - v1.4.7

Installation

npm install --save playcanvas-node

Documentation

Example

import PlayCanvas from "playcanvas-node";

const options = {
  accessToken: "xxxxxxxxxxxxxxxx",
  scenes: [xxxxxxx],
  projectId: xxxxx,
  branchId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
  projectName: "xxxxxx"
};
const playcanvas = new PlayCanvas(options);

(async () => {
  const res = await playcanvas.listAssets();
  console.log(res)
})();

Apps

  • Download app
  • Get primary app
  • Get project apps
  • Get app

Assets

  • Create asset
  const options = {
    name: "index.html",
    path: "./dist/index.html"
  };
  await playcanvas.createNewAsset(options);
  • Delete asset
  • Get Asset File
  • Get Asset
  • List assets
  • Update asset

Upload
This is the supported type. .js,.css,.txt,.json,.html https://developer.playcanvas.com/en/user-manual/api/asset-create/

  const playcanvas = new PlayCanvas(options);
  const remotePath = process.env.NODE_ENV === 'development' ? "dev" : "build"
  await playcanvas.updateAssets(dev,"index.html","./dist/index.html");

Branches

  • List branches

Jobs

  • Get job

Projects

  • Archive project

Scenes

  • List scenes

Generated using TypeDoc