Install
Requirements
pyglet
All systems require Python 3.9 or higher on a desktop or laptop device.
Web and mobile are currently unsupported.
Windows, Linux, and Intel Mac
Your computer can likely run Arcade if it supports Python 3.9 or higher.
In general, even older convertible Windows tablets will work as long as they:
have an Intel or AMD processor
were made in the last 10 years
Note
ARM-based Windows or Linux tablets may have issues.
These devices may or may not work. the Raspberry Pi and Other ARM SBCs
Windows
To avoid strange issues, install Python as follows:
Download Python from the official Windows download page
While installing, look for a checkbox marked “Add Python to PATH”
When you see it, make sure it is checked before proceeding
Important
Avoid the Microsoft Store version of Python.
It has a history of hard-to-fix bugs which make development more difficult than it needs to be.
M-Series Macs
Apple first released Macs with M-series processors in 2020. They may have a few issues with window focus and unsigned applications. If something odd happens, you can always ask for help..
Raspberry Pi and Other ARM SBCs
The Arcade and pyglet
teams have verified the Raspberry Pi 4 and 5
as working. The Raspberry Pi 400 will also likely work, but other Pi models will not.
To learn more, please see:
Using pip
Tip
For beginners unfamiliar with Python, a more in depth guide to installing Python and Arcade can be found in the The Arcade Book.
The most common way to install Arcade is to use the pip
package manager.
This will install the latest version of Arcade from PyPI.
pip install arcade
If you are installing Arcade directly into your system Python, meaning
you are not using a virtual environment (or don’t know what that is),
you may need to use the --user
flag to install Arcade just for your user.
pip install arcade --user
Upgrading an existing installation of Arcade can be done with the following command:
pip install -I https://github.com/pythonarcade/arcade/archive/refs/heads/development.zip
The -I
flag is used to force reinstall the package completely ignoring what you have installed.
Development version
Pre-releases of Arcade may appear on PyPI using the dev suffix. It’s also quick and easy to install the latest development version from github
If you prefer to install from git:
git clone https://github.com/pythonarcade/arcade
cd arcade
pip install -e .
This installs Arcade in editable mode, so you can make changes to the code and see the changes immediately. Also consider forking the repository on github installing your fork instead.
Running examples
Arcade comes with a rich set of examples that demonstrate basic usage of the library.
To test that the installation was successful, check out the Examples section and run one or more of the examples. The command to run the example is in the header of each example file.
For example:
python -m arcade.examples.sprite_explosion_bitmapped
Batteries Included
Built-In Resources mean you’re ready to start right away. Since all of Arcade’s assets are Public Domain Assets or similarly licensed, you’re free to create games however you like.
The Built-In Resources page lets you preview Arcade’s built-in assets
The Platformer Tutorial will help you get started right away