butano

Tools no longer crash on Windows with more than 60 logical CPU cores.

• Language standard updated to C++23.
• Old bn::hdma::start and bn::hdma::high_priority_start API deprecated.
• BN_UNREACHABLE deprecated.
• Construction of bn::string and bn::string_view from nullptr is disallowed (thanks C++23).
• bn::string::starts_with, bn::string::ends_with, bn::string_view::starts_with and bn::string_view::ends_with a nullptr char array is disallowed.
• bn::unique_ptr is now constexpr.
• bn::bitset and bn::string aren't constexpr anymore (it didn't work before).
• More overloads added to bn::string construction, assignment, bn::string::assign and bn::string::append.
• bn::string::find and bn::string_view::find added.
• bn::string::contains and bn::string_view::contains added.
• bn::string::substr added.
• bn::string_view::ends_with a char array added.
• nullptr constructor and method overloads added to bn::unique_ptr.
• Non-throwing new and delete supported.
• bn::string_view::remove_prefix and bn::string_view::remove_suffix assert fixed.
• bn::is_constant_evaluated replaced with consteval.
• Unnecessary operator!= implementations removed.
• bn::regular_bg_builder::release_map, bn::affine_bg_builder::release_map, bn::sprite_builder::release_tiles and bn::sprite_builder::release_palette ROM usage reduced.
• bn::deque iterators order operators optimized.

• bn::hdma::start and bn::hdma::high_priority_start API improved.
• Some assert messages improved.
• Missing header includes added.
• hdma_palette example added.
• Dead links updated.
• New games made with Butano added to README.md.

• bn::deque::erase fixed (thanks copyrat90!).
• Would I be able to sell my game made with Butano for money? question improved.

• H-Blank effects stop fixed.
• random example added.
• log example improved.
• No$gba exception setup guide added.
• How can I know what code makes my game crash? question added to the Frequently asked questions (FAQ).
• BN_LOG_BACKEND_MGBA also works with Mesen.
• bn::sram documentation improved.
• Regular backgrounds and affine backgrounds import guides improved.

• bn::bg_palette_ptr::set_color and bn::sprite_palette_ptr::set_color added.
• Empty bn::utf8_characters_map and bn::utf8_characters_map_ref allowed.

• bn::bg_palette_ptr::rotate_range_start, bn::bg_palette_ptr::rotate_range_size and bn::bg_palette_ptr::set_rotate_range added.
• bn::sprite_palette_ptr::rotate_range_start, bn::sprite_palette_ptr::rotate_range_size and bn::sprite_palette_ptr::set_rotate_range added.
• bn::fixed::modulo added.
• bn::memory::fast_ewram added.
• bn::random::get_unbiased_int, bn::random::get_unbiased_fixed, bn::seed_random::get_unbiased_int and bn::seed_random::get_unbiased_fixed added (thanks alope107!).
• H-Blank effects management optimized.
• BN_EWRAM_WAIT_STATE_1 crash after boot documented.
• Slow EWRAM test added.
• IWRAM vs EWRAM stack tests added to the profiler coroutine test.
• Slow game pak test improved.
• GCC14 false build warnings in Butano Fighter fixed.

• bn::memory::dma_enabled and bn::memory::set_dma_enabled added.
• bn::fixed explicit conversion operators added.
• Custom C++ flags can be specified in the project's Makefile.
• All logging functions and methods can be called with logging disabled.
• Current gba-link-connection implementation has been moved to a private namespace to allow using other implementations.
• Spelling mistakes corrected.
• Background z order documentation improved.
• GBA Wav to S3m Converter added to the frequently asked questions (FAQ) page.

• bn::blending::set_black_fade_color and bn::blending::set_white_fade_color added.
• bn::fixed friend operators allow different levels of precision.
• bn::list and bn::forward_list unnecessary asserts removed.
• VRAM related error messages shortened.
• profiler coroutine test improved.
• BIOS calls can be disabled in the profiler test.
• Why can't I use some standard functions and classes? question added to the frequently asked questions (FAQ) page.
• Why I run out of memory so often? question improved.
• Demons of Asteborg DX added to README.md.

• bn::core::current_cpu_ticks, bn::core::last_cpu_ticks and bn::core::last_vblank_ticks added.
• Import tool now allows to exclude Huffman when choosing the best compression for images.
  See the images import guide to learn how to exclude it.
• LZ77 decompression optimized (thanks Lorenzooone!).
• bn::core::current_cpu_usage and bn::core::last_vblank_usage with skip frames fixed.
• Coroutines added to the profiler test.

• bn::core::log_stacktrace added. Check the log example to see how to log the current stack trace.
• bn::isprite_animate_action::next_change_updates, bn::isprite_cached_animate_action::next_change_updates, bn::iregular_bg_animate_action::next_change_updates, bn::iregular_bg_cached_animate_action::next_change_updates, bn::iaffine_bg_animate_action::next_change_updates and bn::iaffine_bg_cached_animate_action::next_change_updates added.
• bn::pair is now a std::pair alias.
• Tonclib ASM ROM usage reduced.
• profiler example simplified.
• Compression algorithms added to the profiler test.
• What function or method call is the source of an error message? question added to the frequently asked questions (FAQ).
• Why changing the color palette of an 8BPP sprite or background doesn't work? question added to the frequently asked questions (FAQ).
• Does hiding a sprite make it count towards the total number of allowed sprites? and does hiding a background make it count towards the total number of allowed backgrounds? questions added to the frequently asked questions (FAQ).
• Getting started guide improved.
• Why I run out of memory so often? question improved.
• Wavefront To Varooom 3D added to README.md.

bn::unique_ptr move fixed.

• Affine big maps canvas size can be specified by the user: bn::affine_bg_big_map_canvas_size, bn::bg_maps::new_affine_big_map_canvas_size, bn::bg_maps::set_new_affine_big_map_canvas_size and bn::affine_bg_map_ptr::big_canvas_size added.
• Regular big maps canvas height increased.
• Force at least one update before sleeping in bn::core::sleep.
• bn::span::size_bytes implicit conversion warning fixed.
• Wonderful Toolchain binary files build time reduced.
• Scale can be changed in the world_map example.

• Regular and affine backgrounds allow to specify if they are part of the blending bottom layer or not.
  See the blending example to learn how to do it.
• bn::sprites::blending_bottom_enabled and bn::sprites::set_blending_bottom_enabled added.
• bn::backdrop functions and actions added.
• bn::backdrop_color_hbe_ptr added.
• bn::fixed_point_t, bn::fixed_size_t, bn::fixed_rect_t and bn::top_left_fixed_rect_t added.
• Collision methods added to bn::rect, bn::fixed_rect, bn::top_left_rect and bn::top_left_fixed_rect.
• __FILE_NAME__ macro is no longer required.
• Toolchain detection fixed.
• Build time reduced.

• bn::sprites::visible and bn::sprites::set_visible added.
• bn::sprites actions added.
• Initial transparent color of the backgrounds can be specified in bn::core::init.
• bn::date year range not longer limited to [0..99].
• bn::color_effect::grayscale, bn::color_effect::blend and bn::color_effect::fade require 4-byte aligned color references with an even number of colors.
• Uncompressed backgrounds commit CPU usage reduced.
• Memory copy speed tests added to the profiler example.

• Big maps allow wrapping (they can now be moved beyond their boundaries).
• Stack trace logging on error messages can be enabled with the STACKTRACE makefile variable.
• Stack trace demangle can be enabled with BN_CFG_ASSERT_STACKTRACE_DEMANGLE.
• bn::memory::used_rom added.
• Import tool can now generate palettes for regular and affine background tiles.
  See the Regular background tiles and the Affine background tiles import guides to learn how to generate them.
• GRAPHICS, AUDIO and DMGAUDIO makefile variables accept file and folder paths.
• bn::audio::dmg_sync_enabled and bn::audio::set_dmg_sync_enabled removed as they don't work properly.
• bn::time::current 12-hour mode support.
• agbabi updated to 2.1.6.
• Old documentation header restored.
• dynamic_regular_bg example shows how to deal with multiple palette ids.
• Tiles offset disabled in dynamic_regular_bg and dynamic_affine_bg examples.

• Wonderful Toolchain experimental support!
  See the Getting started with Wonderful Toolchain guide to learn how to build Butano games with it.
• Real time clock (RTC) support thanks to agbabi.
  See bn::date, bn::time and the date_time example to learn how to deal with the RTC.
• bn::core::hard_reset added.
• bn::isprite_animate_action::current_graphics_index and bn::isprite_cached_animate_action::current_tiles added.
• agbabi memory routines IWRAM usage reduced.
• Rumble management CPU usage reduced.
• memcmp optimized.
• Hardware access ROM usage reduced.
• Error messages crash fixed.
• Error messages with HDMA enabled have been fixed too.

• bn::music::stop, bn::dmg_music::stop, bn::sound_handle::stop and bn::sound_handle::release can be called without triggering an assert if the music/sound in question isn't playing.
• Target *.gba file is rebuilt when the target *.elf file isn't present.
• Sprite affine mats, sound handles and backgrounds management CPU usage reduced.
• bn::unordered_map::erase and bn::unordered_set::erase fixed.

• bn::dmg_music::master_volume and bn::dmg_music::set_master_volume added.
• bn::color_effect::blend added.
• Sprite affine mats management CPU usage reduced.
• bn::jingle::play link error fixed.

• Sprite affine mats management CPU usage reduced.
• Music ending detection fixed.