The Python Arcade Library
=========================

.. raw:: html

    <table style="width:100%;">
      <tr>
        <td>
          <img style="width:50px;" src="_static/character.png"><br/>
          <h2><a href="examples/index.html">Examples</a></h2>
          <ul>
          <li><a href="examples/drawing_primitives.html">Drawing Primitives</a></li>
          <li><a href="examples/bouncing_rectangle.html">Bouncing Rectangle</a></li>
          <li><a href="examples/asteroid_smasher.html">Asteroid Smasher</a></li>
          </ul>
        </td>
        <td>
          <img style="width:78px;" src="_static/download.svg"><br/>
          <h2><a href="installation.html">Installation</a></h2>
          <ul>
          <li><a href="installation_windows.html">Windows</a></li>
          <li><a href="installation_mac.html">Mac</a></li>
          <li><a href="installation_linux.html">Linux</a></li>
          </ul>
        </td>
      </tr>
      <tr>
        <td>
          <img style="width:78px;" src="_static/ereader.svg"><br/>
          <h2><a href="quick_index.html">Quick API Index</a></h2>
        </td>
        <td>
          <img style="width:78px;" src="_static/weixin-logo.svg"><br/>
          <h2><a href="pygame_comparison.html">Pygame Comparison</a></h2>
        </td>
      </tr>
    </table>
    <p></p>
.. raw:: html

    <iframe src="https://player.vimeo.com/video/167449640?byline=0&portrait=0" width="640" height="480" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
    <p><a href="https://vimeo.com/167449640">The Python Arcade Library Overview</a></p>

Arcade is an easy-to-learn Python library for creating 2D video games. It is
ideal for people learning to program, or developers that want to code a 2D
game without learning a complex framework.

Learn about it:
^^^^^^^^^^^^^^^

* :ref:`installation-instructions`
* :ref:`example-code`
* :ref:`arcade-api`
* :ref:`quick-index`
* `Arcade on PyPi`_
* :ref:`pygame-comparison`

Give feedback:
^^^^^^^^^^^^^^

* `GitHub Arcade Issue List`_
* `Reddit Discussion Group`_
* Email: paul.craven@simpson.edu

Contribute to the development:
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

* :ref:`how-to-contribute`
* `GitHub Source Code for Arcade`_

The status of the build is here: |build-status-travis| |build-status-appveyor| |coverage|

Examples
--------

.. toctree::
   :maxdepth: 4

   examples/index

Installation
------------

.. toctree::
   :maxdepth: 4

   installation

API Documentation
-----------------

.. toctree::
   :maxdepth: 4

   arcade
   quick_index

How to Contribute
-----------------

.. toctree::
   :maxdepth: 1

   how_to_contribute
   directory_structure
   how_to_compile
   how_to_submit_changes

More Information
----------------

.. toctree::
   :maxdepth: 1

   pygame_comparison.rst
   suggested_curriculum.rst

.. automodule:: arcade

.. include:: ../license.rst

.. |build-status-travis| image:: https://travis-ci.org/pvcraven/arcade.svg
    :target: https://travis-ci.org/pvcraven/arcade
    :alt: build status

.. |build-status-appveyor| image:: https://ci.appveyor.com/api/projects/status/github/pvcraven/arcade
    :target: https://ci.appveyor.com/project/pvcraven/arcade-ekjdf
    :alt: build status

.. |coverage| image:: https://coveralls.io/repos/pvcraven/arcade/badge.svg?branch=master&service=github
    :alt: Test Coverage Status
    :target: https://coveralls.io/github/pvcraven/arcade?branch=master

.. _GitHub Source Code for Arcade: https://github.com/pvcraven/arcade
.. _GitHub Arcade Issue List: https://github.com/pvcraven/arcade/issues
.. _Arcade on PyPi: https://pypi.python.org/pypi/arcade
.. _Reddit Discussion Group: https://www.reddit.com/r/pythonarcade/