From eb11ab2da545fe1118ba8c79dac0b20a250ad652 Mon Sep 17 00:00:00 2001 From: Chomp Date: Sat, 14 Aug 2021 21:34:21 +0100 Subject: [PATCH] Better readme --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b7a7d71..933b7f7 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,21 @@ # BotGenerator -Generate bot templates based on game dumps \ No newline at end of file +Generates bot templates based on user-provided game dumps. + +# Setup + + - Set 'Generator' as start-up project + - Build solution to create required folders in bin folder. + - in Generator\bin\Debug\netcoreapp3.1 + - Place live dumps in subfolder: dumps. - These are the files called 'resp.client.game.bot.generate.xxxxxx.json' + - Run code, bot jsons will be created in the 'output' folder e.g. assault.json + + +# Maintenance + + - Ensure the asset files are kept up to date (Generator\bin\Debug\netcoreapp3.1\Assets\) + - They can be found in Eft/EscapeFromTarkov_Data/resources.assets as a text asset + +# Common problems + + - Don't place the request jsons (files starting with req.*) in the dump folder, these don't contain any bot data. \ No newline at end of file