# <img src="https://github.com/rapyuta-robotics/amphion/blob/devel/assets/amphion_full.svg" alt="Amphion" height="70"/>

[![NPM package][npm]][npm-url]
[![Dependencies][dependencies]][dependencies-url]
[![Dev Dependencies][dev-dependencies]][dev-dependencies-url]
[![Language Grade][lgtm]][lgtm-url]

Visualization objects for ROS messages based on [three.js](https://threejs.org). Primarily built for use in [Zethus](https://github.com/rapyuta-robotics/zethus)

### Examples
All the examples can be run locally. Instructions on setting them up are available in the [README file](./examples)

### Documentation
Developer documentation is available on the [Github Wiki page]((https://github.com/rapyuta-robotics/amphion/wiki))

### Contributing
PRs, bug reports, and feature requests are welcome! Please observe [CONTRIBUTING.md](https://github.com/rapyuta-robotics/zethus/blob/devel/CONTRIBUTING.md) and [CODE_OF_CONDUCT.md](https://github.com/rapyuta-robotics/zethus/blob/devel/CODE_OF_CONDUCT.md) when making a contribution.

### Maintenance Status
Active: Rapyuta Robotics is actively working on this project, and we expect to continue work for the foreseeable future.

[npm]: https://badge.fury.io/js/amphion.svg
[npm-url]: https://www.npmjs.com/package/amphion
[dependencies]: https://img.shields.io/david/rapyuta-robotics/amphion.svg
[dependencies-url]: https://david-dm.org/rapyuta-robotics/amphion
[dev-dependencies]: https://img.shields.io/david/dev/rapyuta-robotics/amphion.svg
[dev-dependencies-url]: https://david-dm.org/rapyuta-robotics/amphion#info=devDependencies
[lgtm]: https://img.shields.io/lgtm/grade/javascript/g/rapyuta-robotics/amphion.svg?label=code%20quality
[lgtm-url]: https://lgtm.com/projects/g/rapyuta-robotics/amphion