update readme

This commit is contained in:
Chomp 2023-07-03 17:53:15 +01:00
parent d86ae365bf
commit 033c4f03da

View File

@ -1,10 +1,9 @@
# Dump cleaner
## Clean up raw EFT dump jsons into files usabae by SPT
### Clean up raw EFT dump JSONs into files usable by SPT
TODO: write details
# Generate Quest File
## Create a quest file for use by SPT by providing a raw quest dump JSON as input
### Create a quest file for use by SPT by providing a raw quest dump JSON as input
## How to use
1. Build GenerateQuestFile project
2. Copy your aki quests.json into `ChompQuestVerifier\GenerateQuestFile\bin\Debug\net6.0\input` create the input folder if necessary
@ -14,12 +13,8 @@ TODO: write details
# Quest Validator
## Verifies an aki quest json against a live dump of quest data
### Verifies an SPT quest JSON against a live dump of quest data
## How to use
1. Copy your aki quests.json into QuestValidator\bin\Debug\net6.0\input
2. Copy a live quest file dump (resp.client.quest.list_xxxx) into QuestValidator\bin\Debug\net6.0\input
3. Run QuestValidator project to generate a list of warnings found in aki quests.json, separated by quest.
Use the example dump file found in QuestValidator/Examples if you dont have a live quest dump file
3. Run QuestValidator project to generate a list of warnings found in aki quests.json, separated by quest.