{"id":13723707,"url":"https://github.com/RobotWebTools/ros3djs","last_synced_at":"2025-05-07T17:31:02.844Z","repository":{"id":7446875,"uuid":"8788891","full_name":"RobotWebTools/ros3djs","owner":"RobotWebTools","description":"3D Visualization Library for use with the ROS JavaScript Libraries","archived":false,"fork":false,"pushed_at":"2024-11-05T10:26:01.000Z","size":11648,"stargazers_count":368,"open_issues_count":81,"forks_count":216,"subscribers_count":32,"default_branch":"develop","last_synced_at":"2024-11-10T08:04:47.198Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://robotwebtools.github.io/ros3djs","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RobotWebTools.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS.md","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2013-03-15T00:52:55.000Z","updated_at":"2024-11-07T03:26:41.000Z","dependencies_parsed_at":"2023-02-12T16:45:13.719Z","dependency_job_id":"82e454c0-e53b-4355-9982-9affc1100990","html_url":"https://github.com/RobotWebTools/ros3djs","commit_stats":{"total_commits":669,"total_committers":64,"mean_commits":10.453125,"dds":0.7294469357249627,"last_synced_commit":"c7e780ae32b3c5dab3e7a1635f2f901f6391e630"},"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RobotWebTools%2Fros3djs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RobotWebTools%2Fros3djs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RobotWebTools%2Fros3djs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RobotWebTools%2Fros3djs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RobotWebTools","download_url":"https://codeload.github.com/RobotWebTools/ros3djs/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224627935,"owners_count":17343273,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-03T01:01:44.680Z","updated_at":"2024-11-14T13:30:45.626Z","avatar_url":"https://github.com/RobotWebTools.png","language":"JavaScript","readme":"# ros3djs\n\n[![CI](https://github.com/RobotWebTools/ros3djs/actions/workflows/main.yml/badge.svg)](https://github.com/RobotWebTools/ros3djs/actions/workflows/main.yml)\n\n\n#### 3D Visualization Library for use with the ROS JavaScript Libraries\n\nFor full documentation, see [the ROS wiki](http://ros.org/wiki/ros3djs) or check out some [working demos](https://robotwebtools.github.io/demos.html).\n\n[JSDoc](https://robotwebtools.github.io/ros3djs) can be found on the Robot Web Tools website.\n\nThis project is released as part of the [Robot Web Tools](https://robotwebtools.github.io/) effort.\n\n### Usage\n\nPre-built files can be found in either [ros3d.js](build/ros3d.js) or [ros3d.min.js](build/ros3d.min.js).\n\n\nAlternatively, you can use the current release via the [JsDelivr](https://www.jsdelivr.com/) CDN: ([full](https://cdn.jsdelivr.net/npm/ros3d@1/build/ros3d.js)) | ([min](https://cdn.jsdelivr.net/npm/ros3d@1/build/ros3d.min.js))\n\n### Dependencies\n\nros3djs depends on:\n\n[EventEmitter3](https://github.com/primus/eventemitter3). The current supported version is 5.0. The current supported version can be found on the JsDeliver CDN: ([full](https://cdn.jsdelivr.net/npm/eventemitter3@5.0/dist/eventemitter3.umd.js)) | ([min](https://cdn.jsdelivr.net/npm/eventemitter3@5.0/dist/eventemitter3.umd.js))\n\n[three.js](https://github.com/mrdoob/three.js/). The current supported version is r89. The current supported version can be found on the Robot Web Tools CDN: ([full](https://cdn.jsdelivr.net/npm/three@0.89.0/build/three.js)) | ([min](https://cdn.jsdelivr.net/npm/three@0.89.0/build/three.min.js))\n\n[THREE.ColladaLoader](https://github.com/mrdoob/three.js/blob/master/examples/js/loaders/ColladaLoader.js). The current supported version is r89. The current supported version can be found on the Robot Web Tools CDN: ~([full](https://static.robotwebtools.org/threejs/r89/ColladaLoader.js))~ This CDN is gone.\n\n[THREE.STLLoader](https://github.com/mrdoob/three.js/blob/master/examples/js/loaders/STLLoader.js). The current supported version is r89. The current supported version can be found on the Robot Web Tools CDN: ~([full](https://static.robotwebtools.org/threejs/r89/STLLoader.js))~ This CDN is gone.\n\n(ROS)ColladaLoader. We support patched version of ColladaLoader to workaround ros-visualization/rviz#1045. This version can be found on the Robot Web Tools CDN: ~([full](https://static.robotwebtools.org/ros3djs/0.18.0/ColladaLoader.js))~ This CDN is gone.\n\n[roslibjs](https://github.com/RobotWebTools/roslibjs). The current supported version is 1.3.0. The current supported version can be found on the JsDeliver CDN: ([full](https://cdn.jsdelivr.net/npm/roslib@1/build/roslib.js)) | ([min](https://cdn.jsdelivr.net/npm/roslib@1/build/roslib.min.js))\n\n### Build\n\n[Grunt](http://gruntjs.com/) is used for building, including concatenating, minimizing, documenting, linting, and testing.\n\n### Install Grunt and its Dependencies\n\n#### Ubuntu 18.04/20.04\n\n 1. Install Node.js and its package manager, NPM\n   * `sudo apt-get install nodejs nodejs-legacy npm` or any other way you like\n 2. Install Grunt\n   * `sudo npm install -g grunt-cli`\n   * (optional) `sudo rm -rf ~/.npm ~/tmp`\n 3. Install the Grunt tasks specific to this project\n   * `cd /path/to/ros3djs/`\n   * `npm install .`\n\n### Build with Grunt\n\nBefore proceeding, please confirm you have installed the dependencies above.\n\nTo run the build tasks:\n\n 1. `cd /path/to/ros3djs/`\n 2. `grunt build`\n\n`grunt build` will concatenate and minimize the files under src and replace ros3d.js and ros3d.min.js in the build directory. It will also run the linter and test cases. This is what [GitHub Actions](https://github.com/RobotWebTools/ros3djs/actions/workflows/main.yml) runs when a Pull Request is submitted.\n\n`grunt dev` will watch for any changes to any of the src/ files and automatically concatenate and minimize the files. This is ideal for those developing as you should only have to run `grunt dev` once.\n\n`grunt doc` will rebuild all JSDoc for the project.\n\n### Testing\n\nUtilizes [mocha](https://mochajs.org/) and [chai](http://chaijs.com/) for in browser testing.\n\nTo run tests simply open `tests/index.html` in a web browser\n\n### Examples\n\nThere are a variety of [examples](examples) of the different things that can be done with ros3djs.\n\nThere are also some examples of how ros3djs can be used in different environments:\n\n- [Classic html script tag inclusion](examples)\n- [Modular html script tag inclusion](examples/html-import)\n\n### License\n\nros3djs is released with a BSD license. For full terms and conditions, see the [LICENSE](LICENSE) file.\n\n### Authors\n\nSee the [AUTHORS.md](AUTHORS.md) file for a full list of contributors.\n","funding_links":[],"categories":["Data Visualization and Mission Control","JavaScript"],"sub_categories":["Command Line Interface"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FRobotWebTools%2Fros3djs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FRobotWebTools%2Fros3djs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FRobotWebTools%2Fros3djs/lists"}