3DS:BAX/makebax

makebax is a command-line utility for converting  video files into   animations to be used with BAX and played on a Nintendo 3DS.

What You Need

 * The latest release of (files vary depending on your OS)
 * The latest release of ffmpeg installed on your computer

Section I - Installing ffmpeg and makebax
For FFmpeg:
 * -|Windows=


 * 1) On the ffmpeg website, click on the Windows icon and then the   option
 * 2) On that page, download the file whose name ends with
 * 3) Once it's downloaded, extract the file to a folder
 * 4) Move the folder to any place of your choosing, but make sure to choose a place where you won't move it again
 * 5) *Once you have the folder in the correct place, enter the  folder inside it. Then, click on the address bar and copy the file path that appears in its place
 * 6) Open the Windows search bar and find the Control Panel
 * 7) In the Control Panel, click on the search bar and type
 * 8) Choose the option that says "Edit environment variables for your account"
 * 9) In the window that opens, find the option named , click on it, and click Edit...
 * 10) 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,   or  ) while sudo or root to install ffmpeg.

For makebax:
 * -|Windows=


 * 1) Download   from the makebax releases page.
 * 2) Extract the   to a folder and move it to any location of your choice
 * -|macOS=

WIP
 * -|Linux=

WIP

Section II - Converting the video
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.
 * 1) Copy the video you wish to convert into the makebax folder
 * 2) 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
 * 3) Use ffmpeg to transcode your desired video into IVF format
 * 4) * For example, if your video is a file named, the command would be
 * 5) * The video must have a resolution of 400x240, 320x240, or 720x240. If it doesn't meet the requirements, instead do  -   must be 400, 320 or 720 and   must be a number between 1 and 60.
 * 6) Use makebax to convert your   file to a   file
 * 7) * When running the command, put the full filename of one of the makebax s (e.g.  ) before the command.
 * 8) * If you named your converted video, the command would be
 * 9) Copy   to   on your console's SD card

Command Line Usage
Parameters enclosed in  are optional.


 * 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.
 * is the path to the BAX file that will be created.
 * 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.
 * sets the compression level. Should be between 1 (lowest) and 16 (highest). Defaults to 6.
 * sets the background color.  should be the 16-bit integer representation of an RGB565 color. Defaults to zero (black). Refer to this site for more information.
 * 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).
 * is the same as above but for Information. Maximum length is 192 ASCII characters.