vrml1to97/README.md
Glen Whitney 8a0ece1dde chore: Prepare package for publication (#8)
Construct a proper package.json in the dist file and copy
  the README there for a reasonably complete shipped package.

Reviewed-on: #8
Co-authored-by: Glen Whitney <glen@studioinfinity.org>
Co-committed-by: Glen Whitney <glen@studioinfinity.org>
2023-09-05 01:12:55 +00:00

36 lines
831 B
Markdown

# vrml1to97
JavaScript converter from VRML 1.0 to VRML97 file format, based on Wings 3D
conversion logic.
Essentially, this is a JavaScript reimplementation of the algorithm of the
"token rearranger" found in the
[Wings 3D x3d importer](https://github.com/dgud/wings/blob/master/plugins_src/import_export/x3d_import.erl)
(which was written in Erlang).
## Usage
From an es6 module under Node (for example)
```js
import {convert} from 'vrml1to97'
const vrml1spec = '# VRML 1.0 ....'
const vrml97spec = convert(vrml1spec)
```
or from a script in a webpage
```js
(async () => {
const vrml1to97 = await import('./dist/vrml1to97/index.js')
const vrml1spec = '# VRML 1.0 ....'
const vrml97spec = vrml1to97.convert(vrml1spec)
})()
```
or from the command line via node
```shell
npx vrml1to97 < old.wrl > shinynew.wrl
```