Jonas_Jones/BuildGPT
1
0
Fork 0
mirror of https://github.com/JonasunderscoreJones/BuildGPT.git synced 2025-10-22 21:59:18 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fixed headers

Browse source
This commit is contained in:
Jonas_Jones 2024-11-19 20:30:37 +01:00 • committed by GitHub
parent c8bbd4d491
commit 30821d250c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 5 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -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 <x> <y> <z> <x> <y> <z> <prompt>`
@ -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 `<prompt>` 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 `<prompt>` field of the command.