Skip to content
This repository has been archived by the owner on Apr 6, 2021. It is now read-only.

JTinkers/ScribeBot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ScribeBot

ScribeBot is a highly scriptable automation system.

With a little knowledge of Lua, you can automate mundane tasks, create macros or even create a bot.

Now with auto-updater!

Here's a glance at what interface will look like in v1.0 Beta

Important Notice

This program uses unmanaged code (msdn topic) and provides low-level functionality that if used improperly (intentionally or not) could affect system's security and reliability. It's possible to write a malicious script - it's highly advised to open packages with package editor and read code before executing it, especially if it comes from untrusted sources.

Program Features

  • Lua interpreter plugged to numerous APIs and libraries - create robust systems without expert knowledge.
  • Simple and easy interface - it's not beautiful, but it works.
  • Packaging system - keep scripts and info about them bundled together.
  • Workshop - find and download community-made scripts with just one click.
  • Built-in package editor - edit packages without having to unzip them.
  • Logging system - find out what broke when you were away.

Libraries

Library Functionality (Short) Third-party dependency
audio Play sounds, get device current peak level NAudio
core Manage windows, write to console, process console input -
database Read and save data to a local database SQLite
input Emulate keyboard/mouse input -
interface Create 'value input request' prompts -
screen Recognize text, capture screen, read screen pixels, manage screens Tesseract
webdriver Create web automations Selenium

Code Examples

You can find a simplistic stopwatch script below.

It'll keep counting seconds that have passed since it's been started and it'll continue doing so until you set count to false.

core.processConsoleInput() is crucial here, otherwise sending count = false via console won't be executed.

count = true
i = 0

while(count) do
	i = i + 1

	print(i)

	wait(1000)

	core.processConsoleInput()
end

Functions

Some functions that weren't listed below can be found here.

Name Function Params Returns
audio.createDevice Create device for sound playing - AudioDevice device
audio.getDeviceNames Get user-friendly device names - string[] names
audio.getPeakValue Get peak value of a named device string name int peak
audio.playNote Play note of a given frequency (Enum)NoteFrequencies note -
core.close Close bot - -
core.getFocusWindow Get title of currently focused window - string title
core.setFocusWindow Set focus to a window of given title string title -
core.getWindowPos Get position of a window string title Point pos
core.setWindowPos Set position of a window string title, number x, y -
core.getWindowSize Get size of a window string title Size size
core.setWindowSize Set size of a window string title, number w, h -
core.getWindowTitles Get titles of all windows - string[] titles
core.isWindowVisible Get whether window is visible title bool isVisible
core.processConsoleInput Process input entered into console - -
core.write Write text to the console string text -
core.writeLine Write colored (or not) text to the console Color color, string Text ... -
core.version Get current bot version - string version
database.query Execute a query on the local database string query -
input.postMessage Post message directly to a window string windowTitle, int message, int p1, int p2 -
input.getCursorPos Get position of cursor - Point pos
input.setCursorPos Set position of cursor number x, y -
input.isKeyDown Get whether key is down (Enum)VirtualKey key bool isKeyDown
input.isMouseDown Get whether mouse is down number button bool isMouseDown
input.sendKeyDown Emulate key press (Enum)VirtualKey key -
input.sendKeyUp Emulate key release (Enum)VirtualKey key -
input.sendKeyPress Emulate key press and release (Enum)VirtualKey key -
input.sendKeyPress Emulate key presses and releases string sequence -
input.sendMouseDown Emulate mouse press number button -
input.sendMouseUp Emulate mouse release number button -
input.sendMousePress Emulate mouse press and release number button -
interface.showPrompt Open window requesting value input string message string value
screen.capture Capture and save screen and save to given path string path -
screen.getPixels Get 2D array of all pixels in a given screen portion number x, y, w, h Color[][] colors
screen.getSize Get total work-space (resolutions of all screens summed up) - Size size
screen.recognize Try recognizing text on the screen number x, y, w, h string text
webdriver.close
webdriver.create Create a webdriver instance - WebDriver driver
webdriver.findElementsByClass Get DOM elements of a certain class string class WebElement[] elems
webdriver.findElementsByCssSelector Get DOM elements by CSS selector string selector WebElement[] elems
webdriver.findElementsById Get DOM elements of a certain ID string id WebElement[] elems
webdriver.findElementsByLinkText Get DOM elements by their link's text string text WebElement[] elems
webdriver.findElementsByName Get DOM elements by name attribute string name WebElement[] elems
webdriver.findElementsByPartialLinkText Get DOM elements by partial link's text string text WebElement[] elems
webdriver.findElementsByXPath Get DOM elements by XPath selector string xpath WebElement[] elems
webdriver.GoToUrl Go to specified url string url -
webdriver.refresh S/E - -
webdriver.sendKeyPress Emulate a key press string key -
webdriver.sendKeyRelease Emulate a key release string key -
webdriver.sendKeys Emulate a key presses & releases string keys -
webdriver.title Get title of the web browser - string title
webdriver.url Get url of the web browser - string url
webelement.clear Clear DOM element like text-field etc. - -
webelement.click Emulate click on DOM element - -
webelement.findElementsByClass Get DOM elements of a certain class string class WebElement[] elems
webelement.findElementsByCssSelector Get DOM elements by CSS selector string selector WebElement[] elems
webelement.findElementsById Get DOM elements of a certain ID string id WebElement[] elems
webelement.findElementsByLinkText Get DOM elements by their link's text string text WebElement[] elems
webelement.findElementsByName Get DOM elements by name attribute string name WebElement[] elems
webelement.findElementsByPartialLinkText Get DOM elements by partial link's text string text WebElement[] elems
webelement.findElementsByXPath Get DOM elements by XPath selector string xpath WebElement[] elems
webelement.sendKeys Emulate a key presses & releases string keys -
webelement.submit Submit form that DOM element is part of - -
webelement.displayed Get whether element is displayed - bool displayed
webelement.enabled Get whether element is enabled or not - bool enabled
webelement.location Get location of the element - Point pos
webelement.size Get size of the element - Size size
webelement.text Get text inside the element - string text
webelement.getAttribute Get value of an attribute string attribute string value

README last updated with upload of Release-0.73b