3DS:BAX/makebax: Difference between revisions

(7 intermediate revisions by 6 users not shown)

Line 1:

{{Page WIP|notes=

* Needs ~~note about what Mac~~/~~Linux users should do~~

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

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

Line 10:

Line 9:

=== 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}} (files vary depending on your OS)

* The latest release of [https://ffmpeg.org/download.html ffmpeg] installed on your computer

=== Instructions ===

# ~~Open~~ a ~~terminal on your computer~~

====Section I - Installing ffmpeg and makebax====

# ~~Use ffmpeg~~ to ~~transcode~~ your ~~desired video into IVF format~~

For FFmpeg:

#* ~~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>

|-|Windows=

<span>

# 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'''

</span>

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

|-|Windows=

<span>

# 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

</span>

|-|macOS=

WIP

|-|Linux=

# Download <code>release.zip</code> from the makebax releases page.

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

====Section II - Converting the video====

# 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

# 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 <code>ffmpeg -i "input.mp4" -f ivf "converted.ivf"</code>

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

#* 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> (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

{{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 ==

<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> "/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.

Line 38:

Line 87:

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

[[Category:Nintendo 3DS guides]]