documentation: getting started with wonderful toolchain guide updated

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

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.
  *
  *

docs/getting_started_wt.html

@@ -62,10 +62,11 @@ <h3>Contents</h3>
           </ul>
         </nav>
 <p>Downloading Butano and building their games and examples is easy and doesn&#x27;t take too much time, pinky promise.</p><section id="getting_started_wt_supported_platforms"><h2><a href="#getting_started_wt_supported_platforms">Supported platforms</a></h2><p><a href="https://wonderful.asie.pl/">Wonderful Toolchain</a> supports Windows and Unix-like platforms.</p><p>If you want to develop on macOS, you should try to use a Linux virtual machine or <a href="getting_started.html" class="m-doc">devkitARM</a> instead.</p></section><section id="getting_started_wt_emulator"><h2><a href="#getting_started_wt_emulator">GBA emulator</a></h2><p>Before anything, it is convenient to have a GBA emulator at hand, so you don&#x27;t have to test in real hardware each change you make in your project.</p><p>For developing GBA games, <a href="https://mgba.io">mGBA</a>, <a href="https://github.com/nba-emu/NanoBoyAdvance">NanoBoyAdvance</a>, <a href="https://github.com/SourMesen/Mesen2">Mesen</a> and the debug version of <a href="https://problemkaputt.de/gba.htm">No$gba</a> are recommended.</p></section><section id="getting_started_wt_wt"><h2><a href="#getting_started_wt_wt">Wonderful Toolchain</a></h2><p>The next step is to download and install <a href="https://wonderful.asie.pl/">Wonderful Toolchain</a> using <a href="https://wonderful.asie.pl/docs/getting-started/">this tutorial</a>.</p><p>From now on, this guide assumes a Windows environment, but the steps to take for Unix-like platforms should be similar.</p><img class="m-image" src="wt_installer.png" alt="Image" /><p>Once installed, open the Wonderful Toolchain Shell and run the following commands, accepting the default options when prompted:</p><pre class="m-code"><span class="n">pacman</span><span class="w"> </span><span class="o">-</span><span class="n">S</span><span class="w"> </span><span class="n">make</span>
+<span class="n">wf</span><span class="o">-</span><span class="n">pacman</span><span class="w"> </span><span class="o">-</span><span class="n">Syu</span><span class="w"> </span><span class="n">wf</span><span class="o">-</span><span class="n">tools</span>
+<span class="n">wf</span><span class="o">-</span><span class="n">config</span><span class="w"> </span><span class="n">repo</span><span class="w"> </span><span class="n">enable</span><span class="w"> </span><span class="n">blocksds</span>
 <span class="n">wf</span><span class="o">-</span><span class="n">pacman</span><span class="w"> </span><span class="o">-</span><span class="n">Syu</span>
-<span class="n">wf</span><span class="o">-</span><span class="n">pacman</span><span class="w"> </span><span class="o">-</span><span class="n">S</span><span class="w"> </span><span class="n">toolchain</span><span class="o">-</span><span class="n">gcc</span><span class="o">-</span><span class="n">arm</span><span class="o">-</span><span class="n">none</span><span class="o">-</span><span class="n">eabi</span>
-<span class="n">wf</span><span class="o">-</span><span class="n">pacman</span><span class="w"> </span><span class="o">-</span><span class="n">S</span><span class="w"> </span><span class="n">thirdparty</span><span class="o">-</span><span class="n">blocksds</span><span class="o">-</span><span class="n">toolchain</span>
-<span class="n">wf</span><span class="o">-</span><span class="n">pacman</span><span class="w"> </span><span class="o">-</span><span class="n">S</span><span class="w"> </span><span class="n">target</span><span class="o">-</span><span class="n">gba</span></pre><img class="m-image" src="wt_pacman.png" alt="Image" /></section><section id="getting_started_wt_python"><h2><a href="#getting_started_wt_python">Python</a></h2><p>To execute some of the tools needed to include image and audio files in your project, you are going to need <a href="https://www.python.org/">Python</a>.</p><p>If you are going to install Python on Windows, remember to add it to the <code>PATH</code> and to close all system console windows before installing it:</p><img class="m-image" src="python_windows.png" alt="Image" /><p>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:</p><img class="m-image" src="wt_python.png" alt="Image" /><p>If you have an Ubuntu/Debian based system with <code>python3</code> instead of <code>python</code>, you can:</p><ul><li>Specify <code>python3</code> as the Python interpreter path in the <code>Makefile</code> of the project you are trying to build.</li><li>Install <code>python-is-python3</code>: <code>sudo apt-get install python-is-python3</code>.</li></ul></section><section id="getting_started_wt_butano"><h2><a href="#getting_started_wt_butano">Butano</a></h2><p>Download or clone the latest Butano release from <a href="https://github.com/GValiente/butano">GitHub</a> and put it in a path without spaces or anything weird, please.</p></section><section id="getting_started_wt_examples"><h2><a href="#getting_started_wt_examples">Butano examples</a></h2><p>Butano contains multiple <a href="examples.html" class="m-doc">examples</a> of most aspects of the engine.</p><p>Make sure that you are able to build and run some of them:</p><ul><li>They are located in <code>/path/to/butano/examples/</code>.</li><li>To build a Butano example, open the Wonderful Toolchain Shell, <code>cd</code> to the folder of the example you want to build and type <code>make -j8</code> if your CPU has 8 cores, <code>make -j16</code> if it has 16 and so on.</li></ul><img class="m-image" src="wt_example_1.png" alt="Image" /><p>When trying to build the <code>sprites</code> example, if everything went as expected, a <code>sprites.gba</code> file should have been generated in the <code>sprites</code> folder, and the system console should show something like this:</p><img class="m-image" src="wt_example_2.png" alt="Image" /></section><section id="getting_started_wt_template"><h2><a href="#getting_started_wt_template">Make your own GBA game!</a></h2><p>If you were able to build and run some examples, congrats! Now you can make your own GBA game with Butano. To do that:</p><ul><li>Copy the template project located in <code>/path/to/butano/template/</code> to a path without spaces or weird characters.</li><li>Change in the <code>Makefile</code> the path in which Butano library folder is located. For example, if Butano is located in <code>/path/to/butano/</code>, <code>LIBBUTANO</code> variable should be set to <code>/path/to/butano/butano</code>.</li><li>If you want, you can also change ROM title, ROM code and more in the <code>Makefile</code>.</li><li><code>cd</code> to the new folder.</li><li>Type <code>make -j#cpu_cores#</code> again.</li></ul><p>If everything went as expected, a <code>*.gba</code> file should have been generated in the project folder!</p><p>Now learn how to <a href="import.html" class="m-doc">import your assets</a> in the game and also take a look at the <a href="modules.html">modules</a> page. It&#x27;s always a good idea to play around with the examples as they cover most of what Butano offers. The <a href="faq.html" class="m-doc">frequently asked questions (FAQ)</a> are worth a look too, as they answer most of the initial questions.</p></section>
+<span class="n">wf</span><span class="o">-</span><span class="n">pacman</span><span class="w"> </span><span class="o">-</span><span class="n">S</span><span class="w"> </span><span class="n">target</span><span class="o">-</span><span class="n">gba</span>
+<span class="n">wf</span><span class="o">-</span><span class="n">pacman</span><span class="w"> </span><span class="o">-</span><span class="n">S</span><span class="w"> </span><span class="n">blocksds</span><span class="o">-</span><span class="n">toolchain</span></pre><img class="m-image" src="wt_pacman.png" alt="Image" /></section><section id="getting_started_wt_python"><h2><a href="#getting_started_wt_python">Python</a></h2><p>To execute some of the tools needed to include image and audio files in your project, you are going to need <a href="https://www.python.org/">Python</a>.</p><p>If you are going to install Python on Windows, remember to add it to the <code>PATH</code> and to close all system console windows before installing it:</p><img class="m-image" src="python_windows.png" alt="Image" /><p>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:</p><img class="m-image" src="wt_python.png" alt="Image" /><p>If you have an Ubuntu/Debian based system with <code>python3</code> instead of <code>python</code>, you can:</p><ul><li>Specify <code>python3</code> as the Python interpreter path in the <code>Makefile</code> of the project you are trying to build.</li><li>Install <code>python-is-python3</code>: <code>sudo apt-get install python-is-python3</code>.</li></ul></section><section id="getting_started_wt_butano"><h2><a href="#getting_started_wt_butano">Butano</a></h2><p>Download or clone the latest Butano release from <a href="https://github.com/GValiente/butano">GitHub</a> and put it in a path without spaces or anything weird, please.</p></section><section id="getting_started_wt_examples"><h2><a href="#getting_started_wt_examples">Butano examples</a></h2><p>Butano contains multiple <a href="examples.html" class="m-doc">examples</a> of most aspects of the engine.</p><p>Make sure that you are able to build and run some of them:</p><ul><li>They are located in <code>/path/to/butano/examples/</code>.</li><li>To build a Butano example, open the Wonderful Toolchain Shell, <code>cd</code> to the folder of the example you want to build and type <code>make -j8</code> if your CPU has 8 cores, <code>make -j16</code> if it has 16 and so on.</li></ul><img class="m-image" src="wt_example_1.png" alt="Image" /><p>When trying to build the <code>sprites</code> example, if everything went as expected, a <code>sprites.gba</code> file should have been generated in the <code>sprites</code> folder, and the system console should show something like this:</p><img class="m-image" src="wt_example_2.png" alt="Image" /></section><section id="getting_started_wt_template"><h2><a href="#getting_started_wt_template">Make your own GBA game!</a></h2><p>If you were able to build and run some examples, congrats! Now you can make your own GBA game with Butano. To do that:</p><ul><li>Copy the template project located in <code>/path/to/butano/template/</code> to a path without spaces or weird characters.</li><li>Change in the <code>Makefile</code> the path in which Butano library folder is located. For example, if Butano is located in <code>/path/to/butano/</code>, <code>LIBBUTANO</code> variable should be set to <code>/path/to/butano/butano</code>.</li><li>If you want, you can also change ROM title, ROM code and more in the <code>Makefile</code>.</li><li><code>cd</code> to the new folder.</li><li>Type <code>make -j#cpu_cores#</code> again.</li></ul><p>If everything went as expected, a <code>*.gba</code> file should have been generated in the project folder!</p><p>Now learn how to <a href="import.html" class="m-doc">import your assets</a> in the game and also take a look at the <a href="modules.html">modules</a> page. It&#x27;s always a good idea to play around with the examples as they cover most of what Butano offers. The <a href="faq.html" class="m-doc">frequently asked questions (FAQ)</a> are worth a look too, as they answer most of the initial questions.</p></section>
       </div>
     </div>
   </div>