Getting started with VisualRM
1. Introduction
VisualRM is a tool for the popular Runescape bot platform RuneMate. It is a powerful visual state machine bot creator that allows you to make almost any bot you want without having any previous knowledge about programming and bot creation. This can be done through through simple visual state machines we will henceforward call Nodes. Don't be deceived by its simplicity, both new and seasoned developers can benefit from the quick creating, prototyping and debugging capabilities VisualRM represents. These tutorials are mainly aimed at those who do not have any experience with node based visual scripting, nor the RuneMate API. More experienced users should feel familiar with developing in Runemate without much hastle.
2. The interface
The VisualRM user interface consist of several regions each containing usefull tools to create your own bots. Each region will be explained in detail in subsequent chapters.
In general we call the central workspace, filled with a grid background, the canvas.
The top toolbar contains mostly I/O related utilities.
The icon toolbar on the left contains all the nodes you'll use in visualRM
The right pane contains the Inspector tab with information about selected nodes and the variables tab contains all the data specific for your bot.
The lower toolbar contains tools and settings for debugging and adjusting the canvas
The VisualRM user interface consist of several regions each containing usefull tools to create your own bots. Each region will be explained in detail in subsequent chapters.
In general we call the central workspace, filled with a grid background, the canvas.
The top toolbar contains mostly I/O related utilities.
The icon toolbar on the left contains all the nodes you'll use in visualRM
The right pane contains the Inspector tab with information about selected nodes and the variables tab contains all the data specific for your bot.
The lower toolbar contains tools and settings for debugging and adjusting the canvas
Overview of the VisualRM user interface
TL;DR: The interface consist of the canvas with a grid, a categorized icon bar with all the nodes on the left, a variables tab to assign all your bot data on the right and several functioning buttons on top.
2.1 The icon toolbar
2.1 The icon toolbar
The icon toolbar is a collection of all available nodes to create your bot with. The nodes are categorized in several groups for easy of use. A category can be explored by hovering the icons. This will expand a window containing the icons representing the nodes. A node can be used by dragging the icon from the expanded popup to the canvas. If recognizing images is not your forte you can use the search bar on top of the popup to search in the visible nodes. You can also discover the name of a node by hovering the icon. The title of the popup will show the currently hovered node.
The icon toolbar containing icons for each node (v0.1.5)
The categories are:
-
Search
-
The search category provides an overview of all available nodes. By using the searchbar you can search all nodes at once.
-
-
Game state
-
Contains nodes essential to every bot. The startnode is the start of every bot you'll make. Make sure to only have one at all times. It also contains nodes to end or pause your bot
-
-
Checkpoints
-
Checkpoints are a VisualRM term and do not represent any connection with Runescape itself. They are a simple but very powerful tool to clean up and organise your canvas, but also to create usefull logic flow. More info on this in the designated guide.
-
-
Conditions
-
Contains most of the conditions nodes. These are the body of your logic. Chain multiple of these nodes to evaluate conditions in game. Conditions should be chained like a tree, where every condition branches the tree into 2 new branches.
-
-
Actions
-
Action nodes are where the magic happens. The action nodes represent actual interaction with Runescape. Where the conditions are the thinkers who decide what has to be done, the actions represent the workers who do all the hard work. Importent to note is that in VisualRM every branch leads to only 1 leaf, 1 action.
-
-
Miscellaneous
-
Currently there are no nodes in Miscellaneous. In the future you'll find nodes that have very specific usages. E.g. combat nodes, runepouch evaluating/interaction nodes,...
-
-
Modulators
-
Modulators are nodes that assign new values to variables. As of v0.1.9 only booleans can change value, more variable types will be supported in due time.
-
-
Convertors
-
Convertor nodes will be able to extract and convert variables from other variables. As of v0.1.9, there are no convertor nodes.
-
NOTE: For information on each and every node take a look at the node documentation (WIP) or at specific tutorials here or on the forums.
TL;DR: In the icon bar you can find all available nodes to create your bot logic. Every bot should start with a START node. Use conditions (thinkers) to branch out the logic and use only ONE ACTION (workers) at every endpoint. For more information on specific nodes take a look at the Nodes documentation
2.1 The variables tab
