3DS:BAX/makebax - Revision history

Aspect X: linux is there

2025-08-12T09:56:36Z

linux is there

← Older revision		Revision as of 09:56, 12 August 2025
Line 1:		Line 1:
	{{Page WIP\|notes=		{{Page WIP\|notes=
	* Needs instructions for macOS ~~and Linux~~ users		* Needs instructions for macOS users
	** Note that since the makebax <code>release.zip</code> only provides Windows binaries, these OSes will likely need some form of Wine in their instructions.		** Note that since the makebax <code>release.zip</code> only provides Windows binaries, these OSes will likely need some form of Wine in their instructions.
	* Might need troubleshooting info		* Might need troubleshooting info

Ajl721: Added Linux instructions

2025-07-09T23:38:34Z

Added Linux instructions

← Older revision		Revision as of 23:38, 9 July 2025
Line 51:		Line 51:
	WIP		WIP
	\|-\|Linux=		\|-\|Linux=
			# Download <code>release.zip</code> from the makebax releases page.
	~~WIP~~		# Extract the <code>release.zip</code> to a folder (if not done automatically) and move it to any location of your choice, then <code>cd</code> to that location.
			# In a terminal window, use your system's package manager (such as <code>apt</code>, <code>dnf</code> or <code>pacman</code>) while sudo or root to install Wine.
	</tabber>		</tabber>

	====Section II - Converting the video====		====Section II - Converting the video====
	# Copy the video you wish to convert into the makebax folder		# Copy the video you wish to convert into the makebax release folder
	# Inside that folder, hold SHIFT and right-click anywhere in the empty space - in the resulting menu, click the option that opens a terminal, Command Prompt, or PowerShell window		# Inside that folder, hold SHIFT and right-click anywhere in the empty space - in the resulting menu, click the option that opens a terminal, Command Prompt, or PowerShell window
	# Use ffmpeg to transcode your desired video into IVF format		# Use ffmpeg to transcode your desired video into IVF format
Line 63:		Line 64:
	# Use makebax to convert your <code>.IVF</code> file to a <code>.BAX</code> file		# Use makebax to convert your <code>.IVF</code> file to a <code>.BAX</code> file
	#* When running the command, put the full filename of one of the makebax <code>.EXE</code>s (e.g. <code>makebax-win64.exe</code>) before the command.		#* When running the command, put the full filename of one of the makebax <code>.EXE</code>s (e.g. <code>makebax-win64.exe</code>) before the command.
	#* If you named your converted video <code>converted.ivf</code>, the command would be <code><makebax EXE filename> "converted.ivf" "output.bax"</code>		#* If you named your converted video <code>converted.ivf</code>, the command would be <code><makebax EXE filename> "converted.ivf" "output.bax"</code> (Linux users need to prefix with <code>wine</code>)
	# Copy <code>output.bax</code> to <code>sdmc:/bax/</code> on your console's SD card		# Copy <code>output.bax</code> to <code>sdmc:/bax/</code> on your console's SD card
	{{success\|You have created a usable .BAX file. It will be played (chosen at random, if you already had a .BAX file before this) when your 3DS next boots.}}		{{success\|You have created a usable .BAX file. It will be played (chosen at random, if you already had a .BAX file before this) when your 3DS next boots.}}

ItsCrocoSwine: add category Category:Nintendo 3DS guides

2024-09-06T18:41:55Z

add category Category:Nintendo 3DS guides

← Older revision		Revision as of 18:41, 6 September 2024
Line 86:		Line 86:
	* For best performance, the block size should be an integer multiple of the number of available hardware threads (logical processors). This is why the default block size is 48: it's a multiple of the most common PO2 and MO6 multithread setups.		* For best performance, the block size should be an integer multiple of the number of available hardware threads (logical processors). This is why the default block size is 48: it's a multiple of the most common PO2 and MO6 multithread setups.
	* BAX files should not surpass the 32MiB mark. makebax doesn't enforce this limit, but BAX does.		* BAX files should not surpass the 32MiB mark. makebax doesn't enforce this limit, but BAX does.
			[[Category:Nintendo 3DS guides]]

Ihaveahax: /* Section I - Installing ffmpeg and makebax */ wrap tabber lists in to fix rendering

2023-08-26T09:49:50Z

Section I - Installing ffmpeg and makebax: wrap tabber lists in <span> to fix rendering

← Older revision		Revision as of 09:49, 26 August 2023
Line 18:		Line 18:
	\|-\|Windows=		\|-\|Windows=

			<span>
	# On the ffmpeg website, click on the Windows icon and then the <code>Windows builds by BtbN</code> option		# On the ffmpeg website, click on the Windows icon and then the <code>Windows builds by BtbN</code> option
	# On that page, download the file whose name ends with <code>win64-gpl.zip</code>		# On that page, download the file whose name ends with <code>win64-gpl.zip</code>
Line 28:		Line 29:
	# In the window that opens, find the option named <code>Path</code>, click on it, and click '''Edit...'''		# In the window that opens, find the option named <code>Path</code>, click on it, and click '''Edit...'''
	# In the window that opens, click '''New''', paste the file path you copied earlier, then press Enter and click '''OK'''		# In the window that opens, click '''New''', paste the file path you copied earlier, then press Enter and click '''OK'''

			</span>
	\|-\|macOS=		\|-\|macOS=

Line 40:		Line 43:
	\|-\|Windows=		\|-\|Windows=

			<span>
	# Download <code>release.zip</code> from the makebax releases page.		# Download <code>release.zip</code> from the makebax releases page.
	# Extract the <code>release.zip</code> to a folder and move it to any location of your choice		# Extract the <code>release.zip</code> to a folder and move it to any location of your choice
			</span>
	\|-\|macOS=		\|-\|macOS=

Line 49:		Line 54:
	WIP		WIP
	</tabber>		</tabber>

	====Section II - Converting the video====		====Section II - Converting the video====
	# Copy the video you wish to convert into the makebax folder		# Copy the video you wish to convert into the makebax folder

Zbelios: fixed info template under section "command line usage"

2023-08-24T21:49:09Z

fixed info template under section "command line usage"

← Older revision		Revision as of 21:49, 24 August 2023
Line 61:		Line 61:
	{{success\|You have created a usable .BAX file. It will be played (chosen at random, if you already had a .BAX file before this) when your 3DS next boots.}}		{{success\|You have created a usable .BAX file. It will be played (chosen at random, if you already had a .BAX file before this) when your 3DS next boots.}}
	== Command Line Usage ==		== Command Line Usage ==
	{{info\|Put the filename of either makebax <code>.exe</code> before the command, and make sure you're running this from inside the makebax release folder.		{{info\|Put the filename of either makebax <code>.exe</code> before the command, and make sure you're running this from inside the makebax release folder.}}
	<code><makebax EXE filename> "/path/to/input.ivf" "/path/to/output.bax" [-s n] [-c l] [-b back_color] [-a "Author"] [-i "Info"]</code>		<code><makebax EXE filename> "/path/to/input.ivf" "/path/to/output.bax" [-s n] [-c l] [-b back_color] [-a "Author"] [-i "Info"]</code>

StarlitSkies: layout overhaul to make adding macOS/Linux instructions easier, added ffmpeg install instructions for Windows & Linux, various minor fixes

2022-11-28T04:32:44Z

layout overhaul to make adding macOS/Linux instructions easier, added ffmpeg install instructions for Windows & Linux, various minor fixes

← Older revision		Revision as of 04:32, 28 November 2022
Line 9:		Line 9:

	=== What You Need ===		=== What You Need ===
	* The latest release of {{GitLab\|Wolfvak/BAX/-/releases\|makebax}} (~~the <code>release.zip</code> file, noted by having a paperclip to its left~~)		* The latest release of {{GitLab\|Wolfvak/BAX/-/releases\|makebax}} (files vary depending on your OS)
	* The latest release of [https://ffmpeg.org/download.html ffmpeg] installed on your computer		* The latest release of [https://ffmpeg.org/download.html ffmpeg] installed on your computer

	=== Instructions ===		=== Instructions ===
	# Extract the <code>release.zip</code> to a folder and ~~open~~ it		====Section I - Installing ffmpeg and makebax====
	# Copy the video you wish to convert into ~~this~~ folder		For FFmpeg:
	~~#*The video must be a resolution of 400x240, 320x240, or 720x240. Other resolutions will fail to convert.~~		<tabber>
	# Inside ~~the~~ folder, hold SHIFT and right-click anywhere in ~~its~~ empty space - in the resulting menu, click the option that opens a terminal, Command Prompt, or PowerShell window		\|-\|Windows=

			# On the ffmpeg website, click on the Windows icon and then the <code>Windows builds by BtbN</code> option
			# On that page, download the file whose name ends with <code>win64-gpl.zip</code>
			# Once it's downloaded, extract the file to a folder
			# Move the folder to any place of your choosing, but make sure to choose a place where you won't move it again
			#*Once you have the folder in the correct place, enter the <code>bin</code> folder inside it. Then, click on the address bar and copy the file path that appears in its place
			# Open the Windows search bar and find the Control Panel
			# In the Control Panel, click on the search bar and type <code>environment</code>
			# Choose the option that says "Edit environment variables for your account"
			# In the window that opens, find the option named <code>Path</code>, click on it, and click '''Edit...'''
			# In the window that opens, click '''New''', paste the file path you copied earlier, then press Enter and click '''OK'''
			\|-\|macOS=

			WIP
			\|-\|Linux=

			In a terminal window, use your system's package manager (such as <code>apt</code>, <code>dnf</code> or <code>pacman</code>) while sudo or root to install ffmpeg.
			</tabber>
			----
			For makebax:
			<tabber>
			\|-\|Windows=

			# Download <code>release.zip</code> from the makebax releases page.
			# Extract the <code>release.zip</code> to a folder and move it to any location of your choice
			\|-\|macOS=

			WIP
			\|-\|Linux=

			WIP
			</tabber>
			====Section II - Converting the video====
			# Copy the video you wish to convert into the makebax folder
			# Inside that folder, hold SHIFT and right-click anywhere in the empty space - in the resulting menu, click the option that opens a terminal, Command Prompt, or PowerShell window
	# Use ffmpeg to transcode your desired video into IVF format		# Use ffmpeg to transcode your desired video into IVF format
	#* For example, if your video is a file named <code>input.mp4</code>, the command would be ~~something like~~ <code>ffmpeg -i "input.mp4" -f ivf "converted.ivf"</code>		#* For example, if your video is a file named <code>input.mp4</code>, the command would be <code>ffmpeg -i "input.mp4" -f ivf "converted.ivf"</code>
	#* ~~If your source~~ video resolution ~~isn~~'t the ~~required you can also~~ do <code>ffmpeg -i "input.mp4" -f ivf -vf scale=<WIDTH>:240,fps=<FRAMERATE> "converted.ivf"</code>~~, with "~~WIDTH~~" being either~~ 400, 320 or 720 and "FRAMERATE~~" being~~ between 1 and 60.		#* The video must have a resolution of 400x240, 320x240, or 720x240. If it doesn't meet the requirements, instead do <code>ffmpeg -i "input.mp4" -f ivf -vf scale=<WIDTH>:240,fps=<FRAMERATE> "converted.ivf"</code> - <code><WIDTH></code> must be 400, 320 or 720 and <code><FRAMERATE></code> must be a number between 1 and 60.
	# Use makebax to convert your <code>.IVF</code> file to a <code>.BAX</code> file		# Use makebax to convert your <code>.IVF</code> file to a <code>.BAX</code> file
	#* When running the command, put the full filename of one of the makebax <code>.EXE</code>s (e.g. <code>makebax-win64.exe</code>) before the command.		#* When running the command, put the full filename of one of the makebax <code>.EXE</code>s (e.g. <code>makebax-win64.exe</code>) before the command.
	#* If you named your converted video <code>converted.ivf</code>, the command would be <code><makebax EXE filename> ~~makebax~~ "converted.ivf" "output.bax"</code>		#* If you named your converted video <code>converted.ivf</code>, the command would be <code><makebax EXE filename> "converted.ivf" "output.bax"</code>
	# Copy <code>output.bax</code> to <code>SD:/bax/</code> on your console's SD card		# Copy <code>output.bax</code> to <code>sdmc:/bax/</code> on your console's SD card
			{{success\|You have created a usable .BAX file. It will be played (chosen at random, if you already had a .BAX file before this) when your 3DS next boots.}}
	== Command Line Usage ==		== Command Line Usage ==
	{{info\|Put the filename of either makebax <code>.exe</code> before the command, and make sure you're running this from inside the makebax release folder.		{{info\|Put the filename of either makebax <code>.exe</code> before the command, and make sure you're running this from inside the makebax release folder.
	<code><makebax EXE filename> ~~makebax~~ "/path/to/input.ivf" "/path/to/output.bax" [-s n] [-c l] [-b back_color] [-a "Author"] [-i "Info"]</code>		<code><makebax EXE filename> "/path/to/input.ivf" "/path/to/output.bax" [-s n] [-c l] [-b back_color] [-a "Author"] [-i "Info"]</code>

	Parameters enclosed in <code>[ ]</code> are optional.		Parameters enclosed in <code>[ ]</code> are optional.

StarlitSkies: finished the Windows instructions and added an advisory for what Linux and macOS instructions will need.

2022-11-28T02:53:26Z

finished the Windows instructions and added an advisory for what Linux and macOS instructions will need.

← Older revision		Revision as of 02:53, 28 November 2022
Line 1:		Line 1:
	{{Page WIP\|notes=		{{Page WIP\|notes=
	* Needs ~~note about what Mac/~~Linux users ~~should do~~		* Needs instructions for macOS and Linux users
			** Note that since the makebax <code>release.zip</code> only provides Windows binaries, these OSes will likely need some form of Wine in their instructions.
	* Might need troubleshooting info		* Might need troubleshooting info
	* This page might make more sense as 3DS:BAX/makebax since it will only be about that
	* Instructions on creating animations need to be finished
	}}		}}
	'''makebax''' is a command-line utility for converting <code>.IVF</code> video files into <code>.BAX</code> animations to be used with [[3DS:BAX\|BAX]] and played on a Nintendo 3DS.		'''makebax''' is a command-line utility for converting <code>.IVF</code> video files into <code>.BAX</code> animations to be used with [[3DS:BAX\|BAX]] and played on a Nintendo 3DS.
Line 10:		Line 9:

	=== What You Need ===		=== What You Need ===
	* The latest release of {{GitLab\|Wolfvak/BAX/-/releases\|makebax}} (~~It's in~~ the <code>release.zip</code> file)		* The latest release of {{GitLab\|Wolfvak/BAX/-/releases\|makebax}} (the <code>release.zip</code> file, noted by having a paperclip to its left)
	* The latest release of [https://ffmpeg.org/download.html ffmpeg] installed on your computer		* The latest release of [https://ffmpeg.org/download.html ffmpeg] installed on your computer

	=== Instructions ===		=== Instructions ===
	# ~~Open~~ a terminal ~~on your computer~~		# Extract the <code>release.zip</code> to a folder and open it
			# Copy the video you wish to convert into this folder
			#*The video must be a resolution of 400x240, 320x240, or 720x240. Other resolutions will fail to convert.
			# Inside the folder, hold SHIFT and right-click anywhere in its empty space - in the resulting menu, click the option that opens a terminal, Command Prompt, or PowerShell window
	# Use ffmpeg to transcode your desired video into IVF format		# Use ffmpeg to transcode your desired video into IVF format
	#* For example, if your video is a file named <code>input.mp4</code>, the command would be something like <code>ffmpeg -i "~~/path/to/~~input.mp4" -f ivf "~~/path/to/~~converted.ivf"</code>		#* For example, if your video is a file named <code>input.mp4</code>, the command would be something like <code>ffmpeg -i "input.mp4" -f ivf "converted.ivf"</code>
	#* If your source video resolution isn't the required you can also do <code>ffmpeg -i "~~/path/to/~~input.mp4" -f ivf -vf scale=<WIDTH>:240,fps=<FRAMERATE> "~~/path/to/~~converted.ivf"</code>, with "WIDTH" being either 400, 320 or 720 and "FRAMERATE" being between 1 and 60.		#* If your source video resolution isn't the required you can also do <code>ffmpeg -i "input.mp4" -f ivf -vf scale=<WIDTH>:240,fps=<FRAMERATE> "converted.ivf"</code>, with "WIDTH" being either 400, 320 or 720 and "FRAMERATE" being between 1 and 60.
	# Use makebax to convert your <code>.IVF</code> file to a <code>.BAX</code> file		# Use makebax to convert your <code>.IVF</code> file to a <code>.BAX</code> file
	#* ~~Assuming~~ you named your converted video <code>converted.ivf</code>, the command would be <code>makebax "~~/path/to/~~converted.ivf" "~~/path/to/~~output.bax"</code>		#* When running the command, put the full filename of one of the makebax <code>.EXE</code>s (e.g. <code>makebax-win64.exe</code>) before the command.
			#* If you named your converted video <code>converted.ivf</code>, the command would be <code><makebax EXE filename> makebax "converted.ivf" "output.bax"</code>
	# Copy <code>output.bax</code> to <code>SD:/bax/</code> on your console's SD card		# Copy <code>output.bax</code> to <code>SD:/bax/</code> on your console's SD card

	== Command Line Usage ==		== Command Line Usage ==
	<code>makebax "input.ivf" "output.bax" [-s n] [-c l] [-b back_color] [-a "Author"] [-i "Info"]</code>		{{info\|Put the filename of either makebax <code>.exe</code> before the command, and make sure you're running this from inside the makebax release folder.
			<code><makebax EXE filename> makebax "/path/to/input.ivf" "/path/to/output.bax" [-s n] [-c l] [-b back_color] [-a "Author"] [-i "Info"]</code>

	Parameters enclosed in <code>[ ]</code> are optional.		Parameters enclosed in <code>[ ]</code> are optional.

CM360: Finish instructions on creating .BAX animations

2022-09-28T21:55:38Z

Finish instructions on creating .BAX animations

← Older revision		Revision as of 21:55, 28 September 2022
Line 10:		Line 10:

	=== What You Need ===		=== What You Need ===
	* The latest release of ~~BAX from its~~ {{GitLab\|Wolfvak/BAX/-/releases\|~~GitLab page~~}} (~~The~~ <code>release.zip</code> file)		* The latest release of {{GitLab\|Wolfvak/BAX/-/releases\|makebax}} (It's in the <code>release.zip</code> file)
	* The latest release of [https://ffmpeg.org/download.html ffmpeg] installed on your computer		* The latest release of [https://ffmpeg.org/download.html ffmpeg] installed on your computer

Line 16:		Line 16:
	# Open a terminal on your computer		# Open a terminal on your computer
	# Use ffmpeg to transcode your desired video into IVF format		# Use ffmpeg to transcode your desired video into IVF format
	#* For example, if your video is a file named <code>input.mp4</code>, the command would be something like <code>ffmpeg -i "/path/to/input.mp4" -f ivf "/path/to/output.~~ivf~~"</code>		#* For example, if your video is a file named <code>input.mp4</code>, the command would be something like <code>ffmpeg -i "/path/to/input.mp4" -f ivf "/path/to/converted.ivf"</code>
	~~WIP~~		#* If your source video resolution isn't the required you can also do <code>ffmpeg -i "/path/to/input.mp4" -f ivf -vf scale=<WIDTH>:240,fps=<FRAMERATE> "/path/to/converted.ivf"</code>, with "WIDTH" being either 400, 320 or 720 and "FRAMERATE" being between 1 and 60.
			# Use makebax to convert your <code>.IVF</code> file to a <code>.BAX</code> file
			#* Assuming you named your converted video <code>converted.ivf</code>, the command would be <code>makebax "/path/to/converted.ivf" "/path/to/output.bax"</code>
			# Copy <code>output.bax</code> to <code>SD:/bax/</code> on your console's SD card

	== Command Line Usage ==		== Command Line Usage ==

CM360: CM360 moved page 3DS:BAX/Usage to 3DS:BAX/makebax: This page was mostly about makebax anyways so it didn't make much sense as "usage"

2022-09-28T21:37:21Z

CM360 moved page 3DS:BAX/Usage to 3DS:BAX/makebax: This page was mostly about makebax anyways so it didn't make much sense as "usage"

← Older revision		Revision as of 21:37, 28 September 2022
(No difference)

CM360: Create page explaining how to create .BAX animations using makebax

2022-09-28T21:36:29Z

Create page explaining how to create .BAX animations using makebax

New page

{{Page WIP|notes=
* Needs note about what Mac/Linux users should do
* Might need troubleshooting info
* This page might make more sense as 3DS:BAX/makebax since it will only be about that
* Instructions on creating animations need to be finished
}}
'''makebax''' is a command-line utility for converting <code>.IVF</code> video files into <code>.BAX</code> animations to be used with [[3DS:BAX|BAX]] and played on a Nintendo 3DS.

== Creating .BAX Animations ==

=== What You Need ===
* The latest release of BAX from its {{GitLab|Wolfvak/BAX/-/releases|GitLab page}} (The <code>release.zip</code> file)
* The latest release of [https://ffmpeg.org/download.html ffmpeg] installed on your computer

=== Instructions ===
# Open a terminal on your computer
# Use ffmpeg to transcode your desired video into IVF format
#* For example, if your video is a file named <code>input.mp4</code>, the command would be something like <code>ffmpeg -i "/path/to/input.mp4" -f ivf "/path/to/output.ivf"</code>
WIP

== Command Line Usage ==
<code>makebax "input.ivf" "output.bax" [-s n] [-c l] [-b back_color] [-a "Author"] [-i "Info"]</code>

Parameters enclosed in <code>[ ]</code> are optional.

* <code>input.ivf</code> is the input IVF file path, the size must have a resolution of either 400x240 (top screen only), 320x240 (bottom screen only) or 720x240 (both screens side-by-side). Input must be an IVF container with a VP8/VP9 stream.
* <code>output.bax</code> is the path to the BAX file that will be created.
* <code>s</code> sets the block size. n is the number of frames that are processed per iteration. The higher the number, the more memory is used on runtime (and the less often disk accesses are required). Defaults to 48.
* <code>c</code> sets the compression level. Should be between 1 (lowest) and 16 (highest). Defaults to 6.
* <code>b</code> sets the background color. <code>bg_color</code> should be the 16-bit integer representation of an RGB565 color. Defaults to zero (black). Refer to [http://www.barth-dev.de/online/rgb565-color-picker/ this site] for more information.
* <code>a</code> sets the Author string. It doesn't affect the player at all, but it's nice to include some metadata. Maximum length is 32 ASCII characters (or as much UTF-8 fits in there).
* <code>i</code> is the same as above but for Information. Maximum length is 192 ASCII characters.

== Notes ==
* [https://wiki.multimedia.cx/index.php/IVF IVF] is a simple container for VP8/VP9 streams, unable to contain more than one stream. It was chosen as the input format due to it being both simple and straightforward to work with.
* Although it should be compatible with big endian platforms (PowerPC, Microblaze, etc) this has not been properly tested yet. Please report any issues regarding compilation/usage on big endian platforms.
* While having libav* support would be ideal, it's less than fit due to it's programming complexity (easy to make mistakes with) and labyrinth of dependencies (requires X11 libs, so it's unusable from servers, f.e.).
* For best performance, the block size should be an integer multiple of the number of available hardware threads (logical processors). This is why the default block size is 48: it's a multiple of the most common PO2 and MO6 multithread setups.
* BAX files should not surpass the 32MiB mark. makebax doesn't enforce this limit, but BAX does.