splatbot 0.1.0

Automate plotting detailed posts in Splatoon wirelessly based on BlueZ, and optimize its efficiency by treating the process as a variant of Traveling Salesman Problem (TSP).

splatbot

Automate plotting detailed posts in Splatoon wirelessly based on BlueZ, and optimize its efficiency by treating the process as a variant of Traveling Salesman Problem (TSP).

Installation

BlueZ is a Bluetooth protocol stack included with the official Linux kernel distributions. If you have a Linux machine with a Bluetooth connection, then things become easier:

$ sudo pip install splatbot

If you're using macOS or Windows, an external Bluetooth adapter is needed and please follow the instructions below:

1. Install VirtualBox
2. Install VirtualBox Extension Pack
3. Install Vagrant
4. Clone splatbot and make a Vagrantfile:

   $ git clone https://github.com/necusjz/splatbot.git
   $ cd splatbot/vagrant
   $ ./make_vagrantfile.py
   

After that, a Vagrantfile will be generated and the current directory is the location where you run any Vagrant command.

Usage

Generate the macro represents the actual plotting process:

$ splatbot macro -i <image>

Start plotting the post and display the current progress:

$ splatbot start -i <macro>

Vagrant commands

Create and configure guest machines according to your Vagrantfile:

$ vagrant up

SSH into a running Vagrant machine and give you access to a shell:

$ vagrant ssh

Shut down the running machine Vagrant is managing:

$ vagrant halt

Stop the running machine Vagrant is managing and destroy all resources that were created during the machine creation process:

$ vagrant destroy

Contributing

We love contributions! Before submitting a Pull Request, it's always good to start with a new issue first.

License

This repository is licensed under MIT. Full license text is available in LICENSE.