Changelog¶

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]¶

Nutshell now has complete distribution packaging functionalities builtin! You can now bundle your game as a single archive, or even compile it into a standalone executable for easy distribution.

Engine
- Release VMs resources on shutdown
Audio
- Avoid sound effect leak
ImGui
- Do not let Dear ImGui take over cursor management by default
Window
- Check if a window is already a parent of another when trying to set parenting
- Avoid window leak if parenting fails

Nutshell now has basic Dear ImGui bindings! You can easily create your user interfaces through the ImGui class.
Nutshell now exposes a public API for native plugins. Native plugins can therefore enqueue draw images or text commands into current rendering pass and load images or font assets.
Image
- Added support to render images to arbitrary quads

Nutshell now supports native plugins. If you felt limited by its capabilities, you can now extend them without sacrificing its scripting level simplicity!
Nutshell now has internal sprite batching, combining multiple images that share the same texture and style into a single drawing step, making rendering much faster and smoother.
Input
- Added support for terminal input
Image
- Added support for batch rendering
SpriteBatch
- New class to manage a collection of batched sprites
Documentation
- Advanced sections about rendering performance, native plugins and terminal input
Tutorials
- Added Pumpkin Push tutorial port

Documentation
- Moved Advanced usage into an Advanced section next to the new native plugins page
All examples scripts have been formatted
Go
- Upgraded Go to 1.26.6
SDL
- Upgraded SDL to 3.4.14

A mini Nutshell version is now available. It only supports core file formats, and has no complex text layout, but is ready to go for game jams!
Audio
- BGM properties can be updated on the fly
- Stopped BGM can now be restarted
Canvas
- Fill / Stroke rectangles with rounded corners
Font
- Font derivation
- String truncation
- Automatic string coercion for draw() and measure() parameters
Input
- Allow gamepad updates while application is in the background
- Loading gamepad mappings from file
System
- resolve_path() resource path resolution helper
- Access to project's root directory property

A specific script other than main.nut can now be targeted as entry point with Nutshell CLI
Examples' music files have been converted to Ogg Vorbis format to make them compliant with new mini Nutshell version

Input
- Implemented better input manager
- Reworked SDL from/to generic mappings
- Updated demo for joystick support
SDL
- Upgraded SDL to 3.4.12

Audio
- Enable position option for sound effects
- Examples
Canvas
- Examples
Font
- Bitstream Vera Sans is now the default embedded font
- Fonts can now be loaded from their font aliases
- Examples
Image
- Examples
Input
- Expose keyboard, gamepad buttons and axis supported count to script engine
- Input.keychar_to_key and Input.key_to_keychar functions
- Examples
System
- Enable to request specific ID when spawning a VM
- Examples
Window
- Examples
Licenses
- Add third party license attribution
- Bundle licenses into distribution packages
Documentation
- Primary and emoji fonts handling
- Keyboard layout
- Gamepad handling

Window
- Destroy created windows for failed spawned VMs
- Implemented window closing lifecycle rules
- Avoid rendering hidden windows
- Better handling of child popups/tooltips window closing
Linux build
- Don't link to JBIG host's library to keep the SDL libaries portable
Windows build
- Enable GME file format
Linux and Windows builds
- Enable ANI file formats

🚀 Initial release