Skip to content

Granblue Autopilot is an open-source grinding/farming bot for Granblue Fantasy

License

Notifications You must be signed in to change notification settings

DiruSec/gbf-autopilot

 
 

Repository files navigation

Travis CI

Granblue Autopilot

Granblue Autopilot is an open-source grinding/farming bot for Granblue Fantasy licensed under the MIT License.

Disclaimer

I hold no liability for any damage or losses caused by the usage of this bot as per the MIT License. Use this bot on your own risk.

Long-Term Milestones

The development of this bot is working towards specific goals.

  • Code clean-up fab32f9
  • Bot extensions 50b676
  • Lua scripting dfb249
  • Documentation for main application
  • Automated testing
  • Stable release
  • Documentation for extension development
  • Additional extension development
  • Linux and macOS platforms support
  • Headless browser support

Supported Platforms

This bot can only run on Windows platforms due to its Win32 API dependency.

Prerequisites

Getting Started

Installation

# Clone this repository using Git and navigate into its directory.
git clone https://github.com/Frizz925/gbf-autopilot
cd gbf-autopilot

# Install both of the Node.js and Python dependencies.
npm install
pip install -r requirements.txt

# Build the main application and Chrome extension.
npm run build

# Create the configuration files from its sample files.
npm run config

Testing

The test case is currently just a bare minimum and doesn't cover the whole main functionality. It only dry runs the Node.js server and returns.

npm run lint
npm test

Starting the bot

Start the server using npm script.

npm start

Load the browser extension by enabling Developer mode in your browser's extension page and click the Load unpacked extensions... button and navigate to the extension directory of the bot.

Your browser should have the bot's grayscaled icon on the Chrome menu. Open the game and wait until it's loaded. The bot icon should turn on and you can start the bot by clicking the icon. There should be a popup window with the Start button to start the bot.

Stopping the bot

You can either click the bot icon again and click the Stop button to stop the bot. Or, if the bot still takes control of your mouse and keyboard, you can spam press the exit key (default to F1) until the bot stops.

Updating the bot

Right now the only way to update the bot is by using Git as the version control. You can simply run the following commands to update your bot to the latest update.

# Pull the newest update
git pull origin master

# Update and install new packages
npm install
pip install -r requirements.txt

# Rebuild the bot
npm run build

# Create new config files
# WARNING: This will overwrite your old configs!
npm run config

# (optional) Do a test run
npm run lint
npm test

# Start the bot
npm start

Make sure to also reload the Chrome extension in your browser.

UPDATE 2018-03-31

Issues page will be closed by 2018-04-02 due to how trivial most of the bug reports are. Issues page will be re-opened when proper documentation has been made.

License

This software is licensed under the MIT License

About

Granblue Autopilot is an open-source grinding/farming bot for Granblue Fantasy

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 80.0%
  • Python 18.7%
  • HTML 1.3%