The API of noVNC consists of a single object called
RFB. The formal
documentation for that object can be found in our API documentation.
noVNC includes a small example application called
vnc_lite.html. This does
not make use of all the features of noVNC, but is a good start to see how to
noVNC is written using ECMAScript 6 modules. Many of the major browsers support these modules natively, but not all. They are also not supported by Node.js. To use noVNC in these places the library must first be converted.
Fortunately noVNC includes a script to handle this conversion. Please follow the following steps:
npm installin the noVNC directory
./utils/use_require.js --as <module format>
Several module formats are available. Please run
./utils/use_require.js --help to see them all.
The result of the conversion is available in the