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

.. raw:: html

    <table style="width:100%;">
      <tr>
        <td>
          <div style="display:inline-block;">
            <img style="width:50px;" src="_static/character.png">
          </div>
          <div style="display:inline-block;">
            <h2 style="width:auto;">Example Code</h2>
          </div>
          <ul>
          <li><a href="examples/index.html">All Examples</a></li>
          <li><a href="examples/sprite_collect_coins.html">Collect Coins</a></li>
          <li><a href="examples/asteroid_smasher.html">Asteroid Smasher</a></li>
          <li><a href="examples/platform_tutorial/index.html">Platformer Tutorial</a></li>
          </ul>
        </td>
        <td>
          <div style="display:inline-block;">
            <img style="width:78px;" src="_static/download.svg"><br/>
          </div>
          <div style="display:inline-block;">
            <h2 style="width:auto;">Installation</h2>
          </div>
          <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>
          <li><a href="installation_from_source.html">Install From Source</a></li>
          </ul>
        </td>
      </tr>
      <tr>
        <td>
          <div style="display:inline-block;">
            <img style="width:78px;" src="_static/ereader.svg"><br/>
          </div>
          <div style="display:inline-block;">
            <h2>API</h2>
          </div>
          <ul>
          <li><a href="quick_index.html">Quick API Index</a></li>
          <li><a href="arcade.html">Full Arcade API Docs</a></li>
          <li><a href="quick_index.html#drawing-module">Drawing</a> - <a href="arcade.csscolor.html">CSS Colors</a></li>
          <li><a href="quick_index.html#application-module">Window Class</a></li>
          <li><a href="quick_index.html#sprite-module">Sprites</a></li>
         </ul>
        </td>
        <td>
          <div style="display:inline-block;">
            <img style="width:78px;" src="_static/weixin-logo.svg"><br/>
          </div>
          <div style="display:inline-block;">
            <h2>Social</h2>
          </div>
          <ul>
            <li><a href="https://twitter.com/ArcadeLibrary">Twitter @ArcadeLibrary</a></li>
            <li><a href="https://www.instagram.com/PythonArcadeLibrary/">Instagram @PythonArcadeLibrary</a></li>
            <li><a href="https://www.facebook.com/ArcadeLibrary/">Facebook @ArcadeLibrary</a></li>
            <li><a href="https://www.reddit.com/r/pythonarcade/">Reddit /r/pythonarcade</a></li>
            <li><a href="diversity.html">Statement on Diversity</a></li>
          </ul>
        </td>
      </tr>
      <tr>
        <td>
          <div style="display:inline-block;">
            <img style="width:78px;" src="_static/sample_games.svg">
          </div>
          <div style="display:inline-block;">
            <h2>Games</h2>
          </div>
          <ul>
            <li><a href="sample_games.html">Example Games</a></li>
            <li><a href="instructions_gameshell.html">GameShell (Hand-held like a GameBoy)</a></li>
            <li><a href="examples/pyinstaller.html">Distributing games with PyInstaller</a></li>
          </ul>
        </td>
        <td>
          <div style="display:inline-block;">
            <img style="width:78px;" src="_static/code.svg">
          </div>
          <div style="display:inline-block;">
            <h2>Source Code</h2>
          </div>
          <ul>
            <li><a href="https://github.com/pvcraven/arcade">GitHub</a></li>
            <li><a href="release_notes.html">Release Notes</a></li>
          </ul>
        </td>
      </tr>
      <tr>
        <td>
          <div style="display:inline-block;">
            <img style="width:78px;" src="_static/speedometer-icon.svg">
          </div>
          <div style="display:inline-block;">
            <h2>Performance</h2>
          </div>
          <ul>
          <li><a href="performance_tips.html">Performance Tips</a></li>
          <li><a href="pygame_comparison.html">Pygame Comparison</a></li>
          </ul>
        </td>
        <td>
          <div style="display:inline-block;">
            <img style="width:78px;" src="_static/owl.svg">
          </div>
          <div style="display:inline-block;">
            <h2>Learn</h2>
          </div>
          <ul>
            <li><a href="http://arcade-book.readthedocs.io/en/latest/">Learn to Program with Arcade</a></li>
            <li><a href="https://youtu.be/DAWHMHMPVHU">PyCon 2018 Talk</a></li>
            <li><a href="https://youtu.be/Djtm1DzWSvo">PyCon 2019 Tutorial</a></li>
           </ul>
        </td>
      </tr>

    </table>
.. raw:: html

    <div style="padding:56.25% 0 0 0;position:relative;"><iframe src="https://player.vimeo.com/video/167449640?byline=0&portrait=0" style="border:0;position:absolute;top:0;left:0;width:100%;height:100%;" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe></div><script src="https://player.vimeo.com/api/player.js"></script>
    <p><a href="https://vimeo.com/167449640">Quick Arcade Library Introduction Video</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.


.. toctree::
   :maxdepth: 4

   quick_index
   arcade
   installation
   examples/index
   examples/platform_tutorial/index
   sample_games
   performance_tips
   how_to_contribute
   directory_structure
   how_to_compile
   how_to_submit_changes
   diversity
   distribute_macos
   instructions_gameshell
   pygame_comparison.rst
   suggested_curriculum.rst

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

* `Arcade on PyPi`_
* :ref:`pygame-comparison`

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

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

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

* `GitHub Source Code for 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/