diff --git a/README.md b/README.md index 50eae2c..44a3dd5 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,18 @@ # TFVR Ban List Editor Requirements: -- [Godot 4.7 dev2](https://godotengine.org/download/archive/4.7-dev2/) .NET +- [Godot 4.7 dev4](https://godotengine.org/download/archive/4.7-dev4/) .NET or higher + +## What is this? +This is a tool for managing ingame bans, statistics(WIP) and loadout overrides(WIP) for the contractors VR "TFVR" mod + +## How do i use this? +Note: This is designed for the [feathered unicorn](shttps://github.com/mfpousa/feathered-unicorns/tree/main) repo specifically + +Configuring this is straightforward, +open a binary, go to the "more" button +now enter all of the required fields +the KEY is a classic token with repository permissions + +after fillling all of that out you can clone the repo +you are now ready to edit everyhthing, assuming you have write permissions to the source repository