Skip to content

Gadgetoid/python-airmash

Repository files navigation

python-airmash

Python client API for Airma.sh

This is an experimental Python client which uses construct to handle parsing of binary data from the server to the client, and encoding of binary packets from the client to the server.

All of the client<->server packets are implemented, but not all of them have been fully tested. There's lots still to do!

How To

Build Your Bot

While there's still a lot to do in python-airmash, including integrating missile and player trajectories over time, you can still begin to create your bot.

Start with test-client.py which demonstrates connecting to a server, and handling some basic messages.

test-client.py implements a stoppable thread pattern to act as the "brains" of your bot.

Watch Your Bot

If you pick a sufficiently unique name, you can connect to the server containing your bot using the Airma.sh browser client. Then:

  • Press V to enter spectator mode
  • Type /spectate bot_name to spectate your bot

Feedback / Contributions

Discuss this project on the unofficial Airmash Discord server: https://discord.gg/FuwGezZ

Objectives

This library is intended to be a set of tools for building Airmash client applications such as bots, stats monitors, chat clients, etc.

This library is by no means intended to be a complete Airmash client. You should implement your own display/analysis routines, or log in to Airma.sh and spectate your bot for diagnosis.

This library is entirely unofficial and all commands are reverse-engineered from the Javascript client. As such it may not be 100% correct, and may break with new game releases.

Requirements

This project requires Python3, as well as the packages 'construct' and 'websocket-client', and dependencies thereof.

About

Python client API for Airma.sh

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages