Skip to content

Latest commit

 

History

History
100 lines (76 loc) · 3.72 KB

README.md

File metadata and controls

100 lines (76 loc) · 3.72 KB

OUTDATED

Due to heavy changes in the web client and protocol, this project does not work anymore.

gagar

Latest PyPI version Number of PyPI downloads Join the chat at https://gitter.im/Gjum/gagar

Standalone graphical agar.io Python client using GTK and agarnet

Screenshot of gagar

Features

  • mass graph
  • minimap
  • skins
  • show eatability/hostility level of other cells
  • force fields for eatable/hostile cells
  • show/hide anything via key bindings
  • extend with your own plugins (more stats, server chooser, bot, ...)

###Roadmap

  • command-line arguments (nick, gamemode, facebook token)
  • better virus interaction
  • zoom
  • make it work with Ogar
  • documentation (for now, look at the agarnet docs)
  • config file

Installation

First of all, install the GTK dependencies. Under Arch Linux, run

pacman -S python-gobject python-cairo pygtk

Other distros should have similar packages. Someone told me it even works on Mac using MacPorts. If you get it to work, please comment on this issue, so I can add instructions for your system.

The client itself can be installed from PyPI with

pip install gagar

or, if you want to get the source code,

git clone [email protected]:Gjum/gagar.git
cd gagar/
python3 setup.py install

Run the GUI with

gagar -h

Controls

Key Action
S spectate
Q toggle spectate mode
R/RETURN respawn
Mouse movement direction
W shoot small cell
Space split
K explode (disabled on official servers)
C reconnect to any server
I show/hide helpful cell info
N show/hide names
K show/hide skins
M show/hide movement lines
G show/hide grid
B show/hide world border
F1 show/hide overlays
F2 change background color
F3 show/hide FPS meter
ESC quit

About

This is a hobby project of me, on which I work in my free time.

Pull requests are more than welcome, but you should open an issue first, so we can talk about it.

I reverse-engineered the protocol implementation by looking at the (barely) obfuscated Javascript code on the agar.io website. Although it would be much easier now to write a client, because there is a wiki describing the whole protocol and most game mechanics.

If you have any game-related questions, feel free to ask in the #agariomods IRC channel on the Rizon network. For questions about this client specifically, open an issue or write me an email: [email protected]

Disclaimer

This project isn't affiliated with agar.io in any way. When playing with this client, you do not get advertisements, which may be nice for you, but does not pay for the servers needed to run the game.


Licensed under GPLv3.