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.

npm install -g documentation

documentation build api/ -c documentation.yml --project-name "SinusBot Scripting Engine" --project-version " " --shallow -f html -o documentation

documentation serve api/ -c documentation.yml --project-name "SinusBot Scripting Engine" --project-version " " --shallow -w

There are TypeScript typings available which are generated out of the documentation. You can use them in IDEs like 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": {
        "target": "es5", // or "es2018" if sinusbot version >= 1.0.0
        "checkJs": true
    }
}

For reference, you can check out this repository.