Skip to content

Commit

Permalink
Update README.md with new usage examples and disclaimer
Browse files Browse the repository at this point in the history
  • Loading branch information
jose-l-martins committed Dec 5, 2024
1 parent 43e3fce commit 94f4e65
Showing 1 changed file with 14 additions and 9 deletions.
23 changes: 14 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,31 +7,36 @@ While GSM only supports Windows, tends to be slower and is closed-source, Ludusa
## Prerequisites

- Python 3.x installed
- Required Python packages installed: `py7zr`, `win32com`, `pyyaml`, `zipfile`, `pypiwin32`
- Required Python packages installed: `py7zr`, `win32com`, `pyyaml`, `zipfile`, `pypiwin32` and `ruamel.yaml`

## Usage

This script accepts the following arguments:

- `input_folder_path`: Path to the folder containing backup files to convert (GSM/.gsba)
- `output_folder_path`: Path to the output folder where the converted backup folders/files are saved (Ludusavi games backups folders)
- `--verbose`: If set, log messages will also be printed to the console
- `backup_type`: Type of backup to process. Accepts either "gsba" or "ludusavi"
- `--gui`: Launch the GUI
- `--input_folder_path`: Path to the folder containing backup files to convert (GSM/.gsba). Required in non-GUI mode.
- `--output_folder_path`: Path to the output folder where the converted backup folders/files are saved (Ludusavi games backups folders). Required in non-GUI mode.
- `--backup_type`: Type of backup to process. Accepts either "gsba_to_ludusavi" or "ludusavi_to_gsba". Required in non-GUI mode.
- `--verbose`: If set, log messages will also be printed to the console.
- `--gui`: Launch the GUI.
- `--no-gui`: Run in command-line mode.

To convert from GSM to Ludusavi, use the following command:

```bash
python main.py input_folder_path output_folder_path gsba
python main.py --no-gui --input_folder_path <input_folder> --output_folder_path <output_folder> --backup_type gsba_to_ludusavi
```

To convert from Ludusavi to GSM, use the following command:

```bash
python main.py input_folder_path output_folder_path ludusavi
python main.py --no-gui --input_folder_path <input_folder> --output_folder_path <output_folder> --backup_type ludusavi_to_gsba
```

To launch the GUI, use the following command:
```bash
python main.py --gui
```
```

## Disclaimer

**Warning:** It is recommended to keep the original backup files for a while and not delete them immediately after conversion. Ensure that the converted outputs are valid by using the validation check operations provided by GameSave Manager and Ludusavi. You can also try converting the backups back and forth between the two types and verify that the initial type can be generated correctly. This will help confirm that the conversion process was successful.

0 comments on commit 94f4e65

Please sign in to comment.