# ros2djs

[![CI](https://github.com/RobotWebTools/ros2djs/actions/workflows/main.yml/badge.svg)](https://github.com/RobotWebTools/ros2djs/actions/workflows/main.yml)

#### 2D Visualization Library for use with the ROS JavaScript Libraries
For full documentation, see [the ROS wiki](http://ros.org/wiki/ros2djs) or check out some [working demos](http://robotwebtools.org/).

[JSDoc](http://robotwebtools.org/jsdoc/ros2djs/current/) can be found on the Robot Web Tools website.

This project is released as part of the [Robot Web Tools](http://robotwebtools.org/) effort.

### Usage
Pre-built files can be found in either [ros2d.js](build/ros2d.js) or [ros2d.min.js](build/ros2d.min.js).

Alternatively, you can use the current release via the Robot Web Tools CDN: ([full](https://static.robotwebtools.org/ros2djs/current/ros2d.js)) | ([min](https://static.robotwebtools.org/ros2djs/current/ros2d.min.js))

### Dependencies
ros2djs depends on:

[EventEmitter2](https://github.com/hij1nx/EventEmitter2). The current supported version is 0.4.14. The current supported version can be found on the Robot Web Tools CDN: ([full](https://static.robotwebtools.org/EventEmitter2/0.4.14/eventemitter2.js)) | ([min](https://static.robotwebtools.org/EventEmitter2/0.4.14/eventemitter2.min.js))

[EaselJS](https://github.com/CreateJS/EaselJS/). The current supported version is 0.7.1. The current supported version can be found on the Robot Web Tools CDN: ([full](https://static.robotwebtools.org/EaselJS/0.7.1/easeljs.js)) | ([min](https://static.robotwebtools.org/EaselJS/0.7.1/easeljs.min.js))

[roslibjs](https://github.com/RobotWebTools/roslibjs). The current supported version is 0.14.0. The current supported version can be found on the Robot Web Tools CDN: ([full](https://static.robotwebtools.org/roslibjs/0.14.0/roslib.js)) | ([min](https://static.robotwebtools.org/roslibjs/0.14.0/roslib.min.js))

### Build
Checkout [CONTRIBUTING.md](CONTRIBUTING.md) for details on building.

### License
ros2djs is released with a BSD license. For full terms and conditions, see the [LICENSE](LICENSE) file.

### Authors
See the [AUTHORS.md](AUTHORS.md) file for a full list of contributors.