Skip to content

Commit 81c4a2d

Browse files
committed
Updated Readme + fixed typo
1 parent 6fdc54d commit 81c4a2d

2 files changed

Lines changed: 32 additions & 10 deletions

File tree

README.md

Lines changed: 31 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,27 @@ Graveyard-Keeper-Savefile-Editor
22
================================
33
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
44

5+
* [Introduction](#introduction)
6+
* [Currently Editable](#currently-editable)
7+
* [Screenshots](#screenshots)
8+
* [Installation](#installation)
9+
+ [General](#general)
10+
+ [Installing the Python version](#installing-the-python-version)
11+
* [Save File Locations](#save-file-locations)
12+
* [Usage](#usage)
13+
* [Changelog](#changelog)
14+
* [Additional Thanks](#additional-thanks-go-to)
15+
* [Manually editing saves](#manually-editing-saves)
16+
* [The application is not working?](#the-application-is-not-working-)
17+
* [Notice](#notice)
18+
* [Building](#building)
19+
20+
## Introduction
21+
522
This is a save editor for [Graveyard Keeper](https://store.steampowered.com/app/599140/Graveyard_Keeper/).
623

7-
The python version works on Windows, Linux and macOS.
8-
For Windows a .exe version available too.
24+
The Python version works on Windows, Linux and macOS.
25+
For Windows a `.exe` version available too.
926

1027
It can load and save `*.dat` files.
1128
Additionally you can export the loaded save to JSON, which has a similar structure to the original `.json` save files.
@@ -43,22 +60,27 @@ But I want to mention the last time someone asked for help due to a save broken
4360
* Remove stuck church goes
4461
* Reset your dungeon
4562

46-
## Screenshot
63+
## Screenshots
4764

4865
![Preview](https://i.imgur.com/XZdmo3Z.png)
4966

5067
## Installation
5168

52-
* Download this as zip and extract it to the folder where you want it to be
69+
### General
70+
If you have Python installed, you can directly use the master branch (download [here](https://github.com/NetroScript/Graveyard-Keeper-Savefile-Editor/archive/refs/heads/master.zip)) and go over to [Installing the Python version](#installing-the-python-version).
71+
This method of installation works on any platform (Windows, Linux, macOS).
72+
73+
**If you are on Windows and do not have Python installed**, you can download a `.zip` file containing a `.exe` instead. You can find this `.zip` file on the [releases page](https://github.com/NetroScript/Graveyard-Keeper-Savefile-Editor/releases). The downloaded archive has a bundled version of Python with all necessary modules.
74+
75+
### Installing the Python version
76+
77+
* Download this as zip and extract it any folder
5378
* Get Python (>=3.4)
54-
* If you are using a macOS/Linux system where `python` is by default python 2.x, replace `python` with `python3`. Also instead of creating a .bat file, create a .sh file. Additionally according to users you might also need to install `python-tk` if it is not yet included in your distribution.
79+
* If you are using a macOS/Linux system where `python` is by default Python 2.x, replace `python` with `python3`. Additionally according to users you might also need to install `python-tk` if it is not yet included in your distribution.
5580
* Install dependencies using `python -m pip install -r requirements.txt`.
56-
* Execute the file with `python main.py` (in the console with the folder where main.py resides as working directory - to simplify this just create a `run.bat` in the directory with the same content)
81+
* Execute the file with `python main.py` (in the console with the folder where main.py resides as working directory - to simplify this just create a `run.bat` (Windows) or `run.sh` (Linux) in the directory with the same content)
5782
* Enjoy
5883

59-
**OR**
60-
61-
Download a [frozen release](https://github.com/NetroScript/Graveyard-Keeper-Savefile-Editor/releases) for windows (so you don't need to install python).
6284

6385
## Save File Locations
6486

main.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ def get_savefiles():
161161
saveslots[i] = file.split(".info")[0]
162162
i += 1
163163

164-
print("Found and loaded informatin for save: " + file)
164+
print("Found and loaded information for save: " + file)
165165
except:
166166
print("Failed to load information for save: " + file)
167167

0 commit comments

Comments
 (0)