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

Added README.md documentation

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

28
README.md
View file

@ -1,9 +1,27 @@
# Fabric Example Mod
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.
For setup instructions please see the [fabric wiki page](https://fabricmc.net/wiki/tutorial:setup) that relates to the IDE that you are using.
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.
## License
The command should now work!
This template is available under the CC0 license. Feel free to learn from it and incorporate it in your own projects.
# Command
The command has 2 modes:
### Bound
`/buildgpt bound <x> <y> <z> <x> <y> <z> <prompt>`
This mode allows the user to set a bounding box outside of which the mod won't place any blocks.
The prompt is directing ChatGPT to generate a structure within those bounds but the mod also has a check after the response, that filters out any blocks outside the bounding box.
### Unbound
`/buildgpt unbound <x> <y> <z> <prompt>`
This mode only has a starting point from which the AI will (in most cases) generate the structure towards increasing coordinates.
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
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.