Merge branch 'release-0.0.8'

.gitignore

@@ -15,8 +15,6 @@ dist/
 downloads/
 eggs/
 .eggs/
-lib/
-lib64/
 parts/
 sdist/
 var/

CHANGELOG.rst

@@ -1,3 +1,14 @@
+0.0.8
+-----
+
+* Party mode implementation (creation and joining).
+* Better mouse control.
+* Game recording and replaying.
+* Documentation.
+* Leaderboard.
+* Windows installer.
+
+
 0.0.3
 -----
 

README.rst

@@ -1,110 +1,18 @@
-pyagar
-======
-
-``pyagar`` is a python client for the popular online game **agar.io**.
-
-This package allows you to play the game, see the gameplay as an spectator
-and also play automatically with the **auto** feature.
-
-.. image:: docs/images/shot.png
-   :alt: Screenshot
-   :align: center
-
-
-Dependencies
-------------
-
-In order to run this software you'll need:
-
-- Python 3.4+
-- SDL2 (you may found it in your distribution as libsdl2)
-- sdl2_ttf https://www.libsdl.org/projects/SDL_ttf/
-- sdl2_gfx http://cms.ferzkopp.net/index.php/software/13-sdl-gfx
-
-
-Installation
-------------
-
-It is recomended to install this package into a virtualenv.
-
-
-Stable version
-~~~~~~~~~~~~~~
-
-.. code-block:: bash
-
-   $ pip install pyagar
-
-
-Usage
------
-
-Command
-~~~~~~~
-
-This package creates the command ``pyagar``.
-
-.. code-block:: bash
-
-   $ pyagar --help
-   usage: pyagar [-h] [--no-visualize] [-n NICK] [--auto] [--debug] [--spectate]
-
-    optional arguments:
-      -h, --help            show this help message and exit
-      --no-visualize
-      -n NICK, --nick NICK
-      --auto
-      --debug
-      --spectate
-
-
-Controls
-~~~~~~~~
-
-=========== ============================================
-Action      Control
-=========== ============================================
-Move        Mouse (Relative to the center of the window)
-Start       Mouse (Left button)
-Eject       ``W`` key
-Split       ``Space`` key
-Fullscreen  ``F`` key
-Zoom        Mouse wheel
-Exit        ``ESC`` key
-=========== ============================================
-
-
-Play examples
--------------
-
-Just play
-~~~~~~~~~
-
-.. code-block:: bash
-
-   $ pyagar play
-
-Press the left mouse button to start.
-
-
-Just watch the game
-~~~~~~~~~~~~~~~~~~~
-
-.. code-block:: bash
-
-   $ pyagar spectate
-
-
-Play automatically using a bot
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. code-block:: bash
-
-   $ pyagar bot --type=EatWhenNoPredators
-
-
-Other implementations
----------------------
-
-- https://github.com/Gjum/pyAgar.io
-- https://github.com/Raeon/pygar
+pyagar
+======
+
+``pyagar`` is a python client for the popular online game at http://agar.io.
+
+.. warning::
+
+   This software is not the official client and is not associated in any
+   manner with the original website.
+
+This package allows you to play the game, see the gameplay as an spectator,
+record and replay games and also develop your own bot.
+
+Please, `checkout the documentation`_ for further instructions.
+
+Enjoy!
+
+.. _`checkout the documentation`: http://pyagar.readthedocs.org

docs/source/cmd.rst

@@ -0,0 +1,7 @@
+Command Line Interface
+======================
+
+.. argparse::
+   :module: pyagar.cmdline
+   :func: pyagar_parser
+   :prog: pyagar

docs/source/conf.py

@@ -33,6 +33,7 @@
     'sphinx.ext.intersphinx',
     'sphinx.ext.todo',
     'sphinx.ext.viewcode',
+    'sphinxarg.ext'
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -56,9 +57,14 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.0.2'
+import pkg_resources
+try:
+    VERSION = pkg_resources.get_distribution("pyagar").version
+except pkg_resources.DistributionNotFound:
+    VERSION = 'develop'
+version = VERSION
 # The full version, including alpha/beta/rc tags.
-release = '0.0.2'
+release = VERSION
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -103,7 +109,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
+# html_theme = 'classic'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

docs/source/controls.rst

@@ -0,0 +1,15 @@
+Controls
+========
+
+
+=============== ========== ==========
+Action          Peripheral Detail    
+=============== ========== ==========
+**Eject**       Keyboard   ``W``
+**Exit**        Keyboard   ``ESC``   
+**Fullscreen**  Keyboard   ``F``
+**Move**        Mouse                
+**Split**       Keyboard   ``Space``
+**Start**       Mouse      ``Left``
+**Zoom**        Mouse      ``Wheel``
+=============== ========== ==========

docs/source/index.rst

@@ -1,20 +1,36 @@
-.. pyagar documentation master file, created by
-   sphinx-quickstart on Sun Jul  5 13:38:59 2015.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+.. include:: ../../README.rst
 
-Welcome to pyagar's documentation!
-==================================
 
-Contents:
+User documentation
+------------------
 
 .. toctree::
-   :maxdepth: 2
 
+   install
+   cmd
+   controls
+
+
+Developer documentation
+-----------------------
+
+.. toctree::
+
+   pycode
+
+
+.. include:: ../../CHANGELOG.rst
+
+
+Other Implementations
+---------------------
+
+- https://github.com/Gjum/pyAgar.io
+- https://github.com/Raeon/pygar
 
 
 Indices and tables
-==================
+------------------
 
 * :ref:`genindex`
 * :ref:`modindex`

docs/source/install.rst

@@ -0,0 +1,30 @@
+Installation
+============
+
+Dependencies
+------------
+
+You'll need some software in order to run ``pyagar``.
+
+- Python_ >= 3.4
+- libsdl2_
+- libsdl2-gfx_
+- libsdl2-ttf_
+
+
+Linux
+-----
+
+Ubuntu 15.04
+~~~~~~~~~~~~
+
+.. code-block:: bash
+
+   $ sudo apt-get install python3 python3-pip libsdl2-2.0-0 libsdl2-gfx-1.0-0 libsdl2-ttf-2.0-0
+   $ sudo pip3 install pyagar
+
+
+.. _Python: http://www.python.org/
+.. _libsdl2: https://www.libsdl.org/
+.. _libsdl2-gfx: http://cms.ferzkopp.net/index.php/software/13-sdl-gfx
+.. _libsdl2-ttf: https://www.libsdl.org/projects/SDL_ttf/

docs/source/pycode.rst

@@ -0,0 +1,20 @@
+.. automodule:: pyagar.client
+   :members:
+
+.. automodule:: pyagar.cmdline
+   :members:
+
+.. automodule:: pyagar.control
+   :members:
+
+.. automodule:: pyagar.log
+   :members:
+
+.. automodule:: pyagar.messages
+   :members:
+
+.. automodule:: pyagar.utils
+   :members:
+
+.. automodule:: pyagar.visual
+   :members:

installer.cfg

@@ -0,0 +1,20 @@
+[Application]
+name=pyagar
+version=0.0.8
+entry_point=pyagar.cmdline:winlaunch
+console=false
+icon=data/pyagar.ico
+
+[Python]
+version=3.4.0
+bitness=32
+
+[Include]
+# Importable packages that your application requires, one per line
+packages=sdl2
+    requests
+    tabulate
+    websockets
+
+# Other files and folders that should be installed
+files=lib/