Skip to content

Latest commit

 

History

History
2127 lines (1614 loc) · 93.5 KB

CHANGELOG_HISTORY.rst

File metadata and controls

2127 lines (1614 loc) · 93.5 KB
Raw

Release Note History

Change log from order Arcade versions.

Version 2.6.17

Released 2022-Dec-30

  • Bump Pillow to 9.3.0
  • Bump PyMunk to 6.4.0
  • Add explicit compatibility tag for 3.11
  • Drop 3.7 as part of the test suite

Version 2.6.16

Released 2022-Sept-24

  • Support Tiled 1.9 via PyTiled Parser 2.2.0 (#1324)
  • Headless rendering with EGL should now work again
  • Fix code highlights in two examples
  • Fix data tables in quick index. (#1312)
  • Fix issues running in headless mode
  • Update pymunk physics engine to return pre handler (#1322)
  • Bump Pyglet version to 2.0dev23
  • Few PEP-8 fixes
  • Fix perspective example

Note: Development continues on version 2.7, which will be another leap forward in Arcade development. Feel free to check out the 'development' branch for the 2.7 changes.

Version 2.6.15

Released 2022-Jun-03

  • Pin Pygments version to get around a Pygments/Furo incompatibility. (#1224).
  • Fix Google analytics ID
  • Bump Pyglet version to 2.0.dev18. (Thanks Pyglet!)
  • Fix API colors for Furo theme

Version 2.6.14

Released 2022-May-18

  • Various Improvements
  • Shadertoy
  • Docs / Tutorials / Examples
    • Updated install docs
    • Added tutorial for compiling an Arcade game with Nuitka
    • Improved/extended shadertoy tutorials
    • Added example using textures with shadertoy
    • Added sprite rotation examples
    • Clarified the difference between :py:meth:`arcade.View.on_show_view` and :py:meth:`arcade.View.on_show`
    • Improved UIManager docstrings
    • Various annotation and docstring improvements
    • Fixed several broken links in docs
    • We're now building PDF/EPUB docs
  • OpenGL
    • Added new method for safely setting shader program uniforms: :py:meth:`arcade.gl.Program.set_uniform_safe`. This method will ignore KeyError if the uniform doesn't exist. This is often practical during development because most GLSL compilers/linkers will remove uniforms that is determined to not affect the outcome of a shader.
    • Added new method for safely setting a uniform array: :py:meth:`arcade.gl.Program.set_uniform_array_safe`. This is practical during development because uniform arrays are in most cases shortened by GLSL compiler if not all array indices are used by the shader.
    • Added :py:attr:`arcade.gl.Texture.swizzle`. This can be used to reorder how components are read from the texture by a shader making it easy to crate simple effects or automatically convert BGR pixel formats to RGB when needed.
    • Added ray marching example with fragment shader
    • Allow reading framebuffer data with 2 and 4 byte component sizes
    • Simplified texture atlas texture coordinates to make them easier to use in custom shaders.
    • Support dumping the atlas texture as RGB
    • Support dumping the atlas texture with debug lines showing texture borders
    • We no longer check GL_CONTEXT_PROFILE_MASK due to missing support in older drivers. Especially GL 3.1 drivers that can in theory run arcade
    • Various shader cleanups
  • Experimental
    • Added a simple profiler class

Special thanks to Vincent Poulailleau Ian Currie Mohammad Ibrahim, pushfoo, Alejandro Casanovas, Darren Eberly, pvcraven and Einar Forselv for their contributions to this release. Also, thanks to everyone on the Pyglet team! We depend heavily on Pyglet's continued development.

Version 2.6.13

Released 2022-Mar-25

  • New Features
    • Arcade can now run in headless mode on linux servers opening more possibilities for users in for example the data science community (#1107). See :ref:`headless` for more information.
  • Bugfixes
    • The random text glitching issue especially affecting users with iGPUs is finally resolved in pyglet. For that reason we have upgraded to the pyglet 2.0a2 release.
    • Fixed an issue causing :py:func:`arcade.draw_circle_filled` and :py:func:`arcade.draw_circle_outline` to always render with 3 segments on some iGPUs.
    • Fixed an issue causing interactive widgets to unnecessarily re-draw when hovering or pressing them. This could cause performance issues.
    • SectionManager's on_show_view was never called when showing a view
  • Various Improvements
    • :py:func:`arcade.load_font` now supports resource handles
    • :py:class:`~arcade.PhysicsEngineSimple` can now take an iterable of wall spritelists
    • Sprite creation is now ~6-8% faster.
    • Removed warning about missing shapely on startup
    • Window titles are now optional. If no window title is specified the title will be the absolute path to the python file it was created in. This was changed because of the new headless mode.
    • Removed arcade.quick_run. This function had no useful purpose.
    • Added clear method to UIManager (#1116)
    • Updated from Pillow 9.0.0 to 9.0.1
  • Tilemap
    • Rectangle objects which are empty(have no width or height) will now be automatically converted into single points.
    • The Tile ID of a sprite can be access with sprite.properties["tile_id"]. This refers to the local ID of the tile within the Tileset. This value can be used to get the tile info for a given Sprite created from loading a tilemap.
  • Docs
    • Added python version support info to install instructions (#1122)
    • Fixed typo in :py:func:`~arcade.Sprite.append_texture` docstring(#1126)
    • Improved the raycasting tutorial (#1124)
    • Replace mentions of 3.6 on Linux install page (#1129)
    • Fix broken links in the homepage (#1139)
    • Lots of other improvements to docstrings throughout the code base
    • General documentation improvements
  • OpenGL
    • :py:class:`arcade.gl.Geometry` now supports transforming to multiple buffers.
    • Added and improved examples in experimental/examples.
    • Major improvements to API docs

Special thanks to Mohammad Ibrahim, pushfoo, Alejandro Casanovas, Maic Siemering, Cleptomania, pvcraven and einarf for their contributions to this release. Also, thanks to everyone on the Pyglet team! We depend heavily on Pyglet's continued development.

Version 2.6.12

Released 2022-Mar-20

Special thanks to MrWardKKHS, pvcraven and einarf for their contributions to this release. Also, thanks to everyone on the Pyglet team! We depend heavily on Pyglet's continued development.

Also thanks to:

Version 2.6.11

Released 2022-Mar-17

Special thanks to einarf, eruvanos, janscas, MrWardKKHS, DragonMoffon, pvcraven, for their contributions to this release. Also, thanks to everyone on the Pyglet team! We depend heavily on Pyglet's continued development.

Version 2.6.10

Released 2022-Jan-29

Special thanks to Cleptomania, einarf, eruvanos, nrukin, Jayman2000, pvcraven, for their contributions to this release. Also, thanks to everyone on the Pyglet team! We depend heavily on Pyglet's continued development.

Version 2.6.9

Released on 2022-Jan-13

  • Bump version of Pillow from 8.4 to 9.0.0 due to security vulnerability in Pillow.

Version 2.6.8

Released on 2021-Dec-25

  • The Shapely library is now optional. The shapely library uses native code to make operations such as collision detection and some other geometry operations faster. However they have not updated their binaries to support Python 3.10 on macOS and Windows. If Shapely is installed, Arcade will use that library. Otherwise it will fall back to slower, but Python-only code. See: shapely/shapely#1215

  • :class:`~arcade.TileMap` changes:

    There are no API changes to the TileMap class, however full support for TMX maps, TSX tilesets, and TX object templates has been added thanks to pytiled-parser 2.0. You should be able to load these formats with 0 change to your code, and use all the same features that were available with JSON maps.

    This update also includes the ability to cross-load JSON and TMX maps/tilesets. Meaning you can have a JSON map load a TSX tileset, or have a TMX map load a JSON tileset.

    You don't ever need to explicitly set or configure a format to use, it will be automatically determined based on the file you pass in. It is determined based on the actual content of the file, and not the filetype, so if you give it a .json file that actually contains TMX, or vice versa, it will still work without problem.

  • Update Pyglet to 2.0.dev13 which fixes a bug where on_resize wasn't getting called.

  • Added a compute shader tutorial.

Special thanks to Cleptomania, einarf, pvcraven, for their contributions to this release. Also, thanks to everyone on the Pyglet team! We depend heavily on Pyglet's continued development.

Version 2.6.7

Released on 2021-Dec-15

  • This version updates Pyglet to 2.0dev12. Programs WILL NOT RUN with prior versions of Pyglet.

  • :class:`~arcade.Window` changes:

    • Added enable_polling option to constructor. If enabled then window.keyboard and window.mouse will be activated and able to be used to poll input by accessing them as if they were a dictionary. This option is enabled by default. See #1038

      window.keyboard can be polled using the values from arcade.key.

      window.mouse can be polled using the following values:

      • 1: Left click
      • 2: Right click
      • 3: Middle click
      • "x": X position
      • "y": Y position

  • :class:`~arcade.Camera` changes:

    • Defaults the viewport width and height to the window size if they are set to 0 now, since you cannot have a size of 0 in any direction due to projection calculation. This means that if you do not provide those arguments to the constructor it will default to the window size. See #1041

  • :class:`~arcade.tilemap.TileMap` changes:

    • Added support for layer position offsets. This allows passing a tuple containing an X and Y offset that will be applied to each Sprite/Object within the layer. You can set this via an offset parameter in the layer_options dict, or you can supply a global offset to the map which will be applied to all layers via the offset parameter of either arcade.load_tilemap or to the TileMap constructor directly. Layer specific offsets will override the global default if both are set. See #1048
    • Added a new error message for JSONDecodeError exceptions, a common problem when tilesets are TSX but maps are JSON. This change simply provides a more clear error of the most likely cause of the problem so users don't have to dig as much.

  • Text

    • Reverted the extra guards around text rendering that was implemented in 2.6.6. This turned out to cause slowdowns where text was being used heavily. Work is still ongoing to fix the remaining issues with text.

  • Docs Fixes:

Special thanks to Cleptomania, einarf, pvcraven, mlr07, pushfoo, for their contributions to this release. Also, thanks to everyone on the Pyglet team! We depend heavily on Pyglet's continued development.

Version 2.6.6

Released on 2021-Dec-04

  • :class:`~arcade.TileMap` changes:
    • Added tiled_map parameter to init function of TileMap class. It allows to pass an already parsed map from from pytiled-parser to it. Previously it could only be used with raw files and would handle the parsing automatically. If a pre-parsed map is passed to this, the map_file parameter will simply be ignored. This addition makes working with pre-parsed maps from a World file possible.
  • Text
    • Added extra guards around text rendering calls to hopefully reduce glitchy text rendering. Work is still ongoing to fix the remaining issues with text.
  • Window:
    • Added samples parameter so user can specify antialiasing quality.
    • The Arcade window should fall back to no antialiasing if the window creation fails. Some drivers/hardware don't support it. For example when running Arcade in WSL or services like Repl.it.
  • SpriteList
    • Optimization: Empty spritelists created before the window or created with lazy=True no longer automatically initialize internal OpenGL resources for empty spritelists and will instead immediately leave the draw() method.
  • UI
    • Add experimental UI styles dataclasses for UIWidget styling.
    • Add UISlider, which provides a general slider element with some basic functionality
    • Fix UIInputText rendering
  • Sound
    • Pyglet audio drivers can now be overridden using the ARCADE_SOUND_BACKENDS environment variable for debug purposes. It expects a comma separated string with driver names.
  • OpenGL
    • From version 2.6.6 Arcade is no longer using the auto garbage collection mode for OpenGL resources. This mode has the same behavior as the Python garbage collection. Instead we're now using the context_gc mode were resources are released every time Window.flip() is called (every frame by default). This solves many problems such as threads in your project or external libraries suddenly trying to garbage collect OpenGL objects while this is only possible in the main thread. This should not cause any problems for most users.
    • Added Context.copy_framebuffer. This can be used to copy framebuffers with or without multisampling to another framebuffer. This makes us able to do offscreen rendering with multisampling.
    • Texture s can now be created with multisampling by passing the samples parameter. This should only be used for attachments to framebuffers. The Texture object now also has a samples property (read only).
  • Examples
    • Update mini-map example
    • Update scrolling camera example
    • Update google analytics code in docs
    • Remove some less-than-useful examples in the example code section
    • Update platformer example
    • Update windows install instructions
    • Update sample games to show more sample games
    • Improve CRT filter tutorial
    • New example code on how to follow a path
    • Added Game of Life example using shaders
  • Documentation
    • Added API docs for arcade.gl
    • ArcadeContext should now show inherited members
    • Edge artifact page now encourage using pixelated argument instead of importing OpenGL enums from pyglet

Special thanks to einarf, pvcraven, Cleptomania, eruvanos, for their contributions to this release. Also, thanks to everyone on the Pyglet team! We depend heavily on Pyglet's continued development.

Version 2.6.5

Released on 2021-Nov-5

  • Increased pyglet's default atlas size for text glyphs to remove text flickering and various other artifacts. This issue will be fixed in future versions of pyglet.
  • Fixed as issue causing all sprites to use the same texture on some Macs.
  • Improved doc for setting the viewport.

Special thanks to einarf, pushfoo, for their contributions to this release.

Version 2.6.4

Released on 2021-Nov-3

  • Python 3.10 updates. Dependent library versions have been updated to include Python 3.10 support. All libraries appear to support 3.10 except Shapely 1.8.0 on the Windows platform. Until those binaries are released, 3.10 support for Windows is still not there.

  • :class:`~arcade.SpriteList` additions:

    • A visible attribute has been added to this class. If set to False, when calling draw() on the SpriteList it will simply return and do nothing. Causing the SpriteList to not be drawn.
    • SpriteList now has a lazy (bool) parameter causing it to not create internal OpenGL resources until the first draw call or until SpriteList's :meth:`~arcade.SpriteList.initialize` is called. This means that sprite lists and sprites can now be created in threads.
    • Fixes/optimized :py:meth:`~arcade.SpriteList.reverse` and :py:meth:`~arcade.SpriteList.shuffle` methods.
    • Added :py:meth:`~arcade.SpriteList.sort` method. This is identical to Python's list.sort but are many times faster sorting your sprites.
    • Removed noisy warning message when spritelists were created before the window
    • Fixed an issue with :py:meth:`~arcade.SpriteList.insert` when trying to insert sprites past an index greater than the current length. It could cause inserted sprites to be invisible.

  • :class:`~arcade.Sprite` changes:

  • :class:`~arcade.PhysicsEnginePlatformer` Optimization:

    A walls parameter has been added to this class. The new intention for usage of this class is for static(non-moving) sprites to be sent to the walls parameter, while moving platforms should be sent to the platforms parameter. Properly differentiating between these parameters can result in extreme performance benefits. Sprites added to platforms are O(n) whereas Sprites added to walls are O(1). This has been tested with anywhere from 100 to 500k+ Sprites, and the physics engine shows no measurable difference between those scenarios.

    We have also removed the ability to send a single Sprite to the platforms, ladders, and walls parameters of this class. This is a use case which results in some improper usage and unnecessary slowdowns. These parameters will now only accept SpriteLists or an iterable such as a list containing SpriteLists. If you are currently using this functionality, you just need to add your Sprite to a SpriteList and provide that instead.

    The simple platformer tutorial has already been updated to make use of this optimization.

  • :class:`~arcade.Scene` is additions:

    • The Scene class is now sub-scriptable, previously in order to retrieve a SpriteList from Scene, you needed to use either Scene.name_mapping or Scene.get_sprite_list. We have now added the ability to access it by sub-scripting the Scene object directly, like spritelist = my_scene["My Layer"]
    • Added on_update() method. Previously Scene only had update(). Both of these methods simply call the corresponding one on each SpriteList, however previously you could not do this with on_update(). The difference between these methods is that on_update() allows passing a delta time, whereas update() does not.

  • :class:`~arcade.TileMap` additions and fixes:

    • When loading a Tiled map Arcade will now respect if layers are visible or not. If a layer is not visible in Tiled, the SpriteList created for it will use the new visible attribute to control it. This means that when creating a Scene from a TileMap, this will automatically be respected as well.
    • Fixed support for parallax values on layers. Currently there is no support to do anything with these out of the box, you'd need to manually pull the values and do something based on them, however previously the map would not load if the values were changed from the default. This has been fixed in pytiled-parser and we have updated our version in Arcade accordingly.
    • Removed a lingering debug tactic of printing the class name of custom SpriteList classes when loading a TileMap.

  • UI

  • Text

    • Several text related bugs have been resolved in pyglet, the underlying library we now use for text drawing. This has been a fairly time consuming task over several weeks and we hope the new pyglet based text system will stabilize from now on. Arcade is an early adopter of pyglet 2.0 currently using a pre-release
    • The :py:class:`~arcade.Text` object is now usable and is preferred over :py:func:`arcade.draw_text` in many cases for performance reasons.
    • Text related functions should now have better documentation

  • Misc:

    • Added support to the :class:`~arcade.View` class for :meth:`~arcade.View.on_resize`
    • Many docstring improvements. Initializer docstrings have now been moved to the class docstring ensuring they will always show up in the generated api docs.
    • Added some new sections under advanced docs related to OpenGL, textures and texture atlas
    • New utility function :func:`~arcade.color_from_hex_string` that will turn a hex string into a color.
    • Bug: Removed a lingering debug key F12 that showed the contents of the global texture atlas
    • Several improvements to typing and PEP-8. Plus automated tests to help keep things in good shape.
    • Added run() shortcut in arcade.Window. Usage: MyWindow().run()
    • Addition of :class:`~arcade.PymunkException` class for throwing Pymunk errors in the Pymunk physics engine.
    • The :func:`~arcade.check_for_collision_with_lists` function will now accept any Iterable(List, Tuple, Set, etc) containing SpriteLists.

  • Lower level rendering API:

    • Fixed a problem causing Geometry / VertexArray to ignore POINTS primitive mode when this is set as default.
    • Added support for compute shaders. We support writing to textures and SSBOs (buffers). Examples can be found in arcade/experimental/examples
    • Fixed a crash when drawing with geometry shaders due to referencing a non-existent enum

Special thanks to einarf, pvcraven, pushfoo, Cleptomania, Olliroxx, mlr07, yegarti, Jayman2000 for their contributions to this release.

Special thanks to Benjamin and caffeinepills for their help to squash bugs in pyglet 2.0.

Version 2.6.3

Released on 2021-Sept-21

  • Bug fix, use a signed in as the 'killed' index. #965
  • Fix dead links on getting started page See #960
  • Fix some doc language that mixed function/method vocabulary. See #963
  • Some initial work on compute and camera shader work. Not done yet.
  • Fixed a bug causing the sprite geometry shader to not compile in some platforms
  • Fixed a bug related to texture bleeding with sprites. Texture atlases now pad the texture borders with repeating pixel data to combat this. It should make sprites look much better when scrolling, zooming and on hidpi displays. #959
  • Added hack for some gui text not appearing (pyglet 2.0 bug)
  • UIMessageBox should now respect the width and height of the widget
  • SpriteList.draw: Added pixelated (bool) argument as a shortcut to setting nearest interpolation
  • SpriteList.draw: The arguments are now better exposed in docs
  • Sprite.draw now has the same blending and interpolation argument as SpriteList.draw
  • Upgraded to pyglet 2.0dev9

Version 2.6.2

Released on 2021-Sept-18

  • Support for custom classes that subclass Sprite for tiles in TileMap objects. See #942
  • Update PymunkPhysicsEngine to work with any direction of gravity rather than just downward. See #940
  • Update library versions we depend on. PIL, Pymunk, etc.
  • Fix the card game example code. See #951
  • Fix for drawing small circles not using enough segments. See #950
  • A lot of documentation links in the .py files were old and not updated to the RTD way, fixed now.
  • arcade.key was missing from the documentation quick index. Fixed.
  • Fixed a rendering issue with sprites on M1 Macs
  • Fix caret not showing up in input box
  • Lots of type-hint fixes

Version 2.6.1

Fixes

  • Removed type annotations which were introduced in Python 3.8 to fix compatibility with Python 3.7 and 3.6
  • Fixed flickering on static drawing. See #858

Version 2.6.0

Version 2.6.0 is a major update to Arcade. It is not 100% backwards compatible with the 2.5 API. Updates were made to text rendering, tiled map support, sprites, shaders, textures, GUI system, and the documentation.

Special thanks to:

  • einarf for performance improvements, texture atlas support, shader toy support, text drawing support, advice on GUI, and more.
  • Cleptomania for Tiled Map support, sound support, and more.
  • eruvanos for the original GUI and all the GUI updates.
  • benmoran56 and everyone that contributes to the excellent Pyglet library we use so much.

Version 2.5.7

Released on 2021-May-25

Fixes

  • The Arcade gui should now respect the current viewport
  • Fixed an issue with UILabel allocating large amounts of textures over time consuming a lot of memory
  • Fixed an issue with the initial viewport sometimes being 1 pixel too small causing some artifacts
  • Fixed a race condition in Sound.stop() sometimes causing a crash
  • Fixed an issue in requirements causing issues for poetry
  • Fixed an error reporting issue when reaching maximum texture size

New Features

replit.com

Arcade should now work out of the box on replit.com. We detect when Arcade runs in replit tweaking various settings. One important setting we disable is antialiasing since this doesn't work well with software rendering.

Alternative Garbage Collection of OpenGL Resources

arcade.gl.Context now supports an alternative garbage collection mode more compatible with threaded applications and garbage collection of OpenGL resources. OpenGL resources can only be accessed or destroyed from the same thread the window was created. In threaded applications the Python garbage collector can in some cases try to destroy OpenGL objects possibly causing a hard crash.

This can be configured when creating the arcade.Window passing in a new gc_mode parameter. By default this parameter is "auto" providing the default garbage collection we have in Python.

Passing in "context_gc" on the other hand will move all "dead" OpenGL objects into Context.objects. These can be garbage collected manually by calling Context.gc() in a more controlled way in the the right thread.

Version 2.5.6

Version 2.5.6 was released 2021-03-28

  • Fix issue with PyInstaller and Pymunk not allowing Arcade to work with bundling
  • Fix some PyMunk examples
  • Update some example code. Highlight PyInstaller instructions

Version 2.5.5

Version 2.5.5 was released 2021-02-23

Version 2.5.4

Version 2.5.4 was released 2021-02-19

Version 2.5.3

Version 2.5.3 was released 2021-01-27

Version 2.5.2

Version 2.5.2 was released 2020-12-27

  • Improve schedule/unschedule docstrings
  • Fix Sound.get_length
  • Raise error if there are multiple instances of a streaming source
  • Fix background music example to match new sound API
  • Update main landing page for docs
  • Split sprite platformer tutorial into multiple pages
  • Add 'related projects' page
  • Add 'adventure' sample game link
  • Add resources for top-down tank images
  • Add turn-and-move example
  • Fix name of sandCorner_left.png
  • Update tilemap to error out instead of continuing if we can't find a tile
  • Improve view tutorial
  • Generate error rather than warning if we can't find image or sound file
  • Specify timer resolution in Windows

Version 2.5.1

Version 2.5.1 was released 2020-12-14

Version 2.5

Version 2.5 was released 2020-12-09

(Note, libraries Arcade depends on do not work yet with Python 3.9 on Mac. Mac users will need to use Python 3.6, 3.7 or 3.8.)

General

  • SpriteList.draw now supports a blend_function parameter. This opens up for drawing sprites with different blend modes.
  • Bugfix: Sprite hit box didn't properly update when changing width or height
  • GUI improvements (eruvanos needs to elaborate)
  • Several examples was improved
  • Improvements to the pyinstaller tutorial
  • Better pin versions of depended libraries
  • Fix issues with simple and platformer physics engines.

Advanced

  • Added support for tessellation shaders
  • arcade.Window now takes a gl_version parameter so users can request a higher OpenGL version than the default (3, 3) version. This only be used to advanced users.
  • Bugfix: Geometry's internal vertex count was incorrect when using an index buffer
  • We now support 8, 16 and 32 bit index buffers
  • Optimized several draw methods by omitting tobytes() letting the buffer protocol do the work
  • More advanced examples was added to arcade/experimental/examples

Documentation

  • Add :ref:`conway_alpha` example showing how to use alpha to control display of sprites in a grid.
  • Improve documentation around sound API.
  • Improve documentation with FPS and timing stats example.
  • Improve moving platform docs a bit in :ref:`platformer_tutorial` tutorial.

Version 2.4.3

Version 2.4.3 was released 2020-09-30

General

  • Added PyInstalled hook and tutorial
  • ShapeLists should no longer share position between instances
  • GUI improvements: new UIImageToggle

Low level rendering API (arcade.gl):

  • ArcadeContext now has a load_texture method for creating opengl textures using Pillow.
  • Bug: Fixed an issue related to drawing indexed geometry with offset
  • Bug: Scissor box not updating when using framebuffer
  • Bug: Fixed an issue with pack/unpack alignment for textures
  • Bug: Transforming geometry into a target buffer should now work with byte offset
  • Bug: Duplicate sprites in 'check_for_collision_with_list' Issue #763
  • Improved docstrings in arcade.gl

Version 2.4.2

Version 2.4.2 was released 2020-09-08

  • Enhancement: draw_hit_boxes new method in SpriteList.
  • Enhancement: draw_points now significantly faster
  • Added UIToggle, on/off switch
  • Add example showing how to do GPU transformations with the mouse
  • Create buttons with default size/position so size can be set after creation.
  • Allow checking if a sound is done playing Issue 728
  • Add an early camera mock-up
  • Add finish method to arcade.gl.context.
  • New example arcade.experimental.examples.3d_cube (experimental)
  • New example arcade.examples.camera_example
  • Improved UIManager.unregister_handlers(), improves multi view setup
  • Update preload_textures method of SpriteList to actually pre-load textures
  • GUI code clean-up Issue 723
  • Update downloadable .zip for for platformer example code to match current code in documentation.
  • Bug Fix: draw_point calculates wrong point size
  • Fixed draw_points calculates wrong point size
  • Fixed create_line_loop for thickness !=
  • Fixed pixel scale for offscreen framebuffers and read()
  • Fixed SpriteList iterator is stateful
  • Fix for pixel scale in offscreen framebuffers
  • Fix for UI tests
  • Fix issues with FBO binding
  • Cleanup Remove old examples and code

Version 2.4

Arcade 2.4.1 was released 2020-07-13.

Arcade version 2.4 is a major enhancement release to Arcade.

../example_code/images/light_demo.png ../example_code/images/astar_pathfinding.png ../tutorials/pymunk_platformer/title_animated_gif.gif ../tutorials/gpu_particle_burst/explosions.gif ../tutorials/card_game/animated.gif ../example_code/images/transform_feedback.png

Version 2.4 Major Features

Version 2.4 Minor Features

New functions/classes:

New functionality:

  • Support for logging. See :ref:`logging`.
  • Support volume and pan arguments in play_sound
  • Add ability to directly assign items in a sprite list. This is particularly useful when re-ordering sprites for drawing.
  • Support left/right/rotated sprites in tmx maps generated by the Tiled Map Editor.
  • Support getting tmx layer by path, making it less likely reading in a tmx file will have directory confusion issues.
  • Add in font searching code if we can't find default font when drawing text.
  • Added :data:`arcade.Sprite.draw_hit_box` method to draw a hit box outline.
  • The :data:`arcade.Texture` class, :data:`arcade.Sprite` class, and :data:`arcade.tilemap.process_layer` take in hit_box_algorithm and hit_box_detail parameters for hit box calculation.
../api_docs/images/hit_box_algorithm_none.png

hit_box_algorithm = "None"

../api_docs/images/hit_box_algorithm_simple.png

hit_box_algorithm = "Simple"

../api_docs/images/hit_box_algorithm_detailed.png

hit_box_algorithm = "Detailed"

Version 2.4 Under-the-hood improvements

General

  • Simple Physics engine is less likely to 'glitch' out.
  • Anti-aliasing should now work on windows if antialiasing=True is passed in the window constructor.
  • Major speed improvements to drawing of shape primitives, such as lines, squares, and circles by moving more of the work to the graphics processor.
  • Speed improvements for sprites including gpu-based sprite culling (don't draw sprites outside the screen).
  • Speed improvements due to shader caching. This should be especially noticeable on Mac OS.
  • Speed improvements due to more efficient ways of setting rendering states such as projection.
  • Speed improvements due to less memory copying in the lower level rendering API.

OpenGL API

A brand new low level rendering API wrapping OpenGL 3.3 core was added in this release. It's loosely based on the ModernGL API, so ModernGL users should be able to pick it up fast. This API is used by Arcade for all the higher level drawing functionality, but can also be used by end users to really take advantage of their GPU. More guides and tutorials around this is likely to appear in the future.

A simplified list of features in the new API:

  • A :py:class:`~arcade.gl.Context` and :py:class:`arcade.ArcadeContext` object was introduced and can be found through the window.ctx property. This object offers methods to create opengl resources such as textures, programs/shaders, framebuffers, buffers and queries. It also has shortcuts for changing various context states. When working with OpenGL in Arcade you are encouraged to use arcade.gl instead of pyglet.gl. This is important as the context is doing quite a bit of bookkeeping to make our life easier.
  • New :py:class:`~arcade.gl.Texture` class supporting a wide variety of formats such as 8/16/32 bit integer, unsigned integer and float values. New convenient methods and properties was also added to change filtering, repeat mode, read and write data, building mipmaps etc.
  • New :py:class:`~arcade.gl.Buffer` class with methods for manipulating data such as simple reading/writing and copying data from other buffers. This buffer can also now be bound as a uniform buffer object.
  • New :py:class:`~arcade.gl.Framebuffer` wrapper class making us able to render any content into one more more textures. This opens up for a lot of possibilities.
  • The :py:class:`~arcade.gl.Program` has been expanded to support geometry shaders and transform feedback (rendering to a buffer instead of a screen). It also exposes a lot of new properties due to much more details introspection during creation. We also able to assign binding locations for uniform blocks.
  • A simple glsl wrapper/parser was introduced to sanity check the glsl code, inject preprocessor values and auto detect out attributes (used in transforms).
  • A higher level type :py:class:`~arcade.gl.Geometry` was introduced to make working with shaders/programs a lot easier. It supports using a subset of attributes defined in your buffer description by inspecting the the program's attributes generating and caching compatible variants internally.
  • A :py:class:`~arcade.gl.Query` class was added for easy access to low level measuring of opengl rendering calls. We can get the number samples written, number of primitives processed and time elapsed in nanoseconds.
  • Added support for the buffer protocol. When arcade.gl requires byte data we can also pass objects like numpy array of pythons array.array directly not having to convert this data to bytes.

Version 2.4 New Documentation

Version 2.4 'Experimental'

There is now an arcade.experimental module that holds code still under development. Any code in this module might still have API changes.

Special Thanks

Special thanks to Einar Forselv and Maic Siemering for their significant work in helping put this release together.

Version 2.3.15

Release Date: Apr-14-2020

  • Bug Fix: Fix invalid empty text width Issue 633
  • Bug Fix: Make sure file name is string before checking resources Issue 636
  • Enhancement: Implement Size and Rotation for Tiled Objects Issue 638
  • Documentation: Fix incorrect link to 'sprites following player' example

Version 2.3.14

Release Date: Apr-9-2020

  • Bug Fix: Another attempt at fixing sprites with different dimensions added to same SpriteList didn't display correctly Issue 630
  • Add lots of unit tests around Sprites and texture loading.

Version 2.3.13

Release Date: Apr-8-2020

  • Bug Fix: Sprites with different dimensions added to same SpriteList didn't display correctly Issue 630

Version 2.3.12

Release Date: Apr-8-2020

  • Enhancement: Support more textures in a SpriteList Issue 332

Version 2.3.11

Release Date: Apr-5-2020

  • Bug Fix: Fix procedural_caves_bsp.py
  • Bug Fix: Improve Windows install docs Issue 623

Version 2.3.10

Release Date: Mar-31-2020

  • Bug Fix: Remove unused AudioStream and PlaysoundException from __init__
  • Remove attempts to load ffmpeg library
  • Add background music example
  • Bug Fix: Improve Windows install docs Issue 619
  • Add tutorial on edge artifacts Issue 418
  • Bug Fix: Can't remove sprite from multiple lists Issue 621
  • Several documentation updates

Version 2.3.9

Release Date: Mar-25-2020

  • Bug Fix: Fix for calling SpriteList.remove Issue 613
  • Bug Fix: get_image not working correctly on hi-res macs Issue 594
  • Bug Fix: Fix for "shiver" in simple physics engine Issue 614
  • Bug Fix: Fix for create_line_strip Issue 616
  • Bug Fix: Fix for volume control Issue 610
  • Bug Fix: Fix for loading SoLoud under Win64 Issue 615
  • Fix jumping/falling texture in platformer example
  • Add tests for gui.theme Issue 605
  • Fix bad link to arcade.color docs

Version 2.3.8

Release Date: Mar-09-2020

  • Major enhancement to sound. Uses SoLoud cross-platform library. New features include support for sound volume, sound stop, and pan left/right.

Version 2.3.7

Release Date: Feb-27-2020

  • Bug Fix: If setting color of sprite with 4 ints, also set alpha
  • Enhancement: Add image for code page 437
  • Bug Fix: Fixes around hit box calcs Issue 601
  • Bug Fix: Fixes for animated tiles and loading animated tiles from tile maps Issue 603

Version 2.3.6

Release Date: Feb-17-2020

  • Enhancement: Add texture transformations Issue 596
  • Bug Fix: Fix off-by-one issue with default viewport
  • Bug Fix: Arcs are drawn double-sized Issue 598
  • Enhancement: Add get_sprites_at_exact_point function
  • Enhancement: Add code page 437 to default resources

Version 2.3.5

Release Date: Feb-12-2020

  • Bug Fix: Calling sprite.draw wasn't drawing the sprite if scale was 1 Issue 575
  • Add unit test for Issue 575
  • Bug Fix: Changing sprite scale didn't cause sprite to redraw in new scale Issue 588
  • Add unit test for Issue 588
  • Enhancement: Simplify using built-in resources Issue 576
  • Fix for failure on on_resize(), which pyglet was quietly ignoring
  • Update rotate_point function to make it more obvious it takes degrees

Version 2.3.4

Release Date: Feb-08-2020

  • Bug Fix: Sprites weren't appearing Issue 585

Version 2.3.3

Release Date: Feb-08-2020

  • Bug Fix: set_scale checks height rather than scale Issue 578
  • Bug Fix: Window flickers for drawing when not derived from Window class Issue 579
  • Enhancement: Allow joystick selection in dual-stick shooter Issue 571
  • Test coverage reporting now working correctly with TravisCI
  • Improved test coverage
  • Improved documentation and typing with Texture class
  • Improve minimal View example

Version 2.3.2

Release Date: Feb-01-2020

  • Remove scale as a parameter to load_textures because it is not unused
  • Improve documentation
  • Add example for acceleration/friction

Version 2.3.1

Release Date: Jan-30-2020

  • Don't auto-update sprite hit box with animated sprite
  • Fix issues with sprite.draw
  • Improve error message given when trying to do a collision check and there's no hit box set on the sprite.

Version 2.3.0

Release Date: Jan-30-2020

  • Backwards Incompatability: arcade.Texture no longer has a scale property. This property made things confusing as Sprites had their own scale attribute. This seemingly small change required a lot of rework around sprites, sprite lists, hit boxes, and drawing of textured rectangles.
  • Include all the things that were part of 2.2.8, but hopefully working now.
  • Bug Fix: Error when calling Sprite.draw() Issue 570
  • Enhancement: Added Sprite.draw_hit_box to visually draw the hit box. (Kind of slow, but useful for debugging.)

Version 2.2.9

Release Date: Jan-28-2020

  • Roll back to 2.2.7 because bug fixes in 2.2.8 messed up scaling

Version 2.2.8

Release Date: Jan-27-2020

  • Version number now contained in one file, rather than three.
  • Enhancement: Move several GitHub-listed enhancements to the .rst enhancement list
  • Bug Fix: Texture scale not accounted for when getting height Issue 516
  • Bug Fix: Issue with text cut off if it goes below baseline Issue 515
  • Enhancement: Allow non-cached texture creation, fixing issue with resizing Issue 506
  • Enhancement: Physics engine supports rotation
  • Bug Fix: Need to better resolve collisions so sprite doesn't get hyper-spaces to new weird spot Issue 569
  • Bug Fix: Hit box not getting properly created when working with multi-texture player sprite. Issue 568
  • Bug Fix: Issue with text_sprite and anchor y of top Issue 567
  • Bug Fix: Issues with documentation

Version 2.2.7

Release Date: Jan-25-2020

  • Enhancement: Have draw_text return a sprite Issue 565
  • Enhancement: Improve speed when changing alpha of text Issue 563
  • Enhancement: Add dual-stick shooter example Issue 301
  • Bug Fix: Fix for Pyglet 2.0dev incompatability Issue 560
  • Bug Fix: Fix broken particle_systems.py example Issue 558
  • Enhancement: Added mypy check to TravisCI build Issue 557
  • Enhancement: Fix typing issues Issue 537
  • Enhancement: Optimize load font in draw_text Issue 525
  • Enhancement: Reorganize examples
  • Bug Fix: get_pixel not working on MacOS Issue 539

Version 2.2.6

Release Date: Jan-20-2020

  • Bug Fix: particle_fireworks example is not running with 2.2.5 Issue 555
  • Bug Fix: Sprite.pop isn't reliable Issue 531
  • Enhancement: Raise error if default font not found on system Issue 432
  • Enhancement: Add space invaders clone to example list Issue 526
  • Enhancement: Add sitemap to website
  • Enhancement: Improve performance, error handling around setting a sprite's color
  • Enhancement: Implement optional filtering parameter to SpriteList.draw Issue 405
  • Enhancement: Return list of items hit during physics engine update Issue 401
  • Enhancement: Update resources documentation Issue 549
  • Enhancement: Add on_update to sprites, which includes delta_time Issue 266
  • Enhancement: Close enhancement-related github issues and reference them in the new enhancement list.

Version 2.2.5

Release Date: Jan-17-2020

  • Enhancement: Improved speed when rendering non-buffered drawing primitives
  • Bug fix: Angle working in radians instead of degrees in 2.2.4 Issue 552
  • Bug fix: Angle and color of sprite not updating in 2.2.4 Issue 553

Version 2.2.4

Release Date: Jan-15-2020

  • Enhancement: Moving sprites now 20% more efficient.

Version 2.2.3

Release Date: Jan-12-2020

  • Bug fix: Hit boxes not getting updated with rotation and scaling. Issue 548 This update depricates Sprite.points and instead uses Sprint.hit_box and Sprint.get_adjusted_hit_box
  • Major internal change around not having __init__ do import * but specifically name everything. Issue 537 This rearranded a lot of files and also reworked the quickindex in documentation.

Version 2.2.2

Release Date: Jan-09-2020

  • Bug fix: Arcade assumes tiles in tileset are same sized Issue 550

Version 2.2.1

Release Date: Dec-22-2019

  • Bug fix: Resource folder not included in distribution Issue 541

Version 2.2.0

Release Date: Dec-19-2019*

  • Major Enhancement: Add built-in resources support Issue 209 This also required many changes to the code samples, but they can be run now without downloading separate images.
  • Major Enhancement: Auto-calculate hit box points by trimming out the transparency
  • Major Enhancement: Sprite sheet support for the tiled map editor works now
  • Enhancement: Added load_spritesheet for loading images from a sprite sheet
  • Enhancement: Updates to physics engine to better handle non-rectangular sprites
  • Enhancement: Add SpriteSolidColor class, for creating a single-color rectangular sprite
  • Enhancement: Expose type hints to modules that depend on Arcade via PEP 561 Issue 533 and Issue 534
  • Enhancement: Add font_color to gui.TextButton init Issue 521
  • Enhancement: Improve error messages around loading tilemaps
  • Bug fix: Turn on vsync as it sometimes was limiting FPS to 30.
  • Bug fix: get_tile_by_gid() incorrectly assumes tile GID cannot exceed tileset length Issue 527
  • Bug fix: Tiles in object layers not placed properly Issue 536
  • Bug fix: Typo when loading font Issue 518
  • Updated requirements.txt file
  • Add robots.txt to documentation

Please also update pyglet, pyglet_ffmpeg2, and pytiled_parser libraries.

Special tanks to Jon Fincher, Mr. Gallo, SirGnip, lubie0kasztanki, and EvgeniyKrysanoc for their contributions to this release.

Version 2.1.7

  • Enhancement: Tile set support. Issue 511
  • Bug fix, search file tile images relative to tile map. Issue 480

Version 2.1.6

  • Fix: Lots of fixes around positioning and hitboxes with tile maps Issue 503
  • Documentation updates, particularly using on_update instead of update and remove_from_sprite_lists instead of kill. Issue 381
  • Remove/adjust some examples using csvs for maps

Version 2.1.5

  • Fix: Default font sometimes not pulling on mac Issue 488
  • Documentation updates, particularly around examples for animated characters on platformers
  • Fix to Sprite class to better support character animation around ladders

Version 2.1.4

  • Fix: Error when importing Arcade on Raspberry Pi 4 Issue 485
  • Fix: Transparency not working in draw functions Issue 489
  • Fix: Order of parameters in draw_ellipse documentation Issue 490
  • Raise better error on data classes missing
  • Lots of code cleanup from SirGnip Issue 484
  • New code for buttons and dialog boxes from wamiqurrehman093 Issue 476

Version 2.1.3

  • Fix: Ellipses drawn to incorrect dimensions Issue 479
  • Enhancement: Add unit test for debugging Issue 478
  • Enhancement: Add more descriptive error when file not found Issue 472
  • Enhancement: Explicitly state delta time is in seconds Issue 473
  • Fix: Add missing 'draw' function to view Issue 470

Version 2.1.2

  • Fix: Linked to wrong version of Pyglet Issue 467

Version 2.1.1

  • Added pytiled-parser as a dependency in setup.py

Version 2.1.0

Thanks to SirGnip, Mr. Gallow, and Christian Clauss for their contributions.

Version 2.0.9

  • Fix: Unable to specify path to .tsx file for tiled spritesheet Issue 360
  • Fix: TypeError: __init__() takes from 3 to 11 positional arguments but 12 were given in text.py Issue 373
  • Fix: Test create_line_strip Issue 379
  • Fix: TypeError: draw_rectangle_filled() got an unexpected keyword argument 'border_width' Issue 385
  • Fix: See about creating a localization/internationalization example Issue 391
  • Fix: Glitch when you die in the lava in 09_endgame.py Issue 392
  • Fix: No default font found on ArchLinux and no error message (includes patch) Issue 402
  • Fix: Update docs around batch drawing and array_backed_grid.py example Issue 403

Version 2.0.8

  • Add example code from lixingque
  • Fix: Drawing primitives example broke in prior release Issue 365
  • Update: Improve automated testing of all code examples Issue 326
  • Update: raspberry pi instructions, although it still doesn't work yet
  • Fix: Some buffered draw commands not working Issue 368
  • Remove yml files for build environments that don't work because of OpenGL
  • Update requirement.txt files
  • Fix mountain examples
  • Better error handling when playing sounds
  • Remove a few unused example code files

Version 2.0.7

  • Last release improperly required pyglet-ffmpeg, updated to pyglet-ffmpeg2
  • Fix: The alpha value seems NOT work with draw_texture_rectangle Issue 364
  • Fix: draw_xywh_rectangle_textured error Issue 363

Version 2.0.6

  • Improve ffmpeg support. Think it works on MacOS and Windows now. Issue 350
  • Improve buffered drawing command support
  • Improve PEP-8 compliance
  • Fix for tiled map reader, Issue 360
  • Fix for animated sprites Issue 359
  • Remove unused avbin library for mac

Version 2.0.5

  • Issue if scale is set for a sprite that doesn't yet have a texture set. Issue 354
  • Fix for Sprite.set_position not working. Issue 356

Version 2.0.4

  • Fix for drawing with a border width of 1 Issue 352

Version 2.0.3

Version 2.0.2 was compiled off the wrong branch, so it had a bunch of untested code. 2.0.3 is what 2.0.2 was supposed to be.

Version 2.0.2

  • Fix for loading a wav file Issue 344
  • Fix Linux only getting 30 fps Issue 342
  • Fix error on window creation Issue 340
  • Fix for graphics cards not supporting multi-sample Issue 339
  • Fix for set view error on mac Issue 336
  • Changing scale attribute on Sprite now dynamically changes sprite scale Issue 331

Version 2.0.1

  • Turn on multi-sampling so lines could be anti-aliased Issue 325

Version 2.0.0

Released 2019-03-10

Lots of improvements in 2.0.0. Too many to list, but the two main improvements:

  • Using shaders for sprites, making drawing sprites incredibly fast.
  • Using ffmpeg for sound.

Version 1.3.7

Released 2018-10-28

  • Fix for Issue 275 where sprites can get blurry.

Version 1.3.6

Released 2018-10-10

  • Bux fix for spatial hashing
  • Implement commands for getting a pixel, and image from screen

Version 1.3.5

Released 08-23-2018

Bug fixes for spatial hashing and sound.

Version 1.3.4

Released 28-May-2018

New Features

  • Issue 197: Add new set of color names that match CSS color names
  • Issue 203: Add on_update as alternative to update
  • Add ability to read .tmx files.

Bug Fixes

  • Issue 159: Fix array backed grid buffer example
  • Issue 177: Kind of fix issue with gi sound library
  • Issue 180: Fix up API docs with sound
  • Issue 198: Add start of isometric tile support
  • Issue 210: Fix bug in MacOS sound handling
  • Issue 213: Update code with gi streamer
  • Issue 214: Fix issue with missing images in animated sprites
  • Issue 216: Fix bug with venv
  • Issue 222: Fix get_window when using a Window class

Documentation

  • Issue 217: Fix typo in doc string
  • Issue 198: Add example showing start of isometric tile support

Version 1.3.3

Released 2018-May-05

New Features

  • Issue 184: For sound, wav, mp3, and ogg should work on Linux and Windows. wav and mp3 should work on Mac.

Updated Examples

  • Add happy face drawing example

Version 1.3.2

Released 2018-Apr-20

New Features

  • Issue 189: Add spatial hashing for faster collision detection
  • Issue 191: Add function to get the distance between two sprites
  • Issue 192: Add function to get closest sprite in a list to another sprite
  • Issue 193: Improve decorator support

Updated Documentation

  • Link the class methods in the quick index to class method documentation
  • Add mountain midpoint displacement example
  • Improve CSS
  • Add "Two Worlds" example game

Updated Examples

  • Update sprite_collect_coints_move_down.py to not use all_sprites_list
  • Update sprite_bullets_aimed.py to add a warning about how to manage text on a scrolling screen
  • Issue 194: Fix for calculating distance traveled in scrolling examples

Version 1.3.1

Released 2018-Mar-31

New Features

  • Update create_rectangle code so that it uses color buffers to improve performance
  • Issue 185: Add support for repeating textures
  • Issue 186: Add support for repeating textures on Sprites
  • Issue 184: Improve sound support
  • Issue 180: Improve sound support
  • Work on improving sound support

Updated Documentation

  • Update quick-links on homepage of http://arcade.academy
  • Update Sprite class documentation
  • Update copyright date to 2018

Updated Examples

  • Update PyMunk example code to use keyboard constants rather than hard-coded values
  • New sample code showing how to avoid placing coins on walls when randomly placing them
  • Improve listing/organization of sample code
  • Work at improving sample code, specifically try to avoid using all_sprites_list
  • Add PyMunk platformer sample code
  • Unsuccessful work at getting TravisCI builds to work
  • Add new sample for using shape lists
  • Create sample code showing difference in speed when using ShapeLists.
  • Issue 182: Use explicit imports in sample PyMunk code
  • Improve sample code for using a graphic background
  • Improve collect coins example
  • New sample code for creating caves using cellular automata
  • New sample code for creating caves using Binary Space Partitioning
  • New sample code for explosions

Version 1.3.0

Released 2018-February-11.

Enhancements

Version 1.2.5

Released 2017-December-29.

Bug Fixes

Enhancements

Version 1.2.4

Released 2017-December-23.

Bug Fixes

Version 1.2.3

Released 2017-December-20.

Bug Fixes

  • Issue 44: Improve wildcard imports
  • Issue 150: "Shapes" example refers to chapter that does not exist
  • Issue 157: Different levels example documentation hook is messed up.
  • Issue 160: sprite_collect_coins example fails to run
  • Issue 163: Some examples aren't loading images

Enhancements

  • Issue 84: Allow quick running via -m
  • Issue 149: Need better error message with check_for_collision
  • Issue 151: Need example showing how to go between rooms
  • Issue 152: Standardize name of main class in examples
  • Issue 154: Improve GitHub compatibility
  • Issue 155: Improve readme documentation
  • Issue 156: Clean up root folder
  • Issue 162: Add documentation with performance tips
  • Issue 164: Create option for a static sprite list where we don't check to see if things moved.
  • Issue 165: Improve error message with physics engine

Version 1.2.2

Released 2017-December-02.

Bug Fixes

  • Issue 143: Error thrown when using scroll wheel
  • Issue 128: Fix infinite loop in physics engine
  • Issue 127: Fix bug around warning with Python 3.6 when imported
  • Issue 125: Fix bug when creating window on Linux

Enhancements

  • Issue 147: Fix bug building documentation where two image files where specified incorrectly
  • Issue 146: Add release notes to documentation
  • Issue 144: Add code to get window and viewport dimensions
  • Issue 139: Add documentation on what collision_radius is
  • Issue 131: Add example code on how to do full-screen games
  • Issue 113: Add example code showing enemy turning around when hitting a wall
  • Issue 67: Improved support and documentation for joystick/game controllers