@dcl/asset-packs 2.26.1 → 2.27.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  [![npm version](https://img.shields.io/npm/v/@dcl/asset-packs.svg)](https://www.npmjs.com/package/@dcl/asset-packs)
4
4
  [![License: ISC](https://img.shields.io/badge/License-ISC-blue.svg)](https://opensource.org/licenses/ISC)
5
- [![CI Status](https://github.com/decentraland/creator-hub/workflows/Asset%20Packs/badge.svg)](https://github.com/decentraland/creator-hub/actions/workflows/asset-packs.yml)
5
+ [![CI Status](https://github.com/decentraland/dcl-one/actions/workflows/creator-hub-ci.yml/badge.svg)](https://github.com/decentraland/dcl-one/actions/workflows/creator-hub-ci.yml)
6
6
 
7
7
  ## Table of Contents
8
8
 
@@ -62,7 +62,7 @@ engine.addEntity({
62
62
  ### Prerequisites for Development
63
63
 
64
64
  - **Node.js** 22.x or higher
65
- - **npm** (comes with Node.js)
65
+ - **pnpm**, at the version the workspace's `package.json` pins (`corepack enable` provides it)
66
66
  - **Docker** (for running local content server)
67
67
  - **@dcl/sdk-commands** installed globally or locally
68
68
 
@@ -98,14 +98,14 @@ You can develop this repo locally and test it within the Web Editor by doing the
98
98
 
99
99
  Go to this repo in your machine and do this:
100
100
 
101
- 1. Run `npm run start` to watch for changes and start the SDK7 dev server (on port `8001` by default).
101
+ 1. Run `pnpm run start` to watch for changes and start the SDK7 dev server (on port `8001` by default).
102
102
  2. On a new terminal, run `docker-compose up` to start the local content server on `http://localhost:9000/asset-packs`
103
- 3. On a new terminal, run `npm run upload` to upload all assets to your local content server (copy the `.env.example` into `.env` if you haven't done that before).
104
- 4. Copy the path to the `bin/index.js` in this repo (something like `/Users/my-user/path/to/creators-hub/packages/asset-packs/bin/index.js`).
103
+ 3. On a new terminal, run `pnpm run upload` to upload all assets to your local content server (copy the `.env.example` into `.env` if you haven't done that before).
104
+ 4. Copy the path to the `bin/index.js` in this repo (`<checkout>/packages/asset-packs/bin/index.js`).
105
105
 
106
106
  Go to the `packages/inspector` in this monorepo and do this:
107
107
 
108
- 1. Run `npm start` to start a local dev server. It should start by default on port `8000`.
108
+ 1. Run `pnpm start` to start a local dev server. It should start by default on port `8000`.
109
109
 
110
110
  Go to the `packages/creator-hub` in this monorepo and do this:
111
111
 
@@ -114,7 +114,7 @@ Go to the `packages/creator-hub` in this monorepo and do this:
114
114
  3. Set the `VITE_ASSET_PACKS_JS_PORT` to the port where the SDK7 started running in the first section (`8001`).
115
115
  4. Set the `VITE_ASSET_PACKS_JS_PATH` env var in `.env` to the path to the `bin/index.js` that you copied in the first section.
116
116
  5. Set the `VITE_ASSET_PACKS_CONTENT_URL` env var in `.env` to be `http://localhost:9000/asset-packs` (this is the content server we started in the first section).
117
- 6. Run `npm start` to start the builder local server which should start on port `3000`
117
+ 6. Run `pnpm start` to start the builder local server which should start on port `3000`
118
118
 
119
119
  Now you are all set, you can start developing the SDK7 scene in this repo, use it from the local Builder and test it by previewing the scene, which should use your local Builder Server serving the development javascript files.
120
120
 
@@ -126,7 +126,7 @@ When you add a **new** asset locally it won't appear in the Asset Packs tab auto
126
126
 
127
127
  #### Option 1 — Docker (full local stack, recommended)
128
128
 
129
- The existing docker-compose setup handles everything. `npm run upload` now also uploads `catalog.json` as `asset-packs/latest/catalog.json` to MinIO, mirroring what CI does on S3.
129
+ The existing docker-compose setup handles everything. `pnpm run upload` now also uploads `catalog.json` as `asset-packs/latest/catalog.json` to MinIO, mirroring what CI does on S3.
130
130
 
131
131
  Follow the steps in [Local Development](#local-development) above, then open the inspector with:
132
132