sinusbot-scripting-engine
v1.0.18
Published
SinusBot JavaScript based Scripting Engine documentation with examples.
Downloads
11
Readme
Scripting engine documentation
This repository contains the JSDoc based javascript file from which the scripting engine documentation is generated.
Introduction
Check out our guide in the SinusBot Documentation for explanations on how to get started.
IntelliSense
There are TypeScript typings available which are generated out of the documentation. You can use them in IDEs like Visual Studio Code.
Visual Studio Code
First of all you need to install the typings by executing: npm i sinusbot-scripting-engine
or yarn add sinusbot-scripting-engine
.
After you have the typings installed, you need to create a jsconfig.json
in the folder where you develop your scripts with the following content:
{
"compilerOptions": {
"checkJs": true,
"target": "es2018",
"types" : ["sinusbot-scripting-engine"]
},
"typeAcquisition": {"enable": false, "include": ["sinusbot-scripting-engine"]},
"exclude": [
"node_modules",
"**/node_modules/*"
]
}
For reference, you can check out this repository.
Build
Install dependencies
npm install
Generate html files
npm run generate-docs
Serve locally
npm run serve-docs
Generate d.ts
npm run generate-ts