Skip to content

Commit

Permalink
docs(readme): update install and build instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
zakuciael committed Apr 7, 2024
1 parent d60e88e commit aff08e5
Showing 1 changed file with 19 additions and 14 deletions.
33 changes: 19 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,39 +9,44 @@

<h4 align="center">
A cross-platform application to convert Horizon Forbidden West's PS4 saves to PC. <br />
This project only supports the <a href="https://store.steampowered.com/app/2420110/Horizon_Forbidden_West_Complete_Edition/">Steam</a> version of the game.
</h4>

## Usage
<br />

### Pre-requirements

- A decrypted PS4 save file (`checkpoint.dat` file).
- (Optional) A `param.sfo` file associated with the save file.
- (Optional) A PNG image for the save file.
- (Optional) A `sce_sys/` folder containing the following files:
- A `param.sfo` file associated with the save file.
- A `icon0.png` file containing the save file's image.

### Installation

> [!CAUTION]
> This project is currently under **heavy development**, which means that it may be subject to **breaking changes** or
> **corrupt** save files.
> Use it at your **own risk**.
Download the executable from the
repository's [release page](https://github.com/zakuciael/hfw-save-converter/releases/latest) or build locally following
the instructions in the [build section](#build).

### Execution
### Usage

```shell
./hfw-save-converter.exe <checkpoint.dat> [-F <path/to/param.sfo>]
./hfw-save-converter.exe <PS4_SAVE_FILE> [-o <OUTPUT_DIR>]
```

For more options and configurations, check the **help** command of the executable.
The converter will automatically look up the save metadata from `sce_sys/param.sfo` file located in the same directory
as the PS4 save file.

For more options and configurations, check out the **help** command.

## Build

> TODO: Detail build steps for the project.
To build the application, install Rust toolchain using the instructions found under the
following [link](https://rustup.rs/).
After installation, run the following command in the terminal

```shell
cargo build -r
```

This will build the release version of the application for the running operating system.

## License

Expand Down

0 comments on commit aff08e5

Please sign in to comment.