@wdp-api/cim-api/README.md

51WORLD cim-api is a JavaScript plugin designed for WdpApi, offering a comprehensive set of APIs that empower developers to seamlessly integrate cim-api into their applications.

<p>&nbsp;</p>
<p align="center"><a href="http://wdpapi.51aes.com" target="_blank" rel="noopener noreferrer"><img width="300" src="https://wdpapi.51aes.com/doc-static/images/CIMApi-logo-black.svg" alt="WdpApi logo"></a></p>
<p>&nbsp;</p>
<p align="center">
<img src="https://img.shields.io/badge/CimApi%40master-v2.0.0-brightgreen" alt="build version">
<img src="https://img.shields.io/badge/latest%20build-Jul%202025-orange" alt="publish date">
<img src="https://img.shields.io/badge/Author-Manjusaka-blue" alt="Author:manjusaka">
</p>
<p>&nbsp;</p>

## Introduction

51WORLD cim-api is a JavaScript plugin designed for WdpApi, offering a comprehensive set of APIs that empower developers to seamlessly integrate cim-api into their applications.

## Documentation
Get started with CimApi, learn the fundamentals and explore advanced topics on our documentation website.

- [Getting Started][quickstart]
- [API][api]

[quickstart]: https://wdpapi.51aes.com/study
[api]: https://wdpapi.51aes.com/apifunc


#### Install
```bash
$ npm i wdpapi
$ npm i @wdp-api/cim-api
```

#### Important
```javascript
import WdpApi from 'wdpapi';
import CimApi from '@wdp-api/cim-api';
```

#### CDN
```html
<script src="https://unpkg.com/@wdp-api/cim-api/lib/CimApi.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@wdp-api/cim-api/lib/CimApi.min.js"></script>
```

#### Instantiation
```javascript
const config = {
  id: 'player', //Render scene container(DOM node id)
  url: 'https://dtp-api.51aes.com/Renderers/Any/order', //Cloud rendering service address
  order: 'c6526f3f154663431cd29577e3532aa4', //Rendering order, obtained on the cloud rendering client
  resolution: [3840, 2160], //Set the cloud rendering output resolution[width, height]
  debugMode: 'normal', //none, normal, high
  keyboard: { //[optional] keyboard event
    normal: false, //Keyboard event, exclude F1~F12 [default disabled]
    func: false, //Browser F1 ~ F12 function keys [default disabled]
  },
};

const App = new WdpApi(config);
const { result } = await App.Plugin.Install(CimApi);
console.log(result.id)

await App.Plugin.Uninstall(result.id);
```


## License

Copyright (c) 2023-present, 51WORLD