diff --git a/README.md b/README.md index 53b56a2..c7a68f7 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,15 @@ +# BuildGPT + This mod adds a `/buildgpt` command that allows the player to place AI generated structures into the world with a customizable prompt. -# Setup +## Setup An OpenAI Key is required for this mod in order to work. create a file `.openaikey` in the config folder or run the `/buildbpt` command with valid parameters once to generate the file and then place your API Key in there. The command should now work! -# Command +## Command The command has 2 modes: ### Bound `/buildgpt bound ` @@ -21,7 +23,7 @@ This mode only has a starting point from which the AI will (in most cases) gener Of course this is not always the case as ChatGPT can sometimes return funny responses with unexpected behaviour, which is why the `bound` mode exists and the `unbound` mode should by used with caution, since placed blocks cannot be undone. During testing, I noticed that structures will **usually** not exceed a 20x20x20 block cube unless prompted to do otherwhise. -# Prompt +## Prompt There is a predefined prompt in the Mod, meaning that the user is only required to input the building name or description into the `` field of the command, since the mod requires the response to be formatted a certain way. The prompt can also be overwritten by inputting a custom prompt into the `` field of the command.