diff --git a/butano/include/documentation/bn_documentation_ab_getting_started_wt.h b/butano/include/documentation/bn_documentation_ab_getting_started_wt.h
index b0ef481a..3cbccada 100644
--- a/butano/include/documentation/bn_documentation_ab_getting_started_wt.h
+++ b/butano/include/documentation/bn_documentation_ab_getting_started_wt.h
@@ -48,10 +48,11 @@
*
* @code{.cpp}
* pacman -S make
+ * wf-pacman -Syu wf-tools
+ * wf-config repo enable blocksds
* wf-pacman -Syu
- * wf-pacman -S toolchain-gcc-arm-none-eabi
- * wf-pacman -S thirdparty-blocksds-toolchain
* wf-pacman -S target-gba
+ * wf-pacman -S blocksds-toolchain
* @endcode
*
* @image html wt_pacman.png
diff --git a/butano/include/documentation/bn_documentation_g_changelog.h b/butano/include/documentation/bn_documentation_g_changelog.h
index 50a12624..fb14b54c 100644
--- a/butano/include/documentation/bn_documentation_g_changelog.h
+++ b/butano/include/documentation/bn_documentation_g_changelog.h
@@ -20,6 +20,7 @@
* * bn::utf8_character validation improved.
* * @ref faq_delta_time, @ref faq_sprites_metasprites and @ref faq_backgrounds_animated questions
* added to the @ref faq page.
+ * * @ref getting_started_wt guide updated.
* * Some spelling mistakes fixed.
*
*
diff --git a/docs/changelog.html b/docs/changelog.html
index 5d19b32e..eeef2956 100644
--- a/docs/changelog.html
+++ b/docs/changelog.html
@@ -218,7 +218,7 @@ Contents
0.1.0
-- bn::regular_bg_ptr, bn::regular_bg_builder, bn::affine_bg_ptr, bn::affine_bg_builder, bn::affine_bg_mat_attributes, bn::sprite_ptr and bn::sprite_builder support top-left coordinates for their position.
- bn::regular_bg_top_left_move_to_action, bn::regular_bg_top_left_move_loop_action, bn::regular_bg_top_left_move_toggle_action, bn::affine_bg_top_left_move_to_action, bn::affine_bg_top_left_move_loop_action, bn::affine_bg_top_left_move_toggle_action, bn::sprite_top_left_move_to_action, bn::sprite_top_left_move_loop_action and bn::sprite_top_left_move_toggle_action added.
- bn::safe_degrees_angle, bn::degrees_lut_sin_safe, bn::degrees_lut_cos_safe and bn::degrees_lut_sin_and_cos_safe added.
- bn::affine_mat_attributes::set_rotation_angle_safe, bn::affine_bg_builder::set_rotation_angle_safe, bn::affine_bg_mat_attributes::set_rotation_angle_safe, bn::affine_bg_ptr::set_rotation_angle_safe, bn::sprite_affine_mat_ptr::set_rotation_angle_safe, bn::sprite_builder::set_rotation_angle_safe and bn::sprite_ptr::set_rotation_angle_safe added.
- Position in
create methods is now optional. - bn::intrusive_list and bn::intrusive_forward_list iterator constructors are now public.
- Real time clock (RTC) string added.
- SRAM string with link-time optimization fixed.
- Why background coordinates are relative to the center of the screen, instead of to its top-left corner? and Why sprite coordinates are relative to the center of the screen, instead of to its top-left corner? questions added to the Frequently asked questions (FAQ) page.
- Why my game runs fine on emulators but doesn't work on a real GBA with a flash cart? question improved.
Tools no longer crash on Windows with more than 60 logical CPU cores.
- 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.
- Sprite affine mats management CPU usage reduced.
- Music ending detection fixed.
- bn::sound_handle and sound handle actions added. See the
audio example to learn how to stop, release and setup sound effects with them. - bn::jingle and jingle actions added.
- Audio commands generation optimized.
- Music ending detection fixed.
- Create new tiles methods deprecated.
- Same maps with different tiles or palettes supported.
- Some clangd and Clang-Tidy warnings fixed.
Python 2 support restored.
- bn::display::size added.
- Standard abort implemented.
- Color-related H-Blank effects update fixed.
Slow game pak detection fixed (again).
- bn::seed_random added.
- Standard assert implemented.
- Thread-safe initialization of local statics disabled.
- Static destructors fixed.
- Maps commit optimized by more than 35% in some cases.
- Palette search optimized by more than 25% in some cases.
- Big maps commit optimized.
- Display setup commit optimized.
- BG blocks and sprite tiles managers ROM usage reduced.
map_collision example added.
memcmp optimized.- Link flags fixed.
- Brightness, contrast and intensity color effects optimized.
- bn::random internal variables are
protected to allow child classes to access them. compile_commands.json generation support.
memset undefined references with link-time optimization fixed.
memset moved to IWRAM.- Backdrop fade blending fixed.
bn::any management with types that can't be copied, moved or swapped fixed.
- BN_BASIC_ASSERT added.
- Repeated color palettes reduction can be disabled when importing a regular background. See the Regular backgrounds import guide to learn how to disable it.
- Unaligned byte
memset fixed. - Asserts without diagnostic information ROM usage reduced.
- Input tiles in
dynamic_regular_bg and dynamic_affine_bg examples are imported without using a map. - Frequently asked questions (FAQ) page improved.
Recovery of deleted background maps fixed.
- SRAM magic string fixed.
BN_CODE_IWRAM macro can be used for thumb code too.- Destructors of classes with
_ptr suffix ROM usage reduced. - 4BPP regular backgrounds quantization improved.
- Some error messages improved.
- Import images guide explains why Usenti is recommended over other image editors.
- bn::sprite_text_generator variable width fonts rendering fixed and optimized.
- Sprite shape and size update ROM usage reduced.
- Some Cppcheck warnings removed.
- Automatic sprite double size detection fixed.
- Sprite tiles management optimized (EWRAM and CPU usage reduced).
- Background tiles and maps management optimized (EWRAM and CPU usage reduced).
- Color palettes management CPU usage reduced.
- Sprites and sprite affine mats management CPU usage reduced.
- Backgrounds management CPU usage reduced.
- Cameras management CPU usage reduced.
- Sprite tiles delayed commit fixed.
- V-Blank interrupt management optimized (EWRAM and CPU usage reduced).
- Missed link messages frequency reduced.
- bn::timer::elapsed_ticks optimized.
- (Breaking change) bn::aligned fixed.
- Color effects optimized.
Huffman images compression support (make sure to update devkitARM before using it).
- Avoid data decompression in V-Blank if possible.
- Audio updates can no longer be interrupted.
- bn::audio::dmg_sync_enabled and bn::audio::set_dmg_sync_enabled added.
- Custom assembler flags can be specified in the project's
Makefile. - GBT Player updated to 4.4.1.
- bn::fixed, bn::optional, bn::string_view and bn::span are no longer forward declared in the public API.
- Text color in assert and profile screens improved.
- Audio volume setup optimized.
- Clouds restored in
world_map example.
- Custom linker flags can be specified in the project's
Makefile. - Asserts ROM usage reduced.
- Audio startup fixed when link-time optimization is enabled.
- Audio stop fixed when link communication is active.
- Parallel link-time optimization temporal files ignored and added to the list of files to clean.
BMP files colors count calculation fixed (again).
- Hue shift palette effect added. See the
palettes example to learn how to use it. - Brightness effect ROM usage reduced.
- bn::sprite_item and bn::sprite_tiles_item size reduced.
- Automatic sprite double size detection fixed.
- bn::hbe_visible_toggle_action removed, since it was not possible to use it.
- Clang build fixes.
- Clang-Tidy warnings fixed.
- New games made with Butano added to
README.md.
- Modified assets detection optimized.
- Audio and graphics tools unified in order to reduce build time.
- bn::newton_raphson_sqrt removed, since it doesn't work for bn::fixed input values.
- An external bn::bg_palette_item can be specified when importing regular and affine backgrounds.
- Colors count can be specified when importing sprite and background palettes.
- Standard containers equality comparison optimized.
- Asserts file name hack fixed.
- Universal GBA Library LGPL license files removed.
- Standard containers documentation improved.
- Frequently asked questions (FAQ) page improved.
- Maps commit optimized by more than 50% in some cases.
- Integer alignment at minimum enforced in all containers.
- BG blocks manager and sprite tiles manager commit fixed.
- (Security issue) Source code files full path is not stored in output ROMs anymore.
- Some Clang-Tidy and Cppcheck warnings removed.
Audio and HDMA issues when updating at less than 60FPS fixed.
- Run-length is preferred to LZ77 when choosing best compression mode.
- Sprites automatic double size mode and affine matrix management fixed.
- Frequently asked questions (FAQ) page improved.
- bn::sprite_text_generator can now plot multiple 16x16 variable width characters in a single sprite.
- bn::sprite_text_generator IWRAM usage reduced.
- Third party libraries to link can be specified in the project's
Makefile. - Project's
Makefile allows to build source files generated with an external tool. See the external_tool example to learn how to do it. butano-audio-tool.py generates a list of all available music and sound items with their name.audio_player example added.- Varooom 3D improved (check its
readme.txt file for details).
- Varooom 3D source code and assets added.
- Maximum number of active H-Blank effects reduced to 6.
- Common files moved to
common namespace.
- Generated items are now
constexpr inline to avoid being copied to every translation unit. - Sprites EWRAM usage reduced.
- Different type backgrounds sorting fixed.
- bn::sort with 128bit sort keys fixed.
- IRQs setup during startup improved.
- An external tool can be called from the project's
Makefile. See the external_tool example to learn how to call it. - Affine background tiles offset optimized.
- Big numbers to string conversion optimized.
- 32bit integer division optimized.
- 64bit integer division by 0 assert added.
- Big maps maximum valid position fixed.
- Compressed tiles warning fixed.
- GCC11 warning fixed.
- Some 8x8 sprite text characters fixed.
- Qt Creator setup guide added.
- More questions added to Frequently asked questions (FAQ) page.
dynamic_bg example added.- Affine background tiles offset fixed.
- bn::sprite_font supports all sprite shapes and sizes.
- Trivial type containers destruction optimized.
- Container destructors are always
noexcept. - Redundant container asserts removed.
- GPIO direction register setup.
- Sprites optimized.
- Blending optimized.
- Mosaic optimized.
- Internal memory transfers optimized.
texture_polygons example affine parameters fixed.- Clouds removed from
world_map example.
- Automatic sprite double size detection improved.
- Butano Fighter allows to disable rumble in the title menu.
Automatic sprite double size detection fixed.
BG blocks manager use after move fixed.
- SRAM memory usage reduced.
- Sprite animate actions memory usage reduced.
- Missing asserts added to some actions.
- bn::random is now a trivial class.
- BG blocks manager search fixed.
world_map example frame rate back to 60FPS.
- Sprite tiles generation outputs sprite shape and size.
- BN_ASSERT and BN_ERROR can be modified or disabled for specific code sections.
- Sprites IWRAM usage reduced.
- Some internal asserts removed.
- Profiler screen fixed.
- Documentation explains how to place data in ROM.
- bn::sprite_font allows to specify space between characters.
- Background palettes bits per pixel mode can be specified by the user.
- Palettes change optimized.
- Unused palette colors are not imported anymore.
- bn::sprite_ptr::set_tiles() validation fixed.
- H-Blank effects EWRAM usage reduced (more than 2KB by default).
- Optimization level changed to
-O2 to avoid another No$gba crash. - SRAM code moved back from ROM to EWRAM, since doing that doesn't make No$gba crash anymore.
- Redundant reset code removed.
- Sprite and background palettes can be generated from images alone, without tiles or maps.
<cstddef> is always included (bn_cstddef.h header file removed).- bn::unordered_map and bn::unordered_set assignment fixed.
- H-Blank effects optimized (it fixes
world_map example flickering). - SRAM code moved from EWRAM to ROM to avoid a No$gba crash.
- HDMA properly supported (now it works at less than 60fps). See bn::hdma and the
hdma_polygons example for more. - gba-link-connection remote timeout detection fixed.
- By removing some method overloads, lots of runtime asserts when creating resources have been removed.
- bn::palette_bpp_mode has been renamed to bn::bpp_mode and
bpp_mode() methods have been renamed to bpp(). - 8 bits per pixel background tiles allocation fixed.
btn renamed to bn. No more API breaks will be made between minor releases after 1.0.0, promise.- Background tiles manager status can be printed in the log with bn::bg_tiles::log_status(). This is done automatically when a non-optional background tiles allocation fails too.
- Background regular maps manager status can be printed in the log with bn::bg_maps::log_status(). This is done automatically when a non-optional regular background map allocation fails too.
- Sprite tiles manager status can be printed in the log with bn::sprite_tiles::log_status(). This is done automatically when a non-optional sprite tiles allocation fails too.
- Color palettes managers status can be printed in the log with bn::bg_palettes::log_status() and bn::sprite_palettes::log_status(). This is done automatically when a non-optional color palette allocation fails too.
- Sprites destruction optimized.
- Setters with an optional parameter added to some classes.
- Optional components documentation fixed.
- Other documentation improvements.
- Sprites update performance improved up to 30% in Butano Fighter thanks to avoid rebuilding sprites list as much as possible.
- Profiler can show the maximum measured ticks per entry.
- Assets tools print output binaries size.
- Performance improved up to 12% in Butano Fighter without
-flto thanks to using less build translation units. - Documentation improved.
+- bn::regular_bg_ptr, bn::regular_bg_builder, bn::affine_bg_ptr, bn::affine_bg_builder, bn::affine_bg_mat_attributes, bn::sprite_ptr and bn::sprite_builder support top-left coordinates for their position.
- bn::regular_bg_top_left_move_to_action, bn::regular_bg_top_left_move_loop_action, bn::regular_bg_top_left_move_toggle_action, bn::affine_bg_top_left_move_to_action, bn::affine_bg_top_left_move_loop_action, bn::affine_bg_top_left_move_toggle_action, bn::sprite_top_left_move_to_action, bn::sprite_top_left_move_loop_action and bn::sprite_top_left_move_toggle_action added.
- bn::safe_degrees_angle, bn::degrees_lut_sin_safe, bn::degrees_lut_cos_safe and bn::degrees_lut_sin_and_cos_safe added.
- bn::affine_mat_attributes::set_rotation_angle_safe, bn::affine_bg_builder::set_rotation_angle_safe, bn::affine_bg_mat_attributes::set_rotation_angle_safe, bn::affine_bg_ptr::set_rotation_angle_safe, bn::sprite_affine_mat_ptr::set_rotation_angle_safe, bn::sprite_builder::set_rotation_angle_safe and bn::sprite_ptr::set_rotation_angle_safe added.
- Position in
create methods is now optional. - bn::intrusive_list and bn::intrusive_forward_list iterator constructors are now public.
- Real time clock (RTC) string added.
- SRAM string with link-time optimization fixed.
- Why background coordinates are relative to the center of the screen, instead of to its top-left corner? and Why sprite coordinates are relative to the center of the screen, instead of to its top-left corner? questions added to the Frequently asked questions (FAQ) page.
- Why my game runs fine on emulators but doesn't work on a real GBA with a flash cart? question improved.
Tools no longer crash on Windows with more than 60 logical CPU cores.
- 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.
- Sprite affine mats management CPU usage reduced.
- Music ending detection fixed.
- bn::sound_handle and sound handle actions added. See the
audio example to learn how to stop, release and setup sound effects with them. - bn::jingle and jingle actions added.
- Audio commands generation optimized.
- Music ending detection fixed.
- Create new tiles methods deprecated.
- Same maps with different tiles or palettes supported.
- Some clangd and Clang-Tidy warnings fixed.
Python 2 support restored.
- bn::display::size added.
- Standard abort implemented.
- Color-related H-Blank effects update fixed.
Slow game pak detection fixed (again).
- bn::seed_random added.
- Standard assert implemented.
- Thread-safe initialization of local statics disabled.
- Static destructors fixed.
- Maps commit optimized by more than 35% in some cases.
- Palette search optimized by more than 25% in some cases.
- Big maps commit optimized.
- Display setup commit optimized.
- BG blocks and sprite tiles managers ROM usage reduced.
map_collision example added.
memcmp optimized.- Link flags fixed.
- Brightness, contrast and intensity color effects optimized.
- bn::random internal variables are
protected to allow child classes to access them. compile_commands.json generation support.
memset undefined references with link-time optimization fixed.
memset moved to IWRAM.- Backdrop fade blending fixed.
bn::any management with types that can't be copied, moved or swapped fixed.
- BN_BASIC_ASSERT added.
- Repeated color palettes reduction can be disabled when importing a regular background. See the Regular backgrounds import guide to learn how to disable it.
- Unaligned byte
memset fixed. - Asserts without diagnostic information ROM usage reduced.
- Input tiles in
dynamic_regular_bg and dynamic_affine_bg examples are imported without using a map. - Frequently asked questions (FAQ) page improved.
Recovery of deleted background maps fixed.
- SRAM magic string fixed.
BN_CODE_IWRAM macro can be used for thumb code too.- Destructors of classes with
_ptr suffix ROM usage reduced. - 4BPP regular backgrounds quantization improved.
- Some error messages improved.
- Import images guide explains why Usenti is recommended over other image editors.
- bn::sprite_text_generator variable width fonts rendering fixed and optimized.
- Sprite shape and size update ROM usage reduced.
- Some Cppcheck warnings removed.
- Automatic sprite double size detection fixed.
- Sprite tiles management optimized (EWRAM and CPU usage reduced).
- Background tiles and maps management optimized (EWRAM and CPU usage reduced).
- Color palettes management CPU usage reduced.
- Sprites and sprite affine mats management CPU usage reduced.
- Backgrounds management CPU usage reduced.
- Cameras management CPU usage reduced.
- Sprite tiles delayed commit fixed.
- V-Blank interrupt management optimized (EWRAM and CPU usage reduced).
- Missed link messages frequency reduced.
- bn::timer::elapsed_ticks optimized.
- (Breaking change) bn::aligned fixed.
- Color effects optimized.
Huffman images compression support (make sure to update devkitARM before using it).
- Avoid data decompression in V-Blank if possible.
- Audio updates can no longer be interrupted.
- bn::audio::dmg_sync_enabled and bn::audio::set_dmg_sync_enabled added.
- Custom assembler flags can be specified in the project's
Makefile. - GBT Player updated to 4.4.1.
- bn::fixed, bn::optional, bn::string_view and bn::span are no longer forward declared in the public API.
- Text color in assert and profile screens improved.
- Audio volume setup optimized.
- Clouds restored in
world_map example.
- Custom linker flags can be specified in the project's
Makefile. - Asserts ROM usage reduced.
- Audio startup fixed when link-time optimization is enabled.
- Audio stop fixed when link communication is active.
- Parallel link-time optimization temporal files ignored and added to the list of files to clean.
BMP files colors count calculation fixed (again).
- Hue shift palette effect added. See the
palettes example to learn how to use it. - Brightness effect ROM usage reduced.
- bn::sprite_item and bn::sprite_tiles_item size reduced.
- Automatic sprite double size detection fixed.
- bn::hbe_visible_toggle_action removed, since it was not possible to use it.
- Clang build fixes.
- Clang-Tidy warnings fixed.
- New games made with Butano added to
README.md.
- Modified assets detection optimized.
- Audio and graphics tools unified in order to reduce build time.
- bn::newton_raphson_sqrt removed, since it doesn't work for bn::fixed input values.
- An external bn::bg_palette_item can be specified when importing regular and affine backgrounds.
- Colors count can be specified when importing sprite and background palettes.
- Standard containers equality comparison optimized.
- Asserts file name hack fixed.
- Universal GBA Library LGPL license files removed.
- Standard containers documentation improved.
- Frequently asked questions (FAQ) page improved.
- Maps commit optimized by more than 50% in some cases.
- Integer alignment at minimum enforced in all containers.
- BG blocks manager and sprite tiles manager commit fixed.
- (Security issue) Source code files full path is not stored in output ROMs anymore.
- Some Clang-Tidy and Cppcheck warnings removed.
Audio and HDMA issues when updating at less than 60FPS fixed.
- Run-length is preferred to LZ77 when choosing best compression mode.
- Sprites automatic double size mode and affine matrix management fixed.
- Frequently asked questions (FAQ) page improved.
- bn::sprite_text_generator can now plot multiple 16x16 variable width characters in a single sprite.
- bn::sprite_text_generator IWRAM usage reduced.
- Third party libraries to link can be specified in the project's
Makefile. - Project's
Makefile allows to build source files generated with an external tool. See the external_tool example to learn how to do it. butano-audio-tool.py generates a list of all available music and sound items with their name.audio_player example added.- Varooom 3D improved (check its
readme.txt file for details).
- Varooom 3D source code and assets added.
- Maximum number of active H-Blank effects reduced to 6.
- Common files moved to
common namespace.
- Generated items are now
constexpr inline to avoid being copied to every translation unit. - Sprites EWRAM usage reduced.
- Different type backgrounds sorting fixed.
- bn::sort with 128bit sort keys fixed.
- IRQs setup during startup improved.
- An external tool can be called from the project's
Makefile. See the external_tool example to learn how to call it. - Affine background tiles offset optimized.
- Big numbers to string conversion optimized.
- 32bit integer division optimized.
- 64bit integer division by 0 assert added.
- Big maps maximum valid position fixed.
- Compressed tiles warning fixed.
- GCC11 warning fixed.
- Some 8x8 sprite text characters fixed.
- Qt Creator setup guide added.
- More questions added to Frequently asked questions (FAQ) page.
dynamic_bg example added.- Affine background tiles offset fixed.
- bn::sprite_font supports all sprite shapes and sizes.
- Trivial type containers destruction optimized.
- Container destructors are always
noexcept. - Redundant container asserts removed.
- GPIO direction register setup.
- Sprites optimized.
- Blending optimized.
- Mosaic optimized.
- Internal memory transfers optimized.
texture_polygons example affine parameters fixed.- Clouds removed from
world_map example.
- Automatic sprite double size detection improved.
- Butano Fighter allows to disable rumble in the title menu.
Automatic sprite double size detection fixed.
BG blocks manager use after move fixed.
- SRAM memory usage reduced.
- Sprite animate actions memory usage reduced.
- Missing asserts added to some actions.
- bn::random is now a trivial class.
- BG blocks manager search fixed.
world_map example frame rate back to 60FPS.
- Sprite tiles generation outputs sprite shape and size.
- BN_ASSERT and BN_ERROR can be modified or disabled for specific code sections.
- Sprites IWRAM usage reduced.
- Some internal asserts removed.
- Profiler screen fixed.
- Documentation explains how to place data in ROM.
- bn::sprite_font allows to specify space between characters.
- Background palettes bits per pixel mode can be specified by the user.
- Palettes change optimized.
- Unused palette colors are not imported anymore.
- bn::sprite_ptr::set_tiles() validation fixed.
- H-Blank effects EWRAM usage reduced (more than 2KB by default).
- Optimization level changed to
-O2 to avoid another No$gba crash. - SRAM code moved back from ROM to EWRAM, since doing that doesn't make No$gba crash anymore.
- Redundant reset code removed.
- Sprite and background palettes can be generated from images alone, without tiles or maps.
<cstddef> is always included (bn_cstddef.h header file removed).- bn::unordered_map and bn::unordered_set assignment fixed.
- H-Blank effects optimized (it fixes
world_map example flickering). - SRAM code moved from EWRAM to ROM to avoid a No$gba crash.
- HDMA properly supported (now it works at less than 60fps). See bn::hdma and the
hdma_polygons example for more. - gba-link-connection remote timeout detection fixed.
- By removing some method overloads, lots of runtime asserts when creating resources have been removed.
- bn::palette_bpp_mode has been renamed to bn::bpp_mode and
bpp_mode() methods have been renamed to bpp(). - 8 bits per pixel background tiles allocation fixed.
btn renamed to bn. No more API breaks will be made between minor releases after 1.0.0, promise.- Background tiles manager status can be printed in the log with bn::bg_tiles::log_status(). This is done automatically when a non-optional background tiles allocation fails too.
- Background regular maps manager status can be printed in the log with bn::bg_maps::log_status(). This is done automatically when a non-optional regular background map allocation fails too.
- Sprite tiles manager status can be printed in the log with bn::sprite_tiles::log_status(). This is done automatically when a non-optional sprite tiles allocation fails too.
- Color palettes managers status can be printed in the log with bn::bg_palettes::log_status() and bn::sprite_palettes::log_status(). This is done automatically when a non-optional color palette allocation fails too.
- Sprites destruction optimized.
- Setters with an optional parameter added to some classes.
- Optional components documentation fixed.
- Other documentation improvements.
- Sprites update performance improved up to 30% in Butano Fighter thanks to avoid rebuilding sprites list as much as possible.
- Profiler can show the maximum measured ticks per entry.
- Assets tools print output binaries size.
- Performance improved up to 12% in Butano Fighter without
-flto thanks to using less build translation units. - Documentation improved.
diff --git a/docs/getting_started_wt.html b/docs/getting_started_wt.html
index f0a2b507..9b5da005 100644
--- a/docs/getting_started_wt.html
+++ b/docs/getting_started_wt.html
@@ -62,10 +62,11 @@ Contents
Downloading Butano and building their games and examples is easy and doesn't take too much time, pinky promise.
Before anything, it is convenient to have a GBA emulator at hand, so you don't have to test in real hardware each change you make in your project.
For developing GBA games, mGBA, NanoBoyAdvance, Mesen and the debug version of No$gba are recommended.
The next step is to download and install Wonderful Toolchain using this tutorial.
From now on, this guide assumes a Windows environment, but the steps to take for Unix-like platforms should be similar.
Once installed, open the Wonderful Toolchain Shell and run the following commands, accepting the default options when prompted:
pacman -S make
+wf-pacman -Syu wf-tools
+wf-config repo enable blocksds
wf-pacman -Syu
-wf-pacman -S toolchain-gcc-arm-none-eabi
-wf-pacman -S thirdparty-blocksds-toolchain
-wf-pacman -S target-gba
To execute some of the tools needed to include image and audio files in your project, you are going to need Python.
If you are going to install Python on Windows, remember to add it to the PATH and to close all system console windows before installing it:
Both Python 2 and Python 3 are supported for now, but Python 2 is not going to be supported for too long. Make sure you can execute Python from the Wonderful Toolchain Shell:
If you have an Ubuntu/Debian based system with python3 instead of python, you can:
- Specify
python3 as the Python interpreter path in the Makefile of the project you are trying to build. - Install
python-is-python3: sudo apt-get install python-is-python3.
Download or clone the latest Butano release from GitHub and put it in a path without spaces or anything weird, please.
Butano contains multiple examples of most aspects of the engine.
Make sure that you are able to build and run some of them:
- They are located in
/path/to/butano/examples/. - To build a Butano example, open the Wonderful Toolchain Shell,
cd to the folder of the example you want to build and type make -j8 if your CPU has 8 cores, make -j16 if it has 16 and so on.
When trying to build the sprites example, if everything went as expected, a sprites.gba file should have been generated in the sprites folder, and the system console should show something like this:
If you were able to build and run some examples, congrats! Now you can make your own GBA game with Butano. To do that:
- Copy the template project located in
/path/to/butano/template/ to a path without spaces or weird characters. - Change in the
Makefile the path in which Butano library folder is located. For example, if Butano is located in /path/to/butano/, LIBBUTANO variable should be set to /path/to/butano/butano. - If you want, you can also change ROM title, ROM code and more in the
Makefile. cd to the new folder.- Type
make -j#cpu_cores# again.
If everything went as expected, a *.gba file should have been generated in the project folder!
Now learn how to import your assets in the game and also take a look at the modules page. It's always a good idea to play around with the examples as they cover most of what Butano offers. The frequently asked questions (FAQ) are worth a look too, as they answer most of the initial questions.
+wf-pacman -S target-gba
+wf-pacman -S blocksds-toolchainTo execute some of the tools needed to include image and audio files in your project, you are going to need Python.
If you are going to install Python on Windows, remember to add it to the PATH and to close all system console windows before installing it:
Both Python 2 and Python 3 are supported for now, but Python 2 is not going to be supported for too long. Make sure you can execute Python from the Wonderful Toolchain Shell:
If you have an Ubuntu/Debian based system with python3 instead of python, you can:
- Specify
python3 as the Python interpreter path in the Makefile of the project you are trying to build. - Install
python-is-python3: sudo apt-get install python-is-python3.
Download or clone the latest Butano release from GitHub and put it in a path without spaces or anything weird, please.
Butano contains multiple examples of most aspects of the engine.
Make sure that you are able to build and run some of them:
- They are located in
/path/to/butano/examples/. - To build a Butano example, open the Wonderful Toolchain Shell,
cd to the folder of the example you want to build and type make -j8 if your CPU has 8 cores, make -j16 if it has 16 and so on.
When trying to build the sprites example, if everything went as expected, a sprites.gba file should have been generated in the sprites folder, and the system console should show something like this:
If you were able to build and run some examples, congrats! Now you can make your own GBA game with Butano. To do that:
- Copy the template project located in
/path/to/butano/template/ to a path without spaces or weird characters. - Change in the
Makefile the path in which Butano library folder is located. For example, if Butano is located in /path/to/butano/, LIBBUTANO variable should be set to /path/to/butano/butano. - If you want, you can also change ROM title, ROM code and more in the
Makefile. cd to the new folder.- Type
make -j#cpu_cores# again.
If everything went as expected, a *.gba file should have been generated in the project folder!
Now learn how to import your assets in the game and also take a look at the modules page. It's always a good idea to play around with the examples as they cover most of what Butano offers. The frequently asked questions (FAQ) are worth a look too, as they answer most of the initial questions.