:hide-toc:


.. _main_page:

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


.. container:: main-page-item-wrapper-header

    .. raw:: html

        <div class="main-page-box">
            <div class="main-page-link">
            </div>
            <div class="main-page-box-gh">
               <iframe id="github-stars" style="align-self: center; margin: 0 auto; display: block;"
                        src="https://ghbtns.com/github-btn.html?user=pythonarcade&repo=arcade&type=star&count=true&size=large"
                        frameborder="0"
                        scrolling="0"
                        title="GitHub">
               </iframe>
            </div>
        </div>

Arcade is an easy-to-learn Python library for creating 2D games and more. The
friendly API caters to both beginners and experts alike. Do you want to make
something small, or explore the full power of shaders? It's up to you.

What will you make?

.. raw:: html

   <div>
    <div style="padding:55% 0 0 0;position:relative;">
      <iframe class="vimeo-video" src="https://player.vimeo.com/video/662273899?h=31bf92c415&amp;badge=0&amp;autopause=0&amp;player_id=0&amp;app_id=58479" allow="autoplay; fullscreen; picture-in-picture" allowfullscreen title="Arcade Demo.mp4"></iframe>
    </div><script src="https://player.vimeo.com/api/player.js"></script>
    <p><a href="https://vimeo.com/662273899">Quick Arcade Library Introduction Video</a></p>
   </div>

Documentation and Community
---------------------------

Arcade provides documentation for every experience level.

The :ref:`skill_tree` or :ref:`main-page-tutorials` are good
for getting started. You can explore the following to
learn more:

* :ref:`faq` has fast answers to common questions
* :ref:`intro_learning_resources` covers the documentation types
* :ref:`how-to-get-help` if you're unsure where to start

.. pending: #2433 https://github.com/pythonarcade/arcade/issues/2433
.. raw:: html

   <br/>

More than Open Source
---------------------

Arcade makes sure licensing concerns stay out of your way:

* Arcade's code uses the :ref:`permissive_mit`
* :ref:`The built-in resources <resources>` don't require attribution
* Remixing :ref:`example code <example-code>` is encouraged

.. pending: #2433 https://github.com/pythonarcade/arcade/issues/2433
.. raw:: html

   <br/>

This ensures you are free to create, including :ref:`commercial projects <faq_commercial>`.

Get Involved
------------

Let us know if you see a bug, a typo, or other room for improvement.

The following :ref:`community-locations` are the best places
to reach the team or ask for help:

* The `Arcade Discord`_ server
* The `Arcade GitHub`_ repo

.. pending: #2433 https://github.com/pythonarcade/arcade/issues/2433
.. raw:: html

   <br/>

See :ref:`how-to-contribute` to learn how you can
help improve Arcade.

.. pending: #2433 https://github.com/pythonarcade/arcade/issues/2433
.. raw:: html

   <br/>

.. The main table of contents defining the sidebar navigation
   This content is not part of the main page itself.

.. toctree::
   :hidden:
   :maxdepth: 1
   :caption: About

   about/intro
   about/faq
   about/permissive_licensing
   about/for_academia

.. toctree::
   :hidden:
   :maxdepth: 1
   :caption: Getting Started

   get_started/install
   example_code/index
   tutorials/index
   get_started/arcade_book
   api_docs/resources

.. toctree::
   :hidden:
   :maxdepth: 1
   :caption: Manual

   programming_guide/sprites/index
   programming_guide/keyboard
   programming_guide/sound
   programming_guide/textures
   programming_guide/event_loop
   programming_guide/camera
   programming_guide/sections
   programming_guide/gui/index
   programming_guide/texture_atlas
   programming_guide/resource_handlers
   programming_guide/opengl_notes
   programming_guide/gles_raspi_and_sbc
   programming_guide/performance_tips
   programming_guide/headless

.. toctree::
   :hidden:
   :maxdepth: 1
   :caption: Contributing

   contributing/index

.. toctree::
   :hidden:
   :maxdepth: 1
   :caption: Community

   community/community_locations
   community/how_to_get_help
   community/games/index

.. toctree::
   :hidden:
   :maxdepth: 1
   :caption: API Reference

   api_docs/quick_index
   api_docs/arcade


.. Indices and tables
.. ==================

.. * :ref:`genindex`
.. * :ref:`modindex`