Pygame changelog

Changelog History

• v2.0.0 Changes

  October 28, 2020

  🚀 The 28th of October 2020 is the pygame 2.0 release date, because pygame turns 20 years of age.

  ---

   ,--. | oo| | ~~| ooooooooooooo|/\/\| python3 -m pip install pygame==2.0.0
  

  What's the best feature of pygame 2? Maybe it's " backwards compatibility". For many, many apps pygame 2 is backwards compatible. Have an pygame app from the year 2000? It will probably work. We still have some known issues and open backwards compatibility issues(see below), but a lot of things work just as they did before. Yes, we still have python 2 support.

  How does one summarize the 3306 changes since we started the pygame 2 series in July of 2018 based on patches going back to 2012 and even earlier?

  • 👌 Support for Metal, Direct 3d, Vulkan, OpenGL 3.0+ in various profiles (core, compatibility, debug, robust, etc), OpenGL ES, and other modern hardware accelerated video APIs across many platforms.
  • SSE2/Neon assembly image drawing. Much faster drawing routines, image loading, and alpha blending.
  • Type Hints, for code completion (and to help you make the squiggly lines disappear) in editors and IDEs.
  • Code cleanup, using lots of code robustness tools like static analyzers, and automated CI/CD. We've been able to help dozens of people new to community projects contribute. We have lots of work to go on code quality, but we're currently the highest rated Python and highest rate C large project on LGTM.
  • 🛠 Many, many bug fixes including in our pygame.draw routines, pygame.math(for vectors), and pygame.mask for pixel perfect collision detection.
  • 👍 better support for PyPy (the fast JIT based implementation of python). See our milestone Are we pypy yet? No. for our progress on making PyPy the best python for games.
  • 🚚 libsdl version 2 support. Technically pygame 2.0 still works with SDL 1, but we recommend SDL2 which is vastly improved over SDL1 for most use cases. Probably we will remove SDL 1 support starting pygame 2.1.
  • 👍 Touch support (multitouch, gestures, etc)
  • 👍 Audio input support (make games with your microphone!).
  • Message alert boxes (Press OK, or Cancel).
  • 👍 Better keyboard support. Proper unicode input and IME support.
  • 👍 Much improved game controller support.
  • 👍 Better image and audio format support. Including: webp, 32bit wav files, and much more reliable mp3 support.
  • 👍 Multiple display support, and multiple window support (multi window support is still experimental, more will come in pygame 2.1).
  • 📚 Android support through python for android (fork of pygame subset for android). Better documentation, and better support will come in future releases.
  • to make distributing your apps easier, a built in "pyinstaller hook"and compatibility with cxfreeze.
  • ✅ binary "wheels" on many platforms and versions of python from the old python 2.7 - to the latest python 3.9 (and with pypy!).
  • 👍 lots of quality of life improvements like Surface.fill('black') instead of Surface.fill(pygame.Color(0, 0, 0)). Also keywords are supported for many more function arguments. You can draw rounded corners on rects.
  • plenty of new examples, like python3 -m pygame.examples.font_viewer, and python3 -m pygame.examples.music_drop_fade. Additionally the example source code has been cleaned up a lot to follow a more current python style.
  • 📚 Hundreds of documentation improvements, include a new Korean tutorial.
  • 🌐 a special SCALED mode which takes low pixel games and automatically translates them to a larger window. Imagine your 320x200 resolution game of glorious pixel art... on modern screens that would be a very tiny windows. Now with SCALED it shows up big on a Full HD screen, or even a 4K/8K screen and the translation of mouse coordinates and up-scaling of pixels is done for you (hardware accelerated of course).

  🚀 That was a summary of some of the goodies in pygame 2. We will be releasing more articles and tutorials on new features as time goes on. You can also look at the previous release notes for more info (see end of this post).

  🍱 thank you 🎉

  🚚 Probably one of the better realizations thinking about pygame on its 20th birthday is that there is a much larger group of people who have contributed to crafting pygame in recent years. Some have moved onto other things like jobs, family or writing cookbooks in the Canadian wilderness. Much respect for volunteering time to a community project like pygame.

  Firstly thanks to the pygame team members who contributed to the pygame 2 series, new and old...

  👷 David Lönnhager (@dlon) | René Dudfield (@illume) | Charles (@charlesej) | Dan Lawrence (@MyreMylar) | Ankith (@ankith26) | Niels Thykier (@nthykier) | Lenard Lindstrom (@llindstrom) | Sigurður Sveinn Halldórsson (@siggisv) | @robertpfeiffer | Josip Komljenović (@MightyJosip) | Travis Chang (@Reminisque) | xFly_Dragon (@husano896) | Adam Andrews (@adamandrews1) | (@galexandreg) | Thiago Jobson (@thiagojobson) | (@mcpalmer1980) | @charlesoblack | Daniel Pope (@lordmauve) | Thomas Kluyver (@takluyver) | @e1000 | Andy Nguyen (@anguye13) | @Starbuck5 | Ian Mallett (@imallett)

  Equally important thank you go out to all the other contributors, some of which contributed to a community project for the first time.

  👀 Pedro de la Peña @pedrodelapena | @lkito | @khuang0312 | @tsadama | @Bottersnike | @alphaCTzo7G | Amos Bastian (@amosbastian) | Andrey Lopukhov (@andreyx86) | Augusto Noronha (@augusto2112) | Bernardo Sulzbach (@bernardosulzbach) | (@Bottersnike) | Cai Q.T. (@CAIQT) | (@Cerealdragon) | (@ChrisWeissNike) | (@cmtrapp02) | Daniel Molina (@daniel-molina) | David Caughell (@DavidCaughell) | (@dr0id) | burmer (@dtschirmer) | (@IchMageBaume) | (@LambdaGoblin) | François Magimel (@Linkid) | (@LiquidFenrir) | Mark Hurley (@markph0204) | Marius Gedminas (@mgedmin) | (@metulburr) | Michael Farrell (@micolous) | Dominik George (@Natureshadow) | Nik (@nikolas) | Nunu-Willump (@Nunu-Willump) | (@pleboulanger) | Rebecca Chen (@rchen152) | (@robertpfeiffer) | Sett (@sw00) | @seenemikk | Nguyễn Gia Phong (@McSinyx)| Sebastian Henz | @BastiHz | Alice Lia Stapleton (@slimelia)

  raphacosta27 (@raphacosta27) | Bill (@AdditionalPylons) | Gabriel Moreira (@gabsmoreira) | zoldalma999 (@zoldalma999) | amipy (@amipy) | DGMcKenney (@DGMcKenney) | Grigoris Tsopouridis ((@gtsopus)) | Ilia Gogotchuri (@Gogotchuri) | Jim Quach (@jiquach) | Aaron Li (@AaronLi) | Clark Seanor (@cruxicheiros) | K Duggan (@kduggan15) | Michał Górny (@mgorny) | Clark Seanor (@cruxicheiros) | jtoloff (@jtoloff) | 41aaronb (@41aaronb) | Prasanna Venkatesh (@hanzohasashi33) | zoldalma999 (@zoldalma999) | Nihal Mittal (@codescientist703) | leopoldwe (@leopoldwe) | Scott Noyes (@snoyes)

  Vicente González Ruiz (@vicente-gonzalez-ruiz)| Douglas (@douglas-cpp) | wuzh07 (@wuzh07) | Gerardo Antonio Hagad (@ginohagad) | Evan Kanter (@evank28) | Inada Naoki (@methane) | Jani Tiainen (@jtiaicomparison) | Christian Clauss (@cclauss) | Gosha Zacharov (@Gosha) | Steven Chua (@Graphcalibur) | K Duggan (@kduggan15) | PeanutbutterWarrior (@PeanutbutterWarrior) | Nachiket Naganure (@NachiketUN) | Pierre Haou (@pierrehaou) | Daniel Gillet (@dangillet) | Stefano Rivera (@stefanor) | Andre Miras (@AndreMiras) | glennmackintosh (@glennmackintosh) | Vilhelm Prytz (@vilhelmprytz) | DotMars (@DotMars) | Gabriel Duque (@zuh0) | Mark Hurley (@markph0204) | Henrik Petersson (@hnrkcode) | Grigoriy (@flaambe) | Matt Sheppard (@mampersat) | s0lst1ce (@s0lst1ce) | Norman Packard (@nhpackard) | peanutbutterandcrackers (@peanutbutterandcrackers)

  🍱 A special thanks to all the people who help out others. From making videos, to answering questions, to writing guides (and even whole books). MyreMylar, MichaelCPalmer, jtiai, claudeb, DaFluffyPotato, Rabbid76, The Big Kahuna, sloth, Kingsley, ... and lots of other people. Thanks to the mods on forums, chat rooms and Q&A sites. Special thanks to Zireael07 for cheering on pull requests that people make 🎉 Thanks to people adding support and integration to libraries and tools like pgzero(lordmauve and co), Mu Editor (Nicholas and team), and pymunk (Victor Blomqvist). Very many people have contributed by reporting issues. This is fantastic help for people 👏 👏 👏 Without these issue reports and help in testing bugs and new features many parts simply wouldn't work. Thanks to the SDL folk, to the fluidsynth crew, to numpy devs (Matti and co), python for android, pypy project, and the python community at large. Thanks to the folks running game jams like ludumdare(Mike), pyweek(lordmauve), and alakajam. Thanks to renpytom for pygame subset for android and pygame_sdl2, thanks to Marcus von Appen for pysdl2. Thanks to people sharing your work with others on the pygame website, or on places like the pygame reddit, discord, or youtube. Thanks to the kind folk who work on packaging pygame from Debian, Ubuntu, Arch, FreeBSD, and piwheels (@bennuttall). Thanks for the people teaching and learning with pygame all over the world. Last but not least... a very special thanks to everyone we've missed that should be listed here.

  Really. Thank you (you). Thanks.

  Known issues

  We have an up to date list of issues marked with the Compatibility Python 2 label. These are compatibility issues where something worked in pygame 1, but doesn't work in pygame 2.

  At the time of writing this included:

  • 📦 the pygame.cdrom package not being there (mainly because it isn't in SDL2 anymore).
  • ✅ pygame.scrap is only working with text, not images (needs some porting and testing done).
  • pygame.event.post is having issues with some event types.
  • pygame.display.set_palette is not implemented (not in SDL2).
  • display.set_mode() ignores depth value. It just returns one it thinks is appropriate.

  🚧 We've already investigated many of these issues, and even have some work in progress on some of them. If you're particularly interested in one of them please let us know. Also if you have any issues with your existing apps, we are very interested in finding out.

  🍱 🌺🌻🌹🥀🌷🌼🌸💐💮🌺🌻🌹🥀🌷🌼🌸💐💮🌺🌻
  🍱 🌼🌸 python3 -m pip install pygame==2.0.0
  🍱 🌺🌻🌹🥀🌷🌼🌸💐💮🌺🌻🌹🥀🌷🌼🌸💐💮🌺🌻

  🍱 Happy pygame 20th birthday all! 🎉 🍰 🥳

  ---

  • ⚡️ 937 merged PRs since we started the pygame 2 series in Jul 19, 2018.
  • 🚀 3306 Commits since 1.9.4 stable release
  • 🚀 previous pygame release notes

• v2.0.0.dev24 Changes

  October 27, 2020

  python3 -m pip install pygame=2.0.0.dev24
  

  🚀 A bunch of fixes and speedups before the release.
  0️⃣ Now the default branch on the pygame repo is main.

  @MyreMylar Dan Lawrence

  • Sets SDL Hint for hidden mouse cursor at window edges when full screen #2254
  • Documents that integers underlying key code constants differ between Pygame 1 & 2 #2253
  • ⚡️ Updates the joystick docs to include controller mappings for X360 & PS4 controllers #2252
  • ⚡️ Updates the docs for toggle_fullscreen() #2251
  • 🆕 New Alpha blitter - fixes and speed ups #2243

  @siggisv Sigurður Sveinn Halldórsson

  • ➕ Add to test/draw_test.py some unit tests for draw.line() #2247

  Ankith @ankith26

  • A small little deletion of obsolete file #2256
  • Do MOUSEBUTTONUP event on MOUSEWHEEL #2242
  • 🛠 Fix event.post KEYDOWN/KEYUP #2244

• v2.0.0.dev22 Changes

  October 23, 2020

  python3 -m pip install pygame==2.0.0.dev22
  

  🚀 Several very difficult to find and fix issues with alpha blending were fixed in this release.

  • First pass at backwards compatible pygame alpha blit by @MyreMylar

  The new alpha blitter has an SSE2 and arm NEON implementation, and keeps compatibility with pygame 1.

  Also some progress on other issues, including these...

  • ✅ Fix twitchy key tests on raspi by @ankith26
  • ✅ Better unit tests for event module by @ankith26
  • Fix messed up SSE 4.2 removal

• v2.0.0.dev20 Changes

  October 22, 2020

  📚 Another crunchy little release. This time more compatible manylinux wheels (Ubuntu 18.04 Bionic and CPUs without SSE 4.2), some documentation improvements, and pygame.midi fixes.

  python3 -m pip install pygame==2.0.0.dev20
  

  • Disable SSE 4.2 stuff because it does not do runtime detection on old CPUs.
  • 🐧 Use manylinux2010 for pypy and manylinux1 for other pythons
  • ⚡️ Doc updates (SDL2 -> pygame 2) by @ankith26
  • ✅ Fix pygame.midi so tests and example runs on py3 and py2

• v2.0.0.dev18 Changes

  October 21, 2020

  pip install pygame==2.0.0.dev18

  🛠 This is a small bugfix release to fix a problem with installing pygame from source code.

  ⬆️ If 2.0.0.dev16 worked for you, there's no need to upgrade.

• v2.0.0.dev16 Changes

  October 20, 2020

  pip install pygame==2.0.0.dev16

  🚀 The 28th of October 2020 will be the pygame 2.0 release date, because pygame turns 20 years of age. Save the date (maybe we'll do something)!

  🚀 We reached two important milestones with this pre-release. Firstly the old game 'solarwolf' is working fine with no known issues on pygame 2. The second stone we passed by on the road to PyPy goodness is that we are releasing binary wheels for PyPy on mac, windows, and linux. PyPy is a different implementation of python that is highly compatible and can be extremely fast.

  Here's a little youtube video of solarwolf on PyPy and SDL2...
  solarwolf on SDL2 and pypy

  🆓 > If you watched the video to the end, you'll note there's a crash. We still have some way to go before everything in pygame is working with PyPy. "solarwolf" using cpython and pygame 2 is running deliciously and glitch free.

  🚑 Critical backwards compatibility fixes for pygame 2

  🚑 First up, some 'critical' improvements that have been made to pygame. 'critical' labeled issues are ones are backwards incompatible issues stopping a pygame 2 release.

  Dan Lawrence @MyreMylar

  • Making RLE flags & RLE behaviour more consistent between pygame 1 and pygame 2, so that a lot more types of surfaces draw correctly and that "solarwolf" works really nicely.

  Ankith @ankith26

  • 🏁 Fix repeated VIDEOEXPOSE events, so apps do not get dozens of extra nonsensical VIDEOEXPOSE events on Windows.

  René Dudfield @illume

  • 🍎 Added portmidi package for conan MacOS so that pygame.midi works on MacOS again.
  • 🍎 Set icon on macos like the other platforms with SDL2, so the default icon is there again for MacOS.

  🐛 bugs, worms, shiny-shiny, and such

  Dan Lawrence @MyreMylar

  • Missing mouse_doc.h file
  • Fix for missed braces in get_flags()
  • Adding a premul_alpha helper method to Color class
  • 🗄 One of the math.c functions still used deprecated UTF functions

  René Dudfield @illume

  • ✅ Test that pygame with SDL2 blit gives same results as SDL1 blit
  • CI speedups
  • 🏗 Skip a lot of failing tests on pypy, build pypy wheels on mac+travis
  • 🐧 pypy and manylinux2010 because PyPy needs manylinux2010, an old PR from @takluyver was resurrected and changed a bit so we can use manylinux2010.

  @robertpfeiffer

  • 🏗 Add Setup.Android.SDL2.in, and default icons to STRIPPED build is an improvement for better Android support.

  @Starbuck5

  • 📚 Fix docs build failure on Sphinx 3, so we can use the current version of the Sphinx documentation tool.

  Josip Komljenović @MightyJosip

  • Type hints for Vector swizzles & sprite groups
  • draw.line fix with thick lines. More of the line was clipped off on screen borders than expected is a fix for an issue @siggisv found with line drawing.

  Sigurður Sveinn Halldórsson @siggisv

  • Document expected behavior of draw.aaline()

  Ankith @ankith26

  • Doc improvements for WINDOWEVENT, MOUSEWHEEL, event and misc

  🚑 This time 4 'critical' backwards compatibility issues were fixed since the last release.

  ---

  • 🚑 6 open 'critical' issues (backwards compatibility issues reported by people), and 35 closed (last release: 7 open, 32 closed).
  • ⚡️ merged PRs
  • 🚀 2090 Commits since 1.9.6 stable release
  • 🚀 80 Commits since 2.0.0.dev14 pre release

• v2.0.0.dev14 Changes

  October 12, 2020

  pip install pygame==2.0.0.dev14
  dreamlines
  -- Players, only love you when they're playing

  🚀 With a very tiny little bit of discussion it was sort of decided that the 28th of October 2020 will be the pygame 2.0 release date, because pygame turns 20.

  🚑 Critical backwards compatibility fixes for pygame 2

  🚑 First up, some 'critical' improvements that have been made to pygame. 'critical' labeled issues are ones are backwards incompatible issues stopping a pygame 2 release.

  Thanks to Dan Lawrence @MyreMylar for Adding a num_buttons parameter to mouse.get_pressed(). This was a backwards compatibility issue, because it used to return 3 elements. Now it returns 3 elements again by default and you can request 5 if you want. Another critical issue fixed by MyreMylar was a problem with key events being reordered on windows.

  But wait... there's more. Another backwards compatibility fix by MyreMylar is the "Backwards compatibility for get_flags() in SDL2" PR, which has stopped some games handling full screen mode properly.

  🛠 Sigurður Sveinn Halldórsson @siggisv fixed a problem with how pygame.draw.aaline didn't look as before.

  • Fix draw.aaline not always solid, and other problems

  Now the anti aliased lines look (and smell) awesome.
  13

  🐛 bugs, worms, shiny-shiny, and such

  Ankith @ankith26

  • 📚 Some mouse cursors documentation improvements
  • Fix pyinstaller issues with pygame.font.Font
  • Document some undocumented pygame.image functions
  • ⚡️ Update pygame.version.rev docs
  • Adding windowevent constants
  • ✅ Fixes pygame.display failing unit tests on raspberry pi
  • 🚚 Remove ancient file kept for python v2.4 compatibility

  Josip Komljenović @MightyJosip

  • Improved the speed of pygame.draw.line()
  • 🛠 A few more type hint fixes

  Dan Lawrence @MyreMylar

  • 💅 GitHub issue templates: New style Part 2
  • doc header file regen
  • ✅ Changed display.set_palette() test to test correct function

  Adam Andrews @adamandrews1

  • Code cleanup Removed PG_ENABLE_NEWBUF

  @Starbuck5

  • Python3 needs bool instead of nonzero
  • ⏱ timeout option added to event.wait() which is useful if you only want your app to wake up when something happens and also at least every 1 second or so.

  René Dudfield @illume

  • 🚀 Python 3.9 binary wheels (which is a new release of python).
  • ✅ Test sdist on CI
  • ✅ Disable timing based tests on mac CI, because issues

  Nguyễn Gia Phong @McSinyx

  • Fix mouse.pyi@set_system_cursor type hints
  • py.typed for mypy, fix pygame._sdl2 importing touch module type hints
  • Clean up README and source distribution

  Special thanks to the new contributors

  👀 @seenemikk

  • ✅ unit test for surface.get_masks()

  Sebastian Henz @BastiHz

  • Fix typo in freetype.rst

  Alice Lia Stapleton @slimelia

  • unit test: display.get_wm_info()

  🚑 This time 4 'critical' backwards compatibility issues were fixed since the last release.

  ---

  • 🚑 7 open 'critical' issues (backwards compatibility issues reported by people), and 32 closed (last release: 9 open, 28 closed).
  • ⚡️ merged PRs
  • 🚀 2008 Commits since 1.9.6 stable release
  • 🚀 118 Commits since 2.0.0.dev12 pre release