This NPM package contains a set of reusable utility functions and features that can be used to enhance WorkAdventure maps.

There are many ways to import the @workadventure/scripting-api-extra package.

If you only want to use the extra "features", you can directly import the package in your map, by adding a "script" property at the map level, pointing to the "bundled" package:

script: https://unpkg.com/@workadventure/scripting-api-extra@^1/dist/bundle.js

Please note that you can change the version number of the package in the URL.

If you are developing your own scripts, you can import the library using NPM.

npm install --save @workadventure/scripting-api-extra

• Doors
• Bells
• Generic action layers

• Properties related functions (utility functions to acces properties...)
• Variables related functions (access variables metadata...)
• Layers related functions (get a list of all layers, find layers boundaries...)

# install dependencies
$ npm install

# run unit tests
$ npm run tests

# run integration tests
$ npm run start  # then browse to http://localhost:3000/test/maps/

Note: npm run start will connect to play.workadventu.re to server WorkAdventure.

If for development purpose, you want to connect to a development WorkAdventure server, you can use the WORKADVENTURE_URL environment variable:

$ WORKADVENTURE_URL="http://play.workadventure.localhost" npm run start