3DS:BAX: Difference between revisions

Line 1:

{{Page WIP|notes=

* {{~~WIP~~}} Needs installation instructions

* {{Done}} Needs installation instructions

* {{Done}} Needs subpage for instructions on makebax

* Needs configuration info

* {{Done}} Needs configuration info

* Needs usage info

* Make important notes flashier

* {{WIP}}Make important notes flashier

}}

Line 14:

| gitlab = Wolfvak/BAX

}}

'''BAX''' is a homebrew program for the Nintendo 3DS (compatible with all models) that allows you to display video streams on load. Thanks to boot-time entrypoints, this can be done on boot, giving a similar impression to the loading animation of a PC or a mobile smartphone. Please note that while it's designed to boot another program, it does not allow both itself and the other to run concurrently, but rather sequentially. Therefore, any time that is "taken" by loading/playing the animation file will not be somehow "given" to the next program ~~(f.e. independently of~~ the time ~~taken~~ by the ~~animation,~~ the ~~FIRM will take the same amount of time to load)~~.

'''BAX''' is a homebrew program for the Nintendo 3DS (compatible with all models) that allows you to display video streams on load. Thanks to boot-time entrypoints, this can be done on boot, giving a similar impression to the loading animation of a PC or a mobile smartphone. Please note that while it's designed to boot another program, it does not allow both itself and the other to run concurrently, but rather sequentially. Therefore, any time that is "taken" by loading/playing the animation file will not be somehow "given" to the next program - having BAX installed will always increase the boot time by the length of the video.

== Important Notes ==

==Important Notes==

* BAX can not be booted from a FIRM partition or an ~~NTRboot cart~~. ~~Don't even try~~.

* BAX can not be booted from NAND, a FIRM partition, or an NTRBoot flashcart. Trying will only cause problems.

* Due to how Horizon/NATIVE_FIRM works, if you reboot from AGB_FIRM (GBA Virtual Console) the save game will not be saved until you reboot back into it again.

* BAX performs no GPU initialization, only register tweaks and assumes the GPU has already been initialized by the time it boots. Any B9S-compatible loaders should do this, given the proper bit is set in the FIRM (it certainly is in BAX), but it can not realistically provide support for every existing loader out there.

* BAX performs no GPU initialization, only register tweaks, and assumes the GPU has already been initialized by the time it boots. Any B9S-compatible loaders should do this, given the proper bit is set in the FIRM (it certainly is in BAX), but it can not realistically provide support for every existing loader out there.

* To create animation files for BAX, see [[3DS:BAX/makebax#Creating_.BAX_Animations|here.]]

== Installation ==

==Installation==

|-|I use boot9strap=

{{info|text=Following these instructions will move your Luma3DS firmware file to <code>SD:/bax/boot.firm</code>, ~~instead of~~ <code>SD:/boot.firm</code>. Please keep this in mind when updating Luma3DS in the future so you don't accidentally overwrite BAX~~'s FIRM payload~~.}}

{{info|text=Following these instructions will move your Luma3DS firmware file to <code>sdmc:/bax/boot.firm</code>, with <code>sdmc:/boot.firm</code> being the BAX payload instead. Please keep this in mind when updating Luma3DS in the future so you don't accidentally overwrite BAX.}}

# Download and the latest release of BAX from its {{GitLab|Wolfvak/BAX/-/releases|GitLab page}} (The <code>release.zip</code> file)

# Insert your console's SD card into your computer

# Create a folder named <code>bax</code> on the root ~~your SD card~~

# Create a folder named <code>bax</code> on the SD root

# Move your existing <code>boot.firm</code> file into <code>~~SD:/~~bax/</code>

# Move your existing <code>boot.firm</code> file into the <code>bax</code> folder

# Copy <code>BAX.firm</code> from <code>release.zip</code> into the root of your SD card

# Rename the <code>BAX.firm</code> you copied to <code>boot.firm</code>

# Copy your BAX animation files to <code>SD:/bax/</code>

# Copy your BAX animation files to <code>sdmc:/bax/</code>

~~#* For instructions on how to create BAX animations, see [[3DS:BAX/makebax#Creating_.BAX_Animations|here]]~~

# Your SD card should now look something like this:

Line 51:

|-|I use fastboot3DS=

{{info|text=Following these instructions will move your Luma3DS firmware file to <code>sdmc:/bax/boot.firm</code>, and may move other files elsewhere depending on your setup. Please keep these new locations in mind when updating files in the future, or else the updated file may not be the one that's loaded into use.}}

# Download and the latest release of BAX from its {{GitLab|Wolfvak/BAX/-/releases|GitLab page}} (The <code>release.zip</code> file)

# Insert your console's SD card into your computer

~~WIP~~

# Create a folder named <code>bax</code> on the SD root

# Move your existing <code>boot.firm</code> into the <code>bax</code> folder

# Copy <code>BAX.firm</code> from the <code>release.zip</code> to a place of your choosing, such as inside a folder on the SD root named <code>firm</code>

# Copy your BAX animation files to <code>sdmc:/bax/</code>

# Boot into the fastboot3DS configuration menu by holding {{B|HOME}} while powering on

# Go to <code>Boot setup...</code> and select the first slot, then select <code>Select [slot 1] firm</code> and navigate to where you put <code>BAX.firm</code> on the SD card

# Once selected, ensure <code>Set [slot 1] autoboot</code> is checked and back out to the main menu

# To test, go into <code>Boot menu...</code> and select <code>Boot [slot 1]</code>; your animation should load, then the system should load normally

# Your SD card layout may vary, but if you followed the instructions' suggestion, it will look like this:

* [[File:Gnome-media-flash.svg|20px|link=]] (root)

** [[File:Icons8 flat opened folder.svg|20px|link=]] bax

*** [[File:Icons8 flat file.svg|20px|link=]] '''boot.firm''' (Your existing Luma3DS file)

*** [[File:Icons8 flat file.svg|20px|link=]] '''my_animation_1.bax'''

*** [[File:Icons8 flat file.svg|20px|link=]] '''my_animation_2.bax'''

*** [[File:Icons8 flat file.svg|20px|link=]] '''my_animation_3.bax'''

** [[File:Icons8 flat opened folder.svg|20px|link=]] firm

*** [[File:Icons8 flat file.svg|20px|link=]] '''BAX.firm''' (the file in the first boot slot of fastboot3DS)

** [[File:Icons8 flat file.svg|20px|link=]] '''boot.3dsx'''

</tabber>

== Configuration ==

==Configuration==

~~WIP~~

If you create a text file, <code>sdmc:/bax/boot.txt</code>, that only contains a plaintext file path to a <code>.firm</code> file (such as <code>sdmc:/firm/Luma3DS.firm</code>, then when <code>BAX.firm</code> boots it will boot that file instead of <code>sdmc:/bax/boot.firm</code>.

@@ Line 1: / Line 1: @@
 {{Page WIP|notes=
-* {{WIP}} Needs installation instructions
+* {{Done}} Needs installation instructions
 * {{Done}} Needs subpage for instructions on makebax
-* Needs configuration info
+* {{Done}} Needs configuration info
 * Needs usage info
-* Make important notes flashier
+* {{WIP}}Make important notes flashier
 }}
@@ Line 14: / Line 14: @@
 | gitlab = Wolfvak/BAX
 }}
-'''BAX''' is a homebrew program for the Nintendo 3DS (compatible with all models) that allows you to display video streams on load. Thanks to boot-time entrypoints, this can be done on boot, giving a similar impression to the loading animation of a PC or a mobile smartphone. Please note that while it's designed to boot another program, it does not allow both itself and the other to run concurrently, but rather sequentially. Therefore, any time that is "taken" by loading/playing the animation file will not be somehow "given" to the next program (f.e. independently of the time taken by the animation, the FIRM will take the same amount of time to load).
+'''BAX''' is a homebrew program for the Nintendo 3DS (compatible with all models) that allows you to display video streams on load. Thanks to boot-time entrypoints, this can be done on boot, giving a similar impression to the loading animation of a PC or a mobile smartphone. Please note that while it's designed to boot another program, it does not allow both itself and the other to run concurrently, but rather sequentially. Therefore, any time that is "taken" by loading/playing the animation file will not be somehow "given" to the next program - having BAX installed will always increase the boot time by the length of the video.
-== Important Notes ==
+==Important Notes==
-* BAX can not be booted from a FIRM partition or an NTRboot cart. Don't even try.
+* BAX can not be booted from NAND, a FIRM partition, or an NTRBoot flashcart. Trying will only cause problems.
 * Due to how Horizon/NATIVE_FIRM works, if you reboot from AGB_FIRM (GBA Virtual Console) the save game will not be saved until you reboot back into it again.
-* BAX performs no GPU initialization, only register tweaks and assumes the GPU has already been initialized by the time it boots. Any B9S-compatible loaders should do this, given the proper bit is set in the FIRM (it certainly is in BAX), but it can not realistically provide support for every existing loader out there.
+* BAX performs no GPU initialization, only register tweaks, and assumes the GPU has already been initialized by the time it boots. Any B9S-compatible loaders should do this, given the proper bit is set in the FIRM (it certainly is in BAX), but it can not realistically provide support for every existing loader out there.
+* To create animation files for BAX, see [[3DS:BAX/makebax#Creating_.BAX_Animations|here.]]
-== Installation ==
+==Installation==
 <tabber>
 |-|I use boot9strap=
-{{info|text=Following these instructions will move your Luma3DS firmware file to <code>SD:/bax/boot.firm</code>, instead of <code>SD:/boot.firm</code>. Please keep this in mind when updating Luma3DS in the future so you don't accidentally overwrite BAX's FIRM payload.}}
+{{info|text=Following these instructions will move your Luma3DS firmware file to <code>sdmc:/bax/boot.firm</code>, with <code>sdmc:/boot.firm</code> being the BAX payload instead. Please keep this in mind when updating Luma3DS in the future so you don't accidentally overwrite BAX.}}
 # Download and the latest release of BAX from its {{GitLab|Wolfvak/BAX/-/releases|GitLab page}} (The <code>release.zip</code> file)
 # Insert your console's SD card into your computer
-# Create a folder named <code>bax</code> on the root your SD card
+# Create a folder named <code>bax</code> on the SD root
-# Move your existing <code>boot.firm</code> file into <code>SD:/bax/</code>
+# Move your existing <code>boot.firm</code> file into the <code>bax</code> folder
 # Copy <code>BAX.firm</code> from <code>release.zip</code> into the root of your SD card
 # Rename the <code>BAX.firm</code> you copied to <code>boot.firm</code>
-# Copy your BAX animation files to <code>SD:/bax/</code>
+# Copy your BAX animation files to <code>sdmc:/bax/</code>
-#* For instructions on how to create BAX animations, see [[3DS:BAX/makebax#Creating_.BAX_Animations|here]]
 # Your SD card should now look something like this:
 {{Tree list}}
@@ Line 51: / Line 51: @@
 |-|I use fastboot3DS=
+{{info|text=Following these instructions will move your Luma3DS firmware file to <code>sdmc:/bax/boot.firm</code>, and may move other files elsewhere depending on your setup. Please keep these new locations in mind when updating files in the future, or else the updated file may not be the one that's loaded into use.}}
 # Download and the latest release of BAX from its {{GitLab|Wolfvak/BAX/-/releases|GitLab page}} (The <code>release.zip</code> file)
 # Insert your console's SD card into your computer
-WIP
+# Create a folder named <code>bax</code> on the SD root
+# Move your existing <code>boot.firm</code> into the <code>bax</code> folder
+# Copy <code>BAX.firm</code> from the <code>release.zip</code> to a place of your choosing, such as inside a folder on the SD root named <code>firm</code>
+# Copy your BAX animation files to <code>sdmc:/bax/</code>
+# Boot into the fastboot3DS configuration menu by holding {{B|HOME}} while powering on
+# Go to <code>Boot setup...</code> and select the first slot, then select <code>Select [slot 1] firm</code> and navigate to where you put <code>BAX.firm</code> on the SD card
+# Once selected, ensure <code>Set [slot 1] autoboot</code> is checked and back out to the main menu
+# To test, go into <code>Boot menu...</code> and select <code>Boot [slot 1]</code>; your animation should load, then the system should load normally
+# Your SD card layout may vary, but if you followed the instructions' suggestion, it will look like this:
+{{Tree list}}
+* [[File:Gnome-media-flash.svg|20px|link=]] (root)
+** [[File:Icons8 flat opened folder.svg|20px|link=]] bax
+*** [[File:Icons8 flat file.svg|20px|link=]] '''boot.firm''' (Your existing Luma3DS file)
+*** [[File:Icons8 flat file.svg|20px|link=]] '''my_animation_1.bax'''
+*** [[File:Icons8 flat file.svg|20px|link=]] '''my_animation_2.bax'''
+*** [[File:Icons8 flat file.svg|20px|link=]] '''my_animation_3.bax'''
+** [[File:Icons8 flat opened folder.svg|20px|link=]] firm
+*** [[File:Icons8 flat file.svg|20px|link=]] '''BAX.firm''' (the file in the first boot slot of fastboot3DS)
+** [[File:Icons8 flat file.svg|20px|link=]] '''boot.3dsx'''
+{{Tree list/end}}
 </tabber>
-== Configuration ==
+==Configuration==
-WIP
+If you create a text file, <code>sdmc:/bax/boot.txt</code>, that only contains a plaintext file path to a <code>.firm</code> file (such as <code>sdmc:/firm/Luma3DS.firm</code>, then when <code>BAX.firm</code> boots it will boot that file instead of <code>sdmc:/bax/boot.firm</code>.