Difference between revisions of "General instructions"

From Pikmin Technical Knowledge Base
Jump to navigation Jump to search
(Created page with "General instructions on how to perform some important tasks. ==Obtaining a game's files== You can obtain the files inside the games by following these instructions. This guid...")
 
(Quick section on scripts.)
Line 23: Line 23:
  
 
A note regarding savestates and emulators: If the game loads data from a file and saves it in RAM, and you make a savestate after this information is loaded, it will always have that information when you reload the savestate, even if you changed the files in the meantime. To get the changes to take effect, make the game reload the file. This depends on the game and file. To be safe, you can always avoid loading savestates altogether.
 
A note regarding savestates and emulators: If the game loads data from a file and saves it in RAM, and you make a savestate after this information is loaded, it will always have that information when you reload the savestate, even if you changed the files in the meantime. To get the changes to take effect, make the game reload the file. This depends on the game and file. To be safe, you can always avoid loading savestates altogether.
 +
 +
== Scripts ==
 +
Some articles in the wiki may provide helpful '''scripts'''. These can either be Windows bash scripts, or Linux shell scripts. Normally, when you want to, for instance, convert a [[GTX file]] to a DDS file, you'd have to go to the command line and run the tools necessary for it. But with scripts, after you set everything up, you can just double-click a GTX file and get a DDS file right away!
 +
 +
First comes the actual script creation. Copy whatever is inside the code blocks provided in the page, but remember to replace any placeholder bits inside less than and greater than signs. For instance, in a code block like so:
 +
:<code>python &lt;path to abc.py&gt; $1</code>
 +
 +
You would replace <code>&lt;path to abc.py&gt;</code> with the full path to where you've placed a Python script called <code>abc.py</code>. Anyway, after you've made any necessary replacements, save the file on your disk somewhere, preferably on a "scripts" folder in your documents so you can keep everything organized. The name of your script should end with the extension <code>.bat</code> in Windows, and <code>.sh</code> in Linux.
 +
 +
Then, you'll have to set up your system to run the script when you double click a file of the given type. Or at least when you right-click and choose "Open with".
 +
 +
The instructions depend on your system, so you should search online on how to associate a program (or script) with a file extension. But in general, you can right-click a file of the type you want to operate on, choose "Open with", and use the dialog box to add a new program (or in our case, script) to the file type.
  
 
[[Category:Instructions]]
 
[[Category:Instructions]]

Revision as of 15:16, 15 August 2017

General instructions on how to perform some important tasks.

Obtaining a game's files

You can obtain the files inside the games by following these instructions. This guide only explains how to obtain the files from inside a copy of the game. It won't explain how to obtain a copy.


To do: Add this.

Saving changes

Once you have a game's files, you can read them all you want. If you want to make changes, you can do so with the appropriate tools, and use those same tools to save the altered files. Remember that SZS files need to be repacked, if you changed their contents! What you need to do to have those changes be applied to the game depends is elaborated in the next sections.

GameCube

What you have to do depends on you want to run the game. If you want to run it with Dolphin, through a folder and boot.dol, you won't need to do anything else after saving the files (except maybe restarting the game or area).

If you use an ISO, you'll have to apply the changes onto the ISO, since you've only made changes on the extract folder so far.


To do: Add ISO instructions.

Wii U

To do: Add Wii U instructions.

Running a modified game

To do: Add instructions on how to run the games with emulators and actual consoles.

A note regarding savestates and emulators: If the game loads data from a file and saves it in RAM, and you make a savestate after this information is loaded, it will always have that information when you reload the savestate, even if you changed the files in the meantime. To get the changes to take effect, make the game reload the file. This depends on the game and file. To be safe, you can always avoid loading savestates altogether.

Scripts

Some articles in the wiki may provide helpful scripts. These can either be Windows bash scripts, or Linux shell scripts. Normally, when you want to, for instance, convert a GTX file to a DDS file, you'd have to go to the command line and run the tools necessary for it. But with scripts, after you set everything up, you can just double-click a GTX file and get a DDS file right away!

First comes the actual script creation. Copy whatever is inside the code blocks provided in the page, but remember to replace any placeholder bits inside less than and greater than signs. For instance, in a code block like so:

python <path to abc.py> $1

You would replace <path to abc.py> with the full path to where you've placed a Python script called abc.py. Anyway, after you've made any necessary replacements, save the file on your disk somewhere, preferably on a "scripts" folder in your documents so you can keep everything organized. The name of your script should end with the extension .bat in Windows, and .sh in Linux.

Then, you'll have to set up your system to run the script when you double click a file of the given type. Or at least when you right-click and choose "Open with".

The instructions depend on your system, so you should search online on how to associate a program (or script) with a file extension. But in general, you can right-click a file of the type you want to operate on, choose "Open with", and use the dialog box to add a new program (or in our case, script) to the file type.