From c362c5f41326709909fd9e261765b2ece2344218 Mon Sep 17 00:00:00 2001 From: GValiente Date: Mon, 23 Dec 2024 17:17:22 +0100 Subject: [PATCH] documentation: getting started with wonderful toolchain guide updated --- .../documentation/bn_documentation_ab_getting_started_wt.h | 5 +++-- .../include/documentation/bn_documentation_g_changelog.h | 1 + docs/changelog.html | 2 +- docs/getting_started_wt.html | 7 ++++--- 4 files changed, 9 insertions(+), 6 deletions(-) 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 b0ef481af..3cbccada5 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 50a126242..fb14b54c1 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 5d19b32e2..eeef29567 100644 --- a/docs/changelog.html +++ b/docs/changelog.html @@ -218,7 +218,7 @@

Contents

  • 0.1.0
    • -

    18.7.0 (next release)

    18.6.0

    18.5.0

    18.4.0

    18.3.0

    18.2.1

    18.2.0

    18.1.0

    18.0.1

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

    18.0.0

    17.9.0

    17.8.1

    17.8.0

    17.7.0

    17.6.0

    17.5.0

    17.4.0

    17.3.0

    17.2.0

    17.1.1

    bn::unique_ptr move fixed.

    17.1.0

    17.0.0

    16.6.0

    16.5.0

    16.4.0

    16.3.0

    16.2.0

    16.1.0

    16.0.0

    15.9.0

    15.8.2

    15.8.1

    bn::vector::assign fixed.

    15.8.0

    15.7.1

    Python 2 support restored.

    15.7.0

    15.6.0

    15.5.0

    15.4.1

    bn::core::reset race condition fixed.

    15.4.0

    15.3.2

    BG blocks commit fixed.

    15.3.1

    Slow game pak detection fixed (again).

    15.3.0

    15.2.0

    15.1.0

    15.0.0

    14.1.0

    14.0.0

    13.18.0

    13.17.0

    13.16.1

    bn::ibitset AND operator fixed.

    13.16.0

    13.15.0

    13.14.0

    13.13.0

    13.12.1

    Tonclib linking error fixed.

    13.12.0

    13.11.0

    13.10.1

    memset undefined references with link-time optimization fixed.

    13.10.0

    13.9.0

    13.8.1

    bn::any management with types that can't be copied, moved or swapped fixed.

    13.8.0

    13.7.0

    13.6.0

    13.5.0

    13.4.0

    13.3.1

    bn::erase and bn::erase_if fixed.

    13.3.0

    13.2.0

    13.1.1

    Recovery of deleted background maps fixed.

    13.1.0

    13.0.0

    12.5.0

    BN_CFG_ASSERT_SHOW_DIAGNOSTIC added.

    12.4.0

    12.3.0

    12.2.0

    12.1.0

    12.0.0

    11.0.1

    bn::string::starts_with and bn::string_view::starts_with fixed.

    11.0.0

    Huffman images compression support (make sure to update devkitARM before using it).

    10.7.0

    10.6.1

    bn::bitset AND, OR and XOR operators fixed.

    10.6.0

    10.5.0

    10.4.0

    10.3.0

    10.2.0

    10.1.0

    10.0.0

    9.5.0

    9.4.1

    BMP files colors count calculation fixed (again).

    9.4.0

    9.3.0

    9.2.0

    9.1.1

    bn::calculate_sin_lut_value sine and cosine symmetry with 135 and 315 degrees fixed.

    9.1.0

    9.0.0

    8.10.0

    8.9.0

    8.8.0

    8.7.0

    8.6.0

    8.5.0

    8.4.0

    8.3.0

    8.2.0

    8.1.0

    8.0.0

    7.8.0

    7.7.0

    7.6.0

    7.5.1

    Audio and HDMA issues when updating at less than 60FPS fixed.

    7.5.0

    7.4.0

    7.3.0

    7.2.0

    7.1.1

    bn::vector, bn::unordered_map and bn::unordered_set move constructors and assignment operators fixed.

    7.1.0

    7.0.1

    bn::format build fix.

    7.0.0

    6.18.0

    6.17.1

    6.17.0

    6.16.0

    6.15.0

    6.14.0

    6.13.1

    6.13.0

    6.12.0

    6.11.0

    6.10.0

    6.9.0

    6.8.0

    6.7.0

    6.6.2

    Automatic sprite double size detection fixed.

    6.6.1

    BG blocks manager use after move fixed.

    6.6.0

    6.5.0

    6.4.0

    6.3.0

    6.2.0

    6.1.0

    6.0.0

    5.3.1

    bn::atan2 and bn::degrees_atan2 fixed.

    5.3.0

    5.2.0

    5.1.0

    5.0.0

    4.4.0

    4.3.0

    4.2.0

    4.1.0

    4.0.0

    3.3.0

    3.2.1

    bn::optional build fix.

    3.2.0

    bn::optional is now constexpr.

    3.1.0

    3.0.0

    Thanks to the awesome gba-link-connection, multiplayer support has been implemented! See bn::link and the link example for more.

    2.0.0

    1.0.0

    0.4.0

    0.3.0

    0.2.0

    0.1.0

    First release.

    +

    18.7.0 (next release)

    18.6.0

    18.5.0

    18.4.0

    18.3.0

    18.2.1

    18.2.0

    18.1.0

    18.0.1

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

    18.0.0

    17.9.0

    17.8.1

    17.8.0

    17.7.0

    17.6.0

    17.5.0

    17.4.0

    17.3.0

    17.2.0

    17.1.1

    bn::unique_ptr move fixed.

    17.1.0

    17.0.0

    16.6.0

    16.5.0

    16.4.0

    16.3.0

    16.2.0

    16.1.0

    16.0.0

    15.9.0

    15.8.2

    15.8.1

    bn::vector::assign fixed.

    15.8.0

    15.7.1

    Python 2 support restored.

    15.7.0

    15.6.0

    15.5.0

    15.4.1

    bn::core::reset race condition fixed.

    15.4.0

    15.3.2

    BG blocks commit fixed.

    15.3.1

    Slow game pak detection fixed (again).

    15.3.0

    15.2.0

    15.1.0

    15.0.0

    14.1.0

    14.0.0

    13.18.0

    13.17.0

    13.16.1

    bn::ibitset AND operator fixed.

    13.16.0

    13.15.0

    13.14.0

    13.13.0

    13.12.1

    Tonclib linking error fixed.

    13.12.0

    13.11.0

    13.10.1

    memset undefined references with link-time optimization fixed.

    13.10.0

    13.9.0

    13.8.1

    bn::any management with types that can't be copied, moved or swapped fixed.

    13.8.0

    13.7.0

    13.6.0

    13.5.0

    13.4.0

    13.3.1

    bn::erase and bn::erase_if fixed.

    13.3.0

    13.2.0

    13.1.1

    Recovery of deleted background maps fixed.

    13.1.0

    13.0.0

    12.5.0

    BN_CFG_ASSERT_SHOW_DIAGNOSTIC added.

    12.4.0

    12.3.0

    12.2.0

    12.1.0

    12.0.0

    11.0.1

    bn::string::starts_with and bn::string_view::starts_with fixed.

    11.0.0

    Huffman images compression support (make sure to update devkitARM before using it).

    10.7.0

    10.6.1

    bn::bitset AND, OR and XOR operators fixed.

    10.6.0

    10.5.0

    10.4.0

    10.3.0

    10.2.0

    10.1.0

    10.0.0

    9.5.0

    9.4.1

    BMP files colors count calculation fixed (again).

    9.4.0

    9.3.0

    9.2.0

    9.1.1

    bn::calculate_sin_lut_value sine and cosine symmetry with 135 and 315 degrees fixed.

    9.1.0

    9.0.0

    8.10.0

    8.9.0

    8.8.0

    8.7.0

    8.6.0

    8.5.0

    8.4.0

    8.3.0

    8.2.0

    8.1.0

    8.0.0

    7.8.0

    7.7.0

    7.6.0

    7.5.1

    Audio and HDMA issues when updating at less than 60FPS fixed.

    7.5.0

    7.4.0

    7.3.0

    7.2.0

    7.1.1

    bn::vector, bn::unordered_map and bn::unordered_set move constructors and assignment operators fixed.

    7.1.0

    7.0.1

    bn::format build fix.

    7.0.0

    6.18.0

    6.17.1

    6.17.0

    6.16.0

    6.15.0

    6.14.0

    6.13.1

    6.13.0

    6.12.0

    6.11.0

    6.10.0

    6.9.0

    6.8.0

    6.7.0

    6.6.2

    Automatic sprite double size detection fixed.

    6.6.1

    BG blocks manager use after move fixed.

    6.6.0

    6.5.0

    6.4.0

    6.3.0

    6.2.0

    6.1.0

    6.0.0

    5.3.1

    bn::atan2 and bn::degrees_atan2 fixed.

    5.3.0

    5.2.0

    5.1.0

    5.0.0

    4.4.0

    4.3.0

    4.2.0

    4.1.0

    4.0.0

    3.3.0

    3.2.1

    bn::optional build fix.

    3.2.0

    bn::optional is now constexpr.

    3.1.0

    3.0.0

    Thanks to the awesome gba-link-connection, multiplayer support has been implemented! See bn::link and the link example for more.

    2.0.0

    1.0.0

    0.4.0

    0.3.0

    0.2.0

    0.1.0

    First release.

    diff --git a/docs/getting_started_wt.html b/docs/getting_started_wt.html index f0a2b507f..9b5da0058 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.

    Supported platforms

    Wonderful Toolchain supports Windows and Unix-like platforms.

    If you want to develop on macOS, you should try to use a Linux virtual machine or devkitARM instead.

    GBA emulator

    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.

    Wonderful Toolchain

    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.

    Image

    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
    Image

    Python

    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:

    Image

    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:

    Image

    If you have an Ubuntu/Debian based system with python3 instead of python, you can:

    Butano

    Download or clone the latest Butano release from GitHub and put it in a path without spaces or anything weird, please.

    Butano examples

    Butano contains multiple examples of most aspects of the engine.

    Make sure that you are able to build and run some of them:

    Image

    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:

    Image

    Make your own GBA game!

    If you were able to build and run some examples, congrats! Now you can make your own GBA game with Butano. To do that:

    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-toolchainImage

    Python

    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:

    Image

    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:

    Image

    If you have an Ubuntu/Debian based system with python3 instead of python, you can:

    Butano

    Download or clone the latest Butano release from GitHub and put it in a path without spaces or anything weird, please.

    Butano examples

    Butano contains multiple examples of most aspects of the engine.

    Make sure that you are able to build and run some of them:

    Image

    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:

    Image

    Make your own GBA game!

    If you were able to build and run some examples, congrats! Now you can make your own GBA game with Butano. To do that:

    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.