Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
PyBoy documentation
PyBoy documentation
  • API reference
    • PyBoy
    • Memory view
    • Register file
    • Memory scanner
    • GameShark
    • Rumble
    • Super Game Boy
    • Screen
    • Sound
    • Sprite
    • Tile
    • Tile map
    • Constants
    • Utilities
    • Migrating from v1.x.x to v2.0.0
  • Plugins and game wrappers
    • Plugin base classes
    • Super Mario Bros. Deluxe wrapper
    • Super Mario Land wrapper
    • Tetris wrapper
    • Pandora’s Blocks wrapper
    • Kirby’s Dream Land wrapper
    • Pokemon generation 1 wrapper
    • Pokemon Pinball wrapper
    • 2048 wrapper
  • Development and installation
    • Install and build
      • Install PyBoy on macOS
      • Install PyBoy on Linux
      • Install PyBoy on Windows
    • Getting started
    • Development
    • Contributing
  • Examples
    • Kirby
    • Pokemon Gen 1
    • Pokemon Gen 1 Link Trade (Experimental)
    • Pandora's Blocks
    • Super Mario Bros. Deluxe
    • Super Mario Land
    • Tetris
    • Using PyBoy with Gymnasium
  • Test results
Back to top
View this page

Install and build¶

Install a prebuilt version of PyBoy from PyPI using the guide for your platform, or follow that platform’s source-build instructions:

  • Install PyBoy on macOS

  • Install PyBoy on Linux

  • Install PyBoy on Windows

Next
Install PyBoy on macOS
Previous
Development and installation
Copyright © 2026, Mads Ynddal
Made with Sphinx and @pradyunsg's Furo
PyBoy on GitHub