adessose / anki-battle-showcase

Anki Battle Showcase

ANKI Battle Showcase is a showcase racing game. It offers a racing and a battle mode, integrating custom bots and rulessets. Its purpose is to integrate a framework for creating custom behavior. For this we used Node-Red.

Prerequisites

• JDK
• Node
• Maven
• Bluetooth Gateway (e.g. Raspbery pi) (if using real Anki Vehicles. see https://github.com/adessoAG/anki-drive-java)

Installation

• Checkout this repository
• Run 'mvn install' in root directory
• Run 'npm install' in root directory
• Run 'npm install node-red-contrib-mqtt-broker' to install the MQTT broker

Usage

• Run 'npm run node-red' to start the Node-Red server
• define rules for vehicles (see example flow for help)
• Configure Simulation in /src/main/java/de/adesso/anki/battle/initializers/SimulationInitializer.java
• Run Spring Boot Application

Usage (Anki)

• Bluetooth gateway is necessary

Modes

• Simulation
• Anki

Supported Weapon Types

• Rocket
• Mine

Disclaimer

The authors of this software are in no way affiliated to Anki. All naming rights for Anki, Anki Drive and Anki Overdrive are property of Anki.

anki-battle-showcase's Issues

Update Readme

This seems like an interesting application. I have some suggestions that would enhance the readme.

• Description

• How to Start

• Known Issues

• License

Thanks in advance :)

Create custom input and output nodes for vehicles

Currently, flows in Node-RED rely on the stock mqtt and json nodes.
Input and output should be wrapped in custom nodes instead for easier use.

Create presentation slides

For showing the project at conferences, fairs and other events, some presentational slides would be nice to have. The slides should contain:

• General idea of the project
• Architecture diagram
• Screenshots of Node-RED
• Technical details on Anki operation

See the slides on the original InVerSiV project for reference.

Create start script for running Node-RED and application

A batch start script should be provided as an entrypoint for users.
This script should run Node-RED and the Java application itself.

Conditional nodes should pass-through the original object

This allows multiple conditions to be checked in a flow to form complex conditions.
Chaining two conditional nodes would create a simple AND gate.

Consistently use English language throughout project

There are some occurences of German in the frontend and the Node-RED nodes.
German localization might be added later as an option.

Port original InVerSiV showcase to Node-RED

It would be nice to present the original showcase without changing applications.
The behavior would also be a cool example for custom logic in Node-RED.

Setup automated builds via TravisCI

TravisCI can build the project on every commit and show success or failure on GitHub.

Provide sample behavior as Node-RED library content

It would be nice to have some sample behavior to check out before implementing own ideas.
This could be stored as a Node-RED library and imported into the current flow.

Scanning the roadmap fails when starting with right curve

Scanning the roadmap fails when starting with a right curve.
The vehicle will just continue scanning without noticing the scan is complete.

Enforce consistent code style via SonarQube

SonarQube can check code style and quality on every commit.

Extract gateway IP address to configuration file

The Anki gateway's IP address is currently hardcoded in the AnkiInitializer class.
This should be extracted to the application.properties file.

Correctly handle intersection roadpieces

The application is currently not compatible with intersection roadpieces.
Using it in the roadmap will not crash the application but lead to inconsistent behavior.

Provide documentation

Nobody likes documenting their code when there is so much more to do.
But it has to be done eventually.

Different Icons for mines and rockets

see title

Include vehicle name in MQTT state

This removes the need to configure the vehicle output node in Node-RED.

Extract Anki vehicle creation to frontend methods

Currently, a single Anki vehicle is created on startup in the AnkiInitializer class.
This should be refactored to be a frontend method.