Fire Pro Returns Save Tool - Preview v0.0.1 Readme

readme-preview-0_0_1

FPRSaveTool - Fire Pro Wrestling Returns Save Tool (Preview Version 0.0.1)
(pre-release readme, dated 2016/11/20 (November 20, 2016))
==========================================================================

MAJOR NOTICE: This program is nowhere near done yet.

This preview version is being released to gauge feedback from the Fire Pro
community with regards to the program's interface/design.

================================================================================
Introduction
================================================================================
FPRSaveTool is a tool for viewing various parts of the save data of Fire Pro
Wrestling Returns. Editing is not capable yet; see the "Not Yet Available"
section for why that is.

Requires .NET Framework 4, because fuck it, I'm lazy. Normally I'd say "Hey, use
.NET v2, because people on other operating systems matter!" but not this time.

================================================================================
Obtaining Save File
================================================================================
In this preview version, only the raw Fire Pro Returns save file is supported.
Obtaining this file requires jumping through some hoops...

This file has one of the following names, depending on region:
Japan  - BISLPM-66082
USA    - BASLUS-21702
Europe - BESLES-55041

The file sizes are...
raw size: 892 KB (913,892 bytes)
on-disk size: 896 KB (917,504 bytes)

Required tools:
* MyMC
  available from http://www.csclub.uwaterloo.ca:11068/mymc/
* PS2 Save Builder
  available from http://www.ps2savetools.com/wpfb-file/ps2_save_builder_0-8x-zip/

MyMC is required only if you are using PCSX2 memory cards.

PS2 Save Builder is required to extract the raw save file.
I don't know of any equivalent tools to PS2 Save Builder on Mac or Linux, sadly.

--------------------------------------------------------------------------------
[Obtaining raw save from PCSX2 Memory Card (.PS2) via MyMC GUI]
Step 1) Open MyMC-gui and load the .PS2 save file.

Step 2) Look for one of the names listed above under the "Directory" header,
and when you find it, do File -> Export. This will make a .PSU file by default,
which can be opened in PS2 Save Builder.

Step 3) Continue from below instructions at Step 4.

--------------------------------------------------------------------------------
[Obtaining raw save from PCSX2 Memory Card (.PS2) via MyMC Command Line]
Step 1) Make sure the mymc executable is in your path, or copy the save file
to the MyMC directory.

Step 2) Open a command prompt or terminal, change to the directory containing
the "mymc" executable (if not in your path) or where the memory card is (if mymc
is in your path), and enter this command (no quotes):
"mymc [path_to.ps2] dir"
replacing [path_to.ps2] with the path to the memory card.

This will print a list of saves on the memory card. You want to look for one of
the names listed above (BISLPM-66082, BASLUS-21702, BESLES-55041).

Step 3) If one of the Fire Pro Returns saves is on the card, run this command:
"mymc [path_to.ps2] export [savename]"
Again, don't use quotes, and replace [path_to.ps2] with the path to the memory
card. Replace [savename] with one of the three names from the previous step.

This will create a PSU format save, which can be opened by PS2 Save Builder.

Step 4) Open the extracted file in PS2 Save Builder, right click on the filename
of the raw save data (BISLPM-66082, BASLUS-21702, BESLES-55041), and hit "Extract".

Step 5) You did it! Open this file in FPRSaveTool, and you should have the data.

--------------------------------------------------------------------------------
[Obtaining raw save from Other PS2 Memory Card Formats]
PS2 Save Builder supports a number of formats:
- AR MAX Power Save (*.pws)
- AR MAX V3 (*.max)
- Code Breaker Save (*.cbs)
- Memory Linker (*.psu)
- NPort (*.npo)
- SharkPort 1 (*.spo)
- SharkPort 2 (*.sps)
- SharkPort (*.md)
- Xploder 4 Pro (*.p2m)
- X-Port 1 (*.xpo)
- X-Port 2 (*.xps)

If your save file is in one of these formats, follow the above guide,
but start from Step 4.

--------------------------------------------------------------------------------
[Obtaining raw save from PS3 Save File]
welp, I have no idea what to do here!!!!
That's part of why this is a preview I guess.

================================================================================
Functionality
================================================================================
Preview Version 0.0.1 has the following functionality (view only):

[Options]
- Stereo/Mono
- BGM Volumes (Menu, Entrance, Match)
- Entrance Movies, Vibration, Shortcut, Check Save
  Haven't fully confirmed the order of these four, though...

[Belts]
- Belt Name
- Main Plate, Sub Plate, Belt Strap Designs
- Main Plate, Sub Plate, Belt Strap Colors
- Weight Class, Participants (Single/Tag/6Man/8Man), Match Type
- (partial) Belt History

[Organizations/Groups]
- Organization and Group list
- Short and Long Org/Group names
- Group alignment (Face/Neutral/Heel)

[Referees]
- Name
- Settings
- (partial) Appearance data
  The Appearance layout in the Referee tab is the design I'd like to use for all
  Appearance sections going forward, but I'd like to get feedback on its design,
  especially compared to the Wrestler Appearance layout.

[Ring Mats]
- Name
- Mat Style
- Turnbuckle Style
- Logo
- All colors

[Teams]
- Team Name
- Slot Status
  (Apparently, deleted teams aren't overwritten...)

[Edit Wrestlers]
- Name Info
- Biography (not fully working)
- Finisher Name
- Profile Information
- Skills
- Parameters
- Appearance
 - Base: Stance, Body Size
 - Head: Base number (doesn't map 1:1 to in-game numbers?)
- Colors
  - Base: Skin, Trunks, and Misc.
  - Head: Base Colors 1-3, Colors for Layers 1 and 2
  - Chest: Colors for Layers 1-3
  - Waist: Colors for Layers 1-3
  - Upper Arms: Colors for Layers 1 and 2
  - Lower Arms: Colors for Layers 1 and 2
  - Colors for Wrist and Feet

[Logos]
- View available logos
- Export logo to PNG

================================================================================
Not Yet Available
================================================================================
The major missing feature is being able to edit things and save them back to the
memory card. This is because of those dang checksums:
http://www.fpwarena.com/forum/viewtopic.php?f=5&t=376

Other than that, there are a number of missing elements in the editor.

[No Planning Done]
I haven't really thought of how to handle these yet:
- Default match settings
- Saved League and Tournament data
- Match Maker data
- Checksum area

[Options]
- Demo Battle settings (match type, participants)

[Belts]
- Contrast options
- Color Editing
- Belt Preview
- Belt History Entry: Wrestler ID -> Wrestler Name

[Organizations/Groups]
- logo slot
- wrestler listing
- add/remove functionality

[Referees]
- the rest of the Appearance data

[Renames]
- Everything

[Recostumes]
- Everything (relies on standardizing the Appearance Edit interface)

[Ring Mats]
- Color Editing
- Ring Preview

[Teams]
- Everything that isn't team name or team slot status

[Edit Wrestler]
- Wrestler Moveset
- Wrestler CPU Logic
- most Wrestler Appearance values (Stance and Body Size excepted)
- possibly re-structure the Appearance Edit tab

[Logos]
- Most functionality (need to look at my logo viewer code again)