Granblue Autopilot is an open-source grinding/farming bot for Granblue Fantasy licensed under the MIT License.
This is just a fun project that I did while playing the game. Use it at your own risk.
The bot may be detectable since it involves an extension to run on your Google Chrome browser instead of using less detectable but more CPU heavy solution such as image processing with OpenCV. However, the extension itself does virtually nothing other than responding to queries from the command server and partially controls the page so it is less likely to trigger the anti-cheat.
As according to the MIT License, this software is provided "AS IS" and comes without any warranty. I'm not responsible for any kind of damage or losses caused by the usage of this software.
All the servers run on your local machine and the ports are not exposed to public; it only listens to your local machine.
This is a complete rewrite of the previous bot that heavily relies on OpenCV library and also a working application that is derived from the incomplete Mary Bot.
It lets you to grind in the game with preset scenarios written using JavaScript. The example scenario can be found here which is used to automatically farm the Extreme and Nightmare stages in Cinderella Fantasy: Piña Hazard event.
The bot consists of 3 separate applications:
- Chrome Extension (extension) - Partially controls the page and respond all queries from the command server.
- Command Server (server) - Low-latency server using Node.js and Socket.IO where most of the application logic runs. Also queries the extension and make calls to the control server when needed.
- Control Server (controller) - Python Flask server which controls the mouse and keyboard inputs.
The control server is tightly coupled with your operating system. Currently it only works on Windows NT using pywin32.
# Install Node.js depedencies using npm
npm install
# Install Python dependencies using pip
pip install -r requirements.txt
# Build the server and extension
npm run build
# Create the configuration files
npm run config# Start the servers
npm start- Open your Google Chrome's Extensions page.
- Check the Developer mode checkbox on the top right of the page.
- Click the Load unpacked extension... button and browse to the
extensionfolder in the project directory. - Open Granblue Fantasy in your browser.
- Click the bot icon and press the Start button inside the popup to start the bot.
The configurations are stored inside the config.ini file of each application.
| Options | Default | Required | Description |
|---|---|---|---|
| Server.ListenerPort | 49544 | Yes | The port of the command server. |
| Server.ControllerPort | 49545 | Yes | The port of the control server. |
| Server.ActionTimeoutInMs | 60000 | Yes | Maximum amount of time in milliseconds before an action (eg. clicks) timed out and generates an error. |
| Server.BotTimeoutInMins | 60 | Yes | How long the bot runs before it shuts down itself. |
| Scenario.Name | None | Yes | The name of the scenario that the bot will use. |
| Scenario.RefillAP | false | Yes | Automatically refill AP using 1/2 elixirs. |
| Chatbot.Enabled | false | Yes | Option to enable Chatbot. |
| Chatbot.URL | None | No | URL of the Chatbot webhook. |
| Chatbot.Token | None | No | JWT token generated from the chatbot endpoint. |
| Chatbot.UserId | None | No | (LINE chatbot only) List of comma-separated LINE User IDs for private message push. |
| Raid.BackupTimeoutInMs | 60000 | Yes | Time needed in milliseconds before processing another raid from the queue after the bot reaches the maximum number of backup provided. |
| Viramate.QuickSkill | true | Yes | Use quick skill buttons from Viramate. |
| Viramate.QuickSummon | true | Yes | Use quick summon buttons from Viramate. |
| Options | Default | Required | Description |
|---|---|---|---|
| Controller.ListenerPort | 49544 | Yes | The port of the control server. |
| Controller.WindowTitle | Granblue Fantasy - Google Chrome | Yes | The title of the browser window to lookup. |
| Controller.InputTween | easeInOutCubic | Yes | Tween function to move the cursor used by PyAutoGUI. List of tween functions is listed here. |
The bot uses scenario to determine what action it should take based on the logic and state of the game. The scenario itself is written in JavaScript and stored in the server/scenarios directory. This repository has a number of scenario examples, ranging from the basic to the advanced one.
All scenarios must be stored inside the server/scenarios directory. The scenario will be treated as a module by the control server using require(). The scenario itself must exports an array of actions.
Here are some ways to write the action inside a scenario:
// The simplest way to write the action is by using string
String actionName
// More general way to write the action is by using array
// This is for single argument
[String actionName, String|Number arg]
// This is for multiple arguments
[String actionName, Array<String|Number> arrayOfArgs]
// The most advanced use is to call the action and use a function to determine what next action should be taken
[
String actionName,
Array<String|Number> arrayOfArgs,
Function successCallback(next, actions, result),
Function errorCallback(next, actions, error)
]Consider the following scenario inside a battle:
1. From 3rd character, use the 4th skill
2. From 1st character (MC), use the 2nd skill
3. Use 6th summon
4. Turn on the Charge Attack
5. Attack
The scenario above can be written as the following:
module.exports = [
["battle.skills", ["3.4", "1.2"]],
["battle.summon", 6],
["battle.ca", true],
"battle.attack"
];The filename of the scenario is used to identify the scenario that the bot will use. For example, to load the scenario saved as server/scenarios/PinaHazard.js, you should have the following options inside of the command server config file:
[Scenario]
Name = PinaHazard
# ...Notice that the value of the option as PinaHazard does not include the extension (.js) and the directory path (server/scenarios).
The bot currently has limited number of actions (it mostly revolves around mouse clicks).
This section is incomplete
Currently the bot has 3 built-in modules:
- Chatbot
- Raid queue
- Viramate
These modules are hardcoded and eagerly loaded. However, it would be possible to lazily load these modules alongside with other external modules, further improving the capability of the bot itself.
This software is licensed under the MIT License