Botmation Documentation
Install
Install
Botmation is written in TypeScript and runs on NodeJS v10+. You'll need both installed to compile and run the code.
Bare bones setup
If you're starting a new project, in your project's code directory, use npm
from NodeJS and tsc
from TypeScript, to initialize the environment:
npm init -ytsc --inittouch index.ts
Now you can begin writing bot code in index.ts
file and more.
Install Botmation
For any bot work, you'll need at least the core Botmation package, installed via npm
:
npm install --save @botmation/core
Install Puppeteer
If you haven't already, install puppeteer:
npm install --save puppeteer
Import BotActions
Then in your code, import the Botmations, helpers, etc from the @botmation/core
package:
import { chain, goTo, screenshot } from '@botmation/core';
All of Core's functions are documented with examples, under Core in the sidebar on the left.
Compile and run
If you're following the New project setup, compile and run the code:
tsc # compilesnode index.js # runs
If you want to watch Puppeteer control the browser, configure it with
headless: false
. Otherwise, the browser window won't display when the bot runs.
Have fun 🚀
Edit this page on GitHub