Extended from JavaFX Template project.
This is a bot originally created for one of my favourite rpg games in my childhood. This serves as a template for other pixel based bots for other tasks/games.
Note:
Pixel based just means that it relies on detecting pixels on the screen to check the state of the game and moves your mouse according to the pixels. This approach avoids certain bot detection methods that involve interacting with the machine's memory. Running the program/game in a VM and the bot on the main machine can potentially reduce the risk of being detected (unless virtual inputs are not allowed).
- Java IDE with Maven installed (JDK/JRE 8)
- JavaFX installed for IDE
- In terminal, go to directory you want to save project in and type:
git clone https://github.com/mt9304/pixelbot
- Go into project folder and type:
mvn install
- Build/Run the Main.java file in the javafxtemplate folder.
If you get a bunch of "Access Restriction" errors, then you probably are not using certain JavaFX exentions for your IDE. You can work around this by: Right click project > Properties > Java Build Path > Libraries > Expand JRE Systems Library > Select "Access rules: ..." > Edit > Add > Resolution: Accessible, Rule Pattern: javafx/** > OK
- The main part of the bot logic is found in app > businesslogic > MainBotRoutine.java. This is what is run when the start button is clicked.
- If you want to create a new routine, you can extend the Routine class. Routines are just threads, with the addition that they allow the bot to be paused/stopped with a global key listener (F1 for pause, F2 for resume, and F3 for stop). To change what happens when the Start button is pressed, go to controllers > contentarea > HomePageController.java in the
startApplication(MouseEvent)function. - Add your routine in the run() method (comments will specify where to start and end). The main bot functions I use are from the RobotService class, which extends Java's built-in Robot class. Below are the main functions that I use:
delay(int);for pausing between actions in milliseconds.mouseClick();for pressing and releasing left mouse button.mouseRightClick();for clicking the right button.moveCursorTo(int, int);for gliding the mouse to the designated X and Y location.type(String);for typing strings of text.
- The
moveCursorTo(int, int);gliding function is necessary to avoid some bot detection methods. The default mouseMove option teleports the cursor to the specified location, but seems unnatural. The game I created this for seems to send information on mouse movement, so I used this as a precaution to mimic human movement:- The cursor will curve at a random direction while moving toward its target.
- The speed of reaching the target will be random. In addition, it will tend to speed up in the middle of its journey while slowing down near the end.
- Once in a while, the cursor will miss its target on the first try by a little bit, and then head toward the target.
- The endpoint will have an offset of 5px in both X and Y (may have to implement more accurate function if there is no margin for error in the routine).
- The
type(String);function can type regular text, since the original Robot library's functions only allow single key presses. For special and unexpected characters (maybe a different language), usetypeFromClipboard(String);to type using the clipboard. - The
delay(int);function is used in most of the functions and has a semi-random int value. Having 0 delay between actions might seem suspicious.
- Use
Thread.sleep(int);instead ofbot.delay(int);for waiting longer than a few seconds or minutes. - You can use the default Java's Robot class to get pixel colors at an X/Y coordinate. For example:
Color color = robot.getPixelColor(20, 20);
- For more information on expanding on the UI, please see the original template here.