# bpmn-js-simulation-localization

> bpmn-js token simulation extension

Latest version **1.0.1** (published 2023-10-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install bpmn-js-simulation-localization
pnpm add bpmn-js-simulation-localization
yarn add bpmn-js-simulation-localization
bun add bpmn-js-simulation-localization
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2023-10-26 |
| First published | 2023-10-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 196.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | niezihao |

## Links

- npm: https://www.npmjs.com/package/bpmn-js-simulation-localization
- Repository: https://github.com/bpmn-io/bpmn-js-token-simulation
- Homepage: https://github.com/bpmn-io/bpmn-js-token-simulation#readme
- Issues: https://github.com/bpmn-io/bpmn-js-token-simulation/issues
- npm.io page: https://npm.io/package/bpmn-js-simulation-localization

## Dependencies (3)

- [min-dom](https://npm.io/package/min-dom.md) ^3.1.3
- [min-dash](https://npm.io/package/min-dash.md) ^3.8.1
- [randomcolor](https://npm.io/package/randomcolor.md) ^0.6.2

## Recent versions

- 1.0.1 (latest) — 2023-10-26
- 1.0.0 — 2023-10-26
- 0.27.0 — 2023-10-24
- 0.10.5 — 2023-10-24

## README

# bpmn-js Token Simulation

[![CI](https://github.com/bpmn-io/bpmn-js-token-simulation/workflows/CI/badge.svg)](https://github.com/bpmn-io/bpmn-js-token-simulation/actions?query=workflow%3ACI)

A BPMN 2.0 specification compliant token simulator, built as a [bpmn-js](https://github.com/bpmn-io/bpmn-js) extension.

[![Screencast](docs/screenshot.png)](https://bpmn-io.github.io/bpmn-js-token-simulation/modeler.html?e=1&pp=1)

Try it on the [classic booking example](https://bpmn-io.github.io/bpmn-js-token-simulation/modeler.html?e=1&pp=1&diagram=https%3A%2F%2Fraw.githubusercontent.com%2Fbpmn-io%2Fbpmn-js-token-simulation%2Fmaster%2Ftest%2Fspec%2Fbooking.bpmn) or checkout the [full capability demo](https://bpmn-io.github.io/bpmn-js-token-simulation/modeler.html?e=1&pp=1&diagram=https%3A%2F%2Fraw.githubusercontent.com%2Fbpmn-io%2Fbpmn-js-token-simulation%2Fmaster%2Fexample%2Fresources%2Fall.bpmn).


## Installation

Install via [npm](http://npmjs.com/).

```
npm install bpmn-js-token-simulation
```


## Usage

Add as additional module to [bpmn-js](https://github.com/bpmn-io/bpmn-js).

### Modeler

```javascript
import BpmnModeler from 'bpmn-js/lib/Modeler';
import TokenSimulationModule from 'bpmn-js-token-simulation';

const modeler = new BpmnModeler({
  container: '#canvas',
  additionalModules: [
    TokenSimulationModule
  ]
});
```

### Viewer

```javascript
import BpmnViewer from 'bpmn-js/lib/NavigatedViewer';
import TokenSimulationModule from 'bpmn-js-token-simulation/lib/viewer';

const viewer = new BpmnViewer({
  container: '#canvas',
  additionalModules: [
    TokenSimulationModule
  ]
});
```


## Build and Run

Prepare the project by installing all dependencies:

```sh
npm install
```

Then, depending on your use-case you may run any of the following commands:

```sh
# build the library and run all tests
npm run all

# run the full development setup
npm run dev

# spin up the example
npm run start:example
```


## Additional Resources

* [Talk: Making of token simulation](https://nikku.github.io/talks/2021-token-simulation) - The case for token simulation and how it builds on top of [bpmn-js](https://github.com/bpmn-io/bpmn-js)
* [Talk: Token simulation internals](https://nikku.github.io/talks/2021-token-simulation-internals) - Detailed walk through the simulators core
* [Talk: Your next BPMN engine](https://page.camunda.com/ccs2022-bpmn-js-token-simulation) - How we turned this project into a BPMN 2.0 spec compliant simulator
* [Camunda Modeler Token Simulation plug-in](https://github.com/camunda/camunda-modeler-token-simulation-plugin) - Token simulation for [Camunda](https://camunda.com/) users


## Licence

MIT

---
_Source: https://npm.io/package/bpmn-js-simulation-localization · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._