Skip to content

Commit 1b868fd

Browse files
committed
True v1.1 release
*Moved images around for easier reading. *Fixed another newline prob *Fixed a grammatical typo ("An very important" )
1 parent 2cfbf03 commit 1b868fd

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ It was created in order to help MKWii modders to create high-quality, original T
7575
- Position of white rectangle determines which row (which track) is highlighted in the menus when a cup is selected
7676

7777
![cup_select.thp](https://raw.githubusercontent.com/Tamk1s/Thwimp/master/readme/cup_select.png)
78+
7879
After doing what this program does for my projects (manually and painfully via batch files), I created Thwimp in order to automate the THP creation process for complex videos like the ones above. The application was used to create the custom THPs in my [Hover Pack project](http://wiki.tockdom.com/wiki/Hover_Pack)
7980

8081

@@ -95,6 +96,8 @@ As mentioned earlier, Thwimp uses some FOSS and other Command Line tools for pro
9596

9697
Before doing **anything** in the utility, goto the "Options" tab of the application and set your paths. Do this by clicking the "Browse" buttons beside each item and navigating to the appropriate places with the file dialog boxes that appear.
9798

99+
![Options](https://raw.githubusercontent.com/Tamk1s/Thwimp/master/readme/Options.png)
100+
98101
**Paths to set:**
99102
1. THP Root
100103
- Path containing the original Nintendo THP video files for viewing/ripping
@@ -113,8 +116,6 @@ Before doing **anything** in the utility, goto the "Options" tab of the applicat
113116
- A command line tool used to encode jpg frames and a wav file into a Nintendo THP video.
114117
- **Do not ask me where to obtain this!**
115118

116-
![Options](https://raw.githubusercontent.com/Tamk1s/Thwimp/master/readme/Options.png)
117-
118119
The "About" button displays information about the current build of this application. After setting all of your paths, the elements in the "THP" tab will be available!
119120

120121
![About](https://raw.githubusercontent.com/Tamk1s/Thwimp/master/readme/About.png)
@@ -127,6 +128,8 @@ At the top of the THP tab will be a dropdown box. Use this to select which THP f
127128

128129
The "THP Info" group box gives statistical information about each original, Nintendo THP video in Mario Kart Wii. You will need this information in order to create appropriately formatted input files for THP encoding!
129130

131+
![THP Info](https://raw.githubusercontent.com/Tamk1s/Thwimp/master/readme/THP.png)
132+
130133
**Video:**
131134
- Total dims
132135
- Width
@@ -197,12 +200,12 @@ The "THP Info" group box gives statistical information about each original, Nint
197200
- How the THP video is formatted
198201
- THP file's usage/purpose in-game
199202

200-
![THP Info](https://raw.githubusercontent.com/Tamk1s/Thwimp/master/readme/THP.png)
201-
202203
#### THP Viewer/Ripper
203204

204205
The "THP Viewer/Ripper" group box allows one to view/convert the THP to audio/video files. This group box has the following settings/form elements:
205206

207+
![THP Viewer/Ripper](https://raw.githubusercontent.com/Tamk1s/Thwimp/master/readme/THP.png)
208+
206209
- "DirectSound?" checkbox
207210
- Use DirectSound as the SDL_SOUNDDRIVER value for audio playback?
208211
- Fixes [audio playback bug](https://forum.videohelp.com/threads/388189-ffplay-WASAPI-can-t-initialize-audio-client-error) in current version of FFMPEG for Windows
@@ -256,8 +259,6 @@ The "THP Viewer/Ripper" group box allows one to view/convert the THP to audio/vi
256259
- Indicates if unique dummy frames will be ripped as BMP files
257260
- Only enabled when the "Dum" radio button is selected
258261

259-
![THP Viewer/Ripper](https://raw.githubusercontent.com/Tamk1s/Thwimp/master/readme/THP.png)
260-
261262
Tweak the settings as appropriately and use the "View" or "Rip" buttons to play a THP or convert it, respectively. Pressing the "rip" button will ask the user to select an output directory and base filename for the converted files; by default, the path is at the location of the original THP, and the filename is "[thp_filename]_suffix", where suffix is the appropriate one based on the A1N naming notation for the input files used for encoding (see "THP Encoder section"). If the original THP video has an audio stream, it will automatically be ripped with an crop setting option and named appropriately. Dummy/control frames will be ripped automatically and named appropriately if the THP video has padding/control frames, if the "Dum" radio button is selected, if the multiplicity is set to 0, and if the start/end frame values are set to the original video's min/max values.
262263

263264
**Files are ripped from THP video files in the following formats:**
@@ -283,6 +284,8 @@ The input files have a base filename of [thp_filename].ext . Videos should have
283284
Consider if we have a THP video file (named "test.thp") that is a 2x2 array of subvideos with 3 multiplicities, padding, and audio. For the 1st multiplicity, the top left subvideo will be named "test_A1_1.mp4", the top right "test_B1_1.mp4", the bottom left "test_A2_1.mp4", and the bottom right "test_B2_1.mp4" . For the 2nd multiplicity, these same subvideos would be named "test_A1_2.mp4", "test_B1_2.mp4", and so on. The audio file is applied to the entire THP video, and would be named "test.wav" . The padding frames are named slightly different. The frame for the 1st multiplicity would be "dummy_1.bmp", the 2nd "dummy_2.bmp", and so on. The subvideos for each multiplicity should have the same dimensions as shown in the "subvid dims" fields and have the same, appropriate amount of frames. The padding should have the same dimensions as shown in the "Subvid dims" group box, and be formatted as described in the "Ctrl desc" field.
284285

285286
![Naming Convention scheme](https://raw.githubusercontent.com/Tamk1s/Thwimp/master/readme/naming_test_thp.png)
287+
288+
![THP Encoder](https://raw.githubusercontent.com/Tamk1s/Thwimp/master/readme/THP.png)
286289

287290
- **THP Encoder settings:**
288291
- Trunc Frame
@@ -310,13 +313,11 @@ Consider if we have a THP video file (named "test.thp") that is a 2x2 array of s
310313
- High visual quality
311314
- Low streaming bandwidth quality
312315
- (Large THP filesize, less artifacts)
313-
314-
![THP Encoder](https://raw.githubusercontent.com/Tamk1s/Thwimp/master/readme/THP.png)
315316

316317
After setting your encoding settings, and clicking the "Encode" button, you will need to select the folder containing your appropriately named input files. The encoder will then begin processing your files; this will take some time. Make sure to have **significant amount free disk space** (a few GBs should be safe); some of the operations may produce a **large** amount of temporary files! After conversion, you will have a thp file in the input folder (named [thp_filename].thp), and all temporary files will be cleaned up!
317318

318319
##### **Streaming bandwidth notes:**
319-
An **very** important note about the JPG quality, final THP filesize, and video streaming. Odds are the THPs you will be creating will be used for either a [Riivolution](http://wiki.tockdom.com/wiki/Riivolution) filepatch or a [MKWiiki "My Stuff" mod](http://wiki.tockdom.com/wiki/My_Stuff) from the SD Card. Experimentation has shown that streaming THP videos from SD Card has a much smaller bandwidth than when streaming from DVD. You may notice when playing a THP video from SD Card that the video will stutter (both audibly and visually) when there is too much action during certain frames of video playback. (To test this fact out yourself, copy MKWii's original title.thp file into your "My Stuff" folder, in order to patch the DVD game to read that file from SD Card instead. You will notice video playback for the title video will stutter and lag when too much action occurs , due to lower data bandwidth on the SD Card. This experiment was tested with a [4GB Lexar SDHC Card](https://www.digitalcamerawarehouse.com.au/lexar-sdhc-card-4gb-class-4), the type that come with Original Nintendo 3DS XLs).
320+
A **very** important note about the JPG quality, final THP filesize, and video streaming. Odds are the THPs you will be creating will be used for either a [Riivolution](http://wiki.tockdom.com/wiki/Riivolution) filepatch or a [MKWiiki "My Stuff" mod](http://wiki.tockdom.com/wiki/My_Stuff) from the SD Card. Experimentation has shown that streaming THP videos from SD Card has a much smaller bandwidth than when streaming from DVD. You may notice when playing a THP video from SD Card that the video will stutter (both audibly and visually) when there is too much action during certain frames of video playback. (To test this fact out yourself, copy MKWii's original title.thp file into your "My Stuff" folder, in order to patch the DVD game to read that file from SD Card instead. You will notice video playback for the title video will stutter and lag when too much action occurs , due to lower data bandwidth on the SD Card. This experiment was tested with a [4GB Lexar SDHC Card](https://www.digitalcamerawarehouse.com.au/lexar-sdhc-card-4gb-class-4), the type that come with Original Nintendo 3DS XLs).
320321

321322
In order to reduce lagging from too much bandwidth, use the JPG Quality field to generate JPG video frames with a good balance between visual quality and compression. Higher compression will lead to smaller overall THP video sizes, and to less data bandwidth being used to stream the video file (and thus smoother playback). You may also be able to get better playback quality with higher performance SD cards that are compatible with the Wii; however, do try to create THP files that would play well on lower performance SD cards, in order to cover high-quality playback for the least common denominator. For better performance, you can try burning your mod files and THPs to a DVD (via an [ISO Patcher](http://wiki.tockdom.com/wiki/ISO_Patcher)). Also of importance is keeping the THP filesize down. Some THP files from the original game will only accept replacement files so large (for example, during the creation of my Hover Pack, battle_retro.thp crashed in-game when it was ~300MB large). Most replacement THP files should work with a total frame size > than the original to an extent. Some with a total frame length < than the original may need padded or looped to the original frame count. (Example, title.thp must be the same frame count; using a shorter video than the original will loop, and a longer one will cut out prematurely.)
322323

0 commit comments

Comments
 (0)