Table of Contents

Installation

Add Pixel Engine to your Unity project.

  1. Open Edit > Project Settings > Package Manager
  2. Under Scoped Registries, click +
  3. Fill in:
Field Value
Name PixelEngine
URL https://registry.npmjs.org
Scope(s) com.pixelengine
  1. Click Save
  2. Open Window > Package Manager
  3. In the top-left dropdown, switch to My Registries
  4. Find Pixel Engine and click Install

Via manifest.json

Open YourProject/Packages/manifest.json and add:

{
  "scopedRegistries": [
    {
      "name": "PixelEngine",
      "url": "https://registry.npmjs.org",
      "scopes": ["com.pixelengine"]
    }
  ],
  "dependencies": {
    "com.pixelengine": "2.0.0"
  }
}

Via Git URL

Window > Package Manager > + > Add package from git URL...

https://github.com/savesyncgames-sudo/PixelEngine.git#v2.0.0

After Installation

  1. Verify Pixel Engine / menu appears in Unity
  2. Run Pixel Engine / Setup All to scaffold your project (details)
  3. Restart Unity for script templates to appear in the Create menu

Verify

Check Where
Pixel Engine / menu Unity menu bar
com.pixelengine Window > Package Manager
using PixelEngine.Architecture; Compiles without errors

npm Package

https://www.npmjs.com/package/com.pixelengine

Next Steps