Skip to content

Commit

Permalink
Use GitHub Flavored Markdown alerts in the readme
Browse files Browse the repository at this point in the history
Also add a link to the incompatible games list and add thanks to all
contributors.
  • Loading branch information
Z1ni committed Feb 2, 2024
1 parent a9b2d68 commit 23cc1e5
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@ When run, the script produces a ZIP file for each supported game save found in t

In most cases the files in the ZIP can be copied to the save directory of the Steam/Epic version of the game. To find out the save file location, check [PCGamingWiki](https://www.pcgamingwiki.com/).

## ⚠️ If you want the script to support another game, please open an issue [here](https://github.com/Z1ni/XGP-save-extractor/issues/new/choose). ⚠️
> [!IMPORTANT]
> If you want the script to support another game, please open an issue [here](https://github.com/Z1ni/XGP-save-extractor/issues/new/choose).
>
> Check the [incompatible game list](#incompatible-games) below and search the issues for a duplicate before creating a new one.
## Supported games
If you migrate a save to Steam/Epic version that's listed with ❔ below, please open an issue and confirm whether it worked, so the table can be updated.
Expand Down Expand Up @@ -59,15 +62,19 @@ These games use different save formats than the Steam/Epic version that can't be
| Tinykin | [#28](https://github.com/Z1ni/XGP-save-extractor/issues/28) |

## Running
⚠️ **NOTE**: If the save file extraction fails, wait for a bit and try again. The Xbox cloud save sync can take some time and produce invalid files while syncing is in progress.
> [!IMPORTANT]
> If the save file extraction fails, wait for a bit and try again. The Xbox cloud save sync can take some time and produce invalid files while syncing is in progress.
Download the latest release for an one-file executable: https://github.com/Z1ni/XGP-save-extractor/releases
> [!IMPORTANT]
> Some anti-virus/anti-malware software can flag the executable as malicious. The executable is produced with [PyInstaller](https://pyinstaller.org/) and contains the Python interpreter alongside with the same `main.py` script as in this repo.
⚠️ **NOTE**: Some anti-virus/anti-malware software can flag the executable as malicious. The executable is produced with [PyInstaller](https://pyinstaller.org/) and contains the Python interpreter alongside with the same `main.py` script as in this repo.
Download the latest release for an one-file executable: https://github.com/Z1ni/XGP-save-extractor/releases

*Or*

Run `main.py` with Python 3.10+. The script produces ZIP files for each of the supported games that are installed for the current user.

## Thanks
Thanks to [@snoozbuster](https://github.com/snoozbuster) for figuring out the container format at https://github.com/goatfungus/NMSSaveEditor/issues/306.

Also thanks to everyone that has [contributed](https://github.com/Z1ni/XGP-save-extractor/graphs/contributors) by adding support for new games.

0 comments on commit 23cc1e5

Please sign in to comment.