3DS:BAX/makebax: Difference between revisions

Line 1:

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

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

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

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

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

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

@@ Line 1: / Line 1: @@
 {{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
-* 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 {{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
 === 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
-#* 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
-#* 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
 == 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.