Difference between revisions of "Pikmin 2 instructions"

From Pikmin Technical Knowledge Base
Jump to navigation Jump to search
(One intermediate revision by the same user not shown)
Line 1: Line 1:
Helpful instructions for editing and handling ''Pikmin 2'''s files. This guide assumes you have some basic knowledge on navigating folders, opening files, using the command line, etc.  
+
Helpful instructions for editing and handling ''Pikmin 2'''s files. This guide assumes you have some basic knowledge on navigating folders, opening files, using commands, etc.
 
See [[General instructions#Obtaining a game's files|obtaining a game's files]] if you are unsure on how to do so.
 
See [[General instructions#Obtaining a game's files|obtaining a game's files]] if you are unsure on how to do so.
  
Line 7: Line 7:
  
 
===Text files===
 
===Text files===
To read and edit a plain text file (<code>.txt</code>), you can use any text editor, like Notepad, although [https://notepad-plus-plus.org/download/ Notepad++] is highly recommended. If the type of file you're editing has any comment (text written in English or Japanese that comes after a #), then it's safe to say that any text that comes after a # will be ignored.
+
To read and edit a plain text file (<code>.txt</code>), you can use any text editor, like Notepad, although [https://notepad-plus-plus.org/download/ Notepad++] is highly recommended as it is far more advanced and will display the Japanese characters within vanilla files. The game treats a comment as anything in the same line taking place after a hashtag (#).
  
===SZS files===
+
An example from the entities subsection with caves:
SZS files (<code>.szs</code>) are a bit like zip files. If you want to read a SZS file's contents, you need to unpack it, and if you want to make changes to the contents, you need to repack it after you're done.
+
<pre>
 +
# TekiInfo
 +
{
 +
2 # num
 +
$Tadpole 23 # weight
 +
0 # type
 +
Sokkuri_bane 9 # weight
 +
1 # type
 +
}
 +
</pre>
 +
 
 +
This example will treat the following as comments (ignored and can say anything you want):
 +
* "TekiInfo"
 +
* "num"
 +
* "weight" (x2)
 +
* "type" (x2)
 +
 
 +
===ARC/SZS files===
 +
SZS files (.szs) and ARC files (.arc) are Nintendo's archive files (similar to that of a .zip or .rar). These cannot simply be opened using a program like WinRAR. Instead you must extract the contents using a tool such as [https://www.romhacking.net/utilities/1024/ Lunaboy's ArcExtract and ArcPack] for Windows, or [http://szs.wiimm.de/ Wiimms SZS Toolset] for macOS.
  
 
====Windows====
 
====Windows====
To unpack an SZS file on Windows, use [https://www.romhacking.net/utilities/1024/ Lunaboy's RARC Tools]. Unpacking is done through <code>ArcExtract.exe</code> by drag and dropping your szs file onto it. A folder containing the SZS files' contents will then be created in the directory that the SZS was in, and now you can modify it!
+
To extract the contents of an ARC or SZS file, simply drag-and-drop it on to the downloaded ArcExtract.exe file and the contents within that archive will be extracted in the same directory as the original ARC/SZS file.
 +
 
 +
To pack modified contents of an ARC or SZS file, make sure you have all the files that were extracted and place them into a new folder named after the original ARC/SZS file. If I wanted to repack enemyParms.szs then I would make a new folder called enemyParms and place all the contents within that folder. Now, drag-and-drop that folder on to the downloaded ArcPack.exe file and then a ARC file will be created named after the folder you dragged-and-dropped. If you modified an SZS file, in the case of Pikmin 2, you can just rename the extension from enemyParms.arc to enemyParms.szs where you will be prompted by Windows that you're changing the extension - just cick OK. If you don't see the ".arc" or ".szs", then follow [https://www.howtogeek.com/205086/beginner-how-to-make-windows-show-file-extensions/ this guide on showing file extensions].
  
To repack an SZS file, you will need to continue using Lunaboy's RARC Tools in addition to [https://egaddsworkshop.com/forums/showthread.php?tid=27 yaz0fast]. First, once you've modified the SZS' contents, drag the folder that <code>ArcExtract.exe</code> gave you onto <code>ArcPack.exe</code> and it will create an <code>.arc</code> file. Technically, you can rename the file extension to SZS right now and it will work, but following the next step instead will save space. Drag the newly created ARC file onto <code>yaz0fast.exe</code> and it will create an SZS file. Now rename it to the filename that the original SZS had (you need to do this if you chose to rename the file extension instead as well) and yous should be good to go!
+
====macOS====
 +
First, install Wiimms SZS Toolset using the instructions on the website. Unpacking and repacking is done through command lines. These tools can be used with Windows as well, but it is not practical.
  
====Mac====
+
To unpack a file, run the command line <code>wszst extract &lt;SZS file path&gt;</code>. This will create a folder with the same name as the SZS file - but ending in ".d". Inside this folder will be the contents of the SZS file, plus an additional data file, which is used by Wiimms SZS Toolset, so that it knows how to repack.
Unfortunately, Lunaboy's RARC Tools and yaz0fast cannot be used on Mac computers. Instead, you must use a different tool called [http://szs.wiimm.de/ Wiimms SZS Toolset]. First, install it using the instructions on the website. Unpacking and repacking is done through the command line. These tools can be used with Windows as well, but it is not practical. Under Windows, there are scripts you can create to make Wiimm's process of packing and repacking easier.
 
  
Anyway, the command to unpack a file is <code>wszst extract &lt;SZS file path&gt;</code>. This will create a folder with the same name as the SZS file, but ending in ".d". Inside this folder will be the contents of the SZS file, plus an additional data file, which is used by Wiimms SZS Toolset, so that it knows how to repack. To repack, use <code>wszst update &lt;SZS file path&gt;</code>.
+
To repack the file, use <code>wszst update &lt;SZS file path&gt;</code>.
  
=====Scripts=====
+
====Scripts====
If you for some reason want to use Wiimms SZS Toolset on Windows, you can create scripts to automatically unpack and repack a SZS file, so that you don't have to write commands all the time. Open a text editor, and type
+
If you use Wiimms SZS Toolset on Windows, you can create scripts to automatically unpack and repack a SZS file, so that you don't have to write commands all the time. Open a text editor, and type
 
<pre>wszst extract %1</pre>
 
<pre>wszst extract %1</pre>
 
Save it as <code>SZS extract.bat</code> on some folder you can remember. Create a new file with
 
Save it as <code>SZS extract.bat</code> on some folder you can remember. Create a new file with
Line 47: Line 67:
 
===BTI files===
 
===BTI files===
 
BTI files (<code>.bti</code>) are image files. You'll need [http://szs.wiimm.de/ Wiimms SZS Toolset] to view these. As with [[#SZS files|SZS files]], you convert a BTI to PNG with the command line, though you can make a script to skip the command line part. The command to convert a BTI file is <code>wimgt DECODE &lt;BTI file path&gt;</code>.  
 
BTI files (<code>.bti</code>) are image files. You'll need [http://szs.wiimm.de/ Wiimms SZS Toolset] to view these. As with [[#SZS files|SZS files]], you convert a BTI to PNG with the command line, though you can make a script to skip the command line part. The command to convert a BTI file is <code>wimgt DECODE &lt;BTI file path&gt;</code>.  
To save the converted PNG files back into a BTI format use the command <code>wimgt ENCODE <PNG file path></code>.
+
To save the converted PNG files back into a BTI format, use a program called [http://kuribo64.net/uploader/files.php?sortby=date&filename=png2bti.zip&user=&id=3 png2bti]. To use it, flip the image vertically and then drag it onto the exe. To note is that png2bti cannot compress larger images as well as Nintendo themeselves can, but you can get around this by making the modified texture half the size of the one it's replacing. This shouldn't be a problem with smaller textures such as 32x32 and below.
  
 
====Scripts====
 
====Scripts====

Revision as of 03:15, 2 March 2018

Helpful instructions for editing and handling Pikmin 2's files. This guide assumes you have some basic knowledge on navigating folders, opening files, using commands, etc. See obtaining a game's files if you are unsure on how to do so.

Editing

You can view and edit a lot of the game's files. You can read them without any worry, but if you want to change them and have those changes apply in-game, see saving changes in general instructions.

To do: Sound files.

Text files

To read and edit a plain text file (.txt), you can use any text editor, like Notepad, although Notepad++ is highly recommended as it is far more advanced and will display the Japanese characters within vanilla files. The game treats a comment as anything in the same line taking place after a hashtag (#).

An example from the entities subsection with caves:

# TekiInfo
{
	2 	# num
	$Tadpole 23 	# weight
	0 	# type
	Sokkuri_bane 9 	# weight
	1 	# type
}

This example will treat the following as comments (ignored and can say anything you want):

  • "TekiInfo"
  • "num"
  • "weight" (x2)
  • "type" (x2)

ARC/SZS files

SZS files (.szs) and ARC files (.arc) are Nintendo's archive files (similar to that of a .zip or .rar). These cannot simply be opened using a program like WinRAR. Instead you must extract the contents using a tool such as Lunaboy's ArcExtract and ArcPack for Windows, or Wiimms SZS Toolset for macOS.

Windows

To extract the contents of an ARC or SZS file, simply drag-and-drop it on to the downloaded ArcExtract.exe file and the contents within that archive will be extracted in the same directory as the original ARC/SZS file.

To pack modified contents of an ARC or SZS file, make sure you have all the files that were extracted and place them into a new folder named after the original ARC/SZS file. If I wanted to repack enemyParms.szs then I would make a new folder called enemyParms and place all the contents within that folder. Now, drag-and-drop that folder on to the downloaded ArcPack.exe file and then a ARC file will be created named after the folder you dragged-and-dropped. If you modified an SZS file, in the case of Pikmin 2, you can just rename the extension from enemyParms.arc to enemyParms.szs where you will be prompted by Windows that you're changing the extension - just cick OK. If you don't see the ".arc" or ".szs", then follow this guide on showing file extensions.

macOS

First, install Wiimms SZS Toolset using the instructions on the website. Unpacking and repacking is done through command lines. These tools can be used with Windows as well, but it is not practical.

To unpack a file, run the command line wszst extract <SZS file path>. This will create a folder with the same name as the SZS file - but ending in ".d". Inside this folder will be the contents of the SZS file, plus an additional data file, which is used by Wiimms SZS Toolset, so that it knows how to repack.

To repack the file, use wszst update <SZS file path>.

Scripts

If you use Wiimms SZS Toolset on Windows, you can create scripts to automatically unpack and repack a SZS file, so that you don't have to write commands all the time. Open a text editor, and type

wszst extract %1

Save it as SZS extract.bat on some folder you can remember. Create a new file with

wszst update %1

And save it as SZS update.bat.

After this, you can simply grab the SZS file you want and drag it onto the BAT file you need.

BMD files

BMD files (.bmd) are 3D model files. If you simply want to view them, you can do so with BMDView2. Editing them is a different matter.

If you want to make your own BMD, you will need three things: a) 3ds Max 2015 (preferably the student version, as it's free), b) MaxBMD, a bmd importer for 3ds Max, and c) BMDCubed, a custom BMD converter that can convert .DAE files made by 3ds Max into .bmds. Once you have 3ds Max set up, you're going to want to install MaxBMD. It should come with an executable named bmdview.exe, which you should drop in C:\Autodesk\Autodesk_3ds_Max_2015_EFGJKS_Win_64bit_R2_wi_en-US. Once you've done that, all you have to do is open 3ds Max and drag MaxBMD's script onto its tool bar. Congratulations! You can now use MaxBMD. There are multiple types of BMDs you can create now. For custom levels, check out Custom Models. For static objects such as treasures, follow the instructions on the Custom Models page but ignore any steps related to custom collision. Finally, for making custom models that have bones, watch this video tutorial. All three of these model types will require you to use BMDCubed later, so keep it in a safe place!

If you just want to change the textures, you will need j3dview. Open the bmd in j3dview and you can change the textures by replacing the vanilla ones with custom bti files (more on that later). To note is that a) Some textures will get a corrupted UV Map when replaced and b) j3dview is not compatible with custom BMDs or BMDs from Pikmin 2 that contain bones or the like. That is, j3dview can edit the models for the first three areas and possibly the test levels & most treasures.

BMG files

BMG files (.bmg) contain the game's text strings. Yoshi2's custom Pikmin 2 BMG Tool is highly recommended for this, as it allows you to change any text without worrying about the character count. To use it, simply drag the BMG onto packBMG.bat, edit the outputted text file in Notepad++, make sure it's encoded in UTF-8, save, and drag the saved text file onto packBMG.bat. That's all you need to do! (Keep in mind that any version of Python 3 (newer = better) is needed for this tool to work.)

Any text editor can also edit these, but once again, Notepad++ is highly recommended. You can find the strings after you scroll past the initial control data. If you want to edit the strings using a text editor, remember to keep their length the same. i.e. You can replace "Floor" with "Level", but not with "Step" or "Sublevel".

BTI files

BTI files (.bti) are image files. You'll need Wiimms SZS Toolset to view these. As with SZS files, you convert a BTI to PNG with the command line, though you can make a script to skip the command line part. The command to convert a BTI file is wimgt DECODE <BTI file path>. To save the converted PNG files back into a BTI format, use a program called png2bti. To use it, flip the image vertically and then drag it onto the exe. To note is that png2bti cannot compress larger images as well as Nintendo themeselves can, but you can get around this by making the modified texture half the size of the one it's replacing. This shouldn't be a problem with smaller textures such as 32x32 and below.

Scripts

As with SZS files, you can write a script so that you don't have to write commands all the time. Open up a text editor, write

wimgt DECODE %1

And save it somewhere you can remember, with the name BTI converter.bat. Then, when you want to convert a BTI file into PNG, simply drag the BTI file onto the BAT file you created.

Now open a new file in the text editor and write

wimgt ENCODE %1

And save it with the name BTI updater.bat Now when you want to convert one of your PNG files back into BTI format, just drag the png onto this new BAT.

Running your modified game

See General instructions#Running a modified game.