Version 0.5.0

Released May 7th, 2025

Breaking Changes

• Removal of Scene on_quit method (as on_cleanup is used here).
• Removal of TABBED_FPS Settings attribute.
• Engine constructor parameter icon_filepath changed to icon and instead takes a pygame.Surface than a str filepath.

Additions

• Provided complete documentation to all objects not documented previously.
• Joystick support for console devices, like controllers.
• Custom user events as Pygame allows.
• Additional Scene event dispatch methods:
  1. on_joy_axis_motion
  2. on_joy_button_down
  3. on_joy_button_up
  4. on_joy_device_added
  5. on_joy_device_removed
  6. on_joy_hat_motion
  7. on_user_event
  8. on_window_close
  9. on_window_display_changed
  10. on_window_focus_gained
  11. on_window_focus_lost
  12. on_window_hidden
  13. on_window_maximized
  14. on_window_minimized
  15. on_window_mouse_enter
  16. on_window_mouse_leave
  17. on_window_moved
  18. on_window_resize
  19. on_window_restored
  20. on_window_shown
• New Interval object under the wame.common module. Contains commonly used time durations (useful for Engine.set_update_interval with fixed updates).
• New Scene on_fixed_update that updates every configured interval, default 60Hz (60 times/second). Edit with Engine.set_update_interval.
• New Engine constructor settings_persistent parameter. Allows developers to custom save/load game settings if they desire.

Fixes

• Typos in existed documentation has been fixed.
• False errors raised when updating runtime Engine attributes (Pipeline and *update_interval values) before a Scene was ran.
• Public Engine attributes now cannot be edited, only referenced.
• Incorrect error types in documentation Raises sections.
• Referenced errors in documentation never had an actual error raise possible.
• IntVector3 cross can no longer take FloatVector3 values.
• Settings updated a local screen object instead of the Engine.