Core commit. Compile and run on the OpenPandora
[mupen64plus-pandora.git] / source / mupen64plus-core / tools / savestate_convert.txt
1 ==============================================================================
2 savestate_convert.txt - Mupen64Plus - July 12th, 2008
3
4 This conversion tool was written to help users migrate their savestate files
5 when there are changes to the savestate file format which break backward
6 compatibility.
7
8 To compile the conversion tool, open a console window, go to the root of your
9 Mupen64Plus source code, and type:
10
11 gcc -o savestate_convert -lz tools/savestate_convert.c
12
13 This will create a small command-line application called 'savestate_convert'.
14 This program takes only one command-line parameter, which is a path to the
15 savestate file that you want to update.  The old savestate file will be
16 overwritten with the new one, so you may wish to first make a backup copy
17 of the savestate file.  If you update a savestate file to a newer version,
18 older versions of Mupen64Plus will not be able to load it.
19
20 If you wish to update all of the savestate files in your home directory, you
21 may do so with the following bash command:
22
23 for file in ~/.mupen64plus/save/*.st*; do ./savestate_convert "${file}"; done
24
25 ==============================================================================
26 Savestate File Format History:
27
28 version 0:
29  - Original (Unversioned) file format
30  - used by Mupen64 v0.5 and Mupen64Plus up to v1.4
31
32 version 1.0:
33  - bugfix: TLB was not being entirely saved and restored
34  - added small header with magic number and version number
35  - introduced in rev 758 of Mupen64Plus SVN repository (trunk)
36