diff --git a/Construct [BP]/manifest.json b/Construct [BP]/manifest.json index 812ce5c..34eb3bc 100644 --- a/Construct [BP]/manifest.json +++ b/Construct [BP]/manifest.json @@ -2,7 +2,7 @@ "format_version": 2, "header": { "name": "Construct [BP] v1.0.0", - "description": "Survival building extension for §l§aCanopy§r by §aForestOfLight§r.", + "description": "Survival building addon by §aForestOfLight§r.", "uuid": "8c0c0153-d8b9-482a-889f-aef922b8fe58", "min_engine_version": [1, 21, 70], "version": [1, 0, 0] diff --git a/Construct [BP]/scripts/config.js b/Construct [BP]/scripts/config.js index e1de1d4..0f36f06 100644 --- a/Construct [BP]/scripts/config.js +++ b/Construct [BP]/scripts/config.js @@ -3,6 +3,6 @@ import { CanopyExtension } from './lib/canopy/CanopyExtension'; export const extension = new CanopyExtension({ author: 'ForestOfLight', name: 'Construct', - description: 'Make building structures in survival easier!', + description: 'Survival building addon by §aForestOfLight§r.', version: '1.0.0' }); \ No newline at end of file diff --git a/Construct [RP]/manifest.json b/Construct [RP]/manifest.json index 3d0eed8..ebfc698 100644 --- a/Construct [RP]/manifest.json +++ b/Construct [RP]/manifest.json @@ -2,7 +2,7 @@ "format_version": 2, "header": { "name": "Construct [RP] v1.0.0", - "description": "Survival building extension for §l§aCanopy§r by §aForestOfLight§r.", + "description": "Survival building addon by §aForestOfLight§r.", "uuid": "375ec465-3dc1-429f-8b4c-a337889e1ed4", "version": [1, 0, 0], "min_engine_version": [1,17,0] diff --git a/README.md b/README.md index 07fbcff..710b5ef 100644 --- a/README.md +++ b/README.md @@ -12,33 +12,48 @@ --- -Intro paragraph. +The closest thing Bedrock has to **Litematica**. This addon allows you to create and manage ghost structures in your world, making it easier to build them in survival. Construct offers these convenient features: + +- **Block Validation**: Highlights incorrectly placed blocks. +- **Easy Place**: Always places blocks correctly. +- **Structure Management**: Create, edit, and delete structures. + +[IMAGE HERE] > [!IMPORTANT] -> This addon is a **Canopy Extension**, which means **Canopy** must be installed in your world for it to work. +> This is a standalone addon, but it is also a **Canopy Extension**, which means **Canopy** can be installed in your world for a few extra features. > [Download **Canopy** here!](https://github.com/ForestOfLight/Canopy) ## Usage -All commands are prefixed with `./`. Do `./help` for more information. +### Construct Menu -**Usage: `./struct add `** -Adds a new structure. +The main Construct menu can be accessed using a `paper` item. Using it will open a GUI where you can manage your structures instances. You can create new instances of structures, edit existing ones, and delete them when you no longer need them. There are plenty options available to customize your building style, including the ability build in layers. -**Usage: `./struct remove `** -Removes a structure. +*Pro tip: You can name the paper after a structure instance to automagically select it when you open the menu!* + +### Adding New Structures + +Construct uses Minecraft's vanilla structure system so that you can easily create and build new structures. + +- The simplest way to add a new structure to the structure list is to save it using a structure block. +- Importing structures from other worlds is as simple as dropping the `.mcstructure` file in Construct's `Construct [BP]/structures` folder. Then, to select your structure in the Construct menu, choose "Other" when presented with the structures and enter the filename (without including ".mcstructure"). You only need to do this once with new structures, since Construct will save them for future use! + +### Commands + +**Usage: `./construct`** +Shows the construct form. Only available when **Canopy** is installed. ## Roadmap -- [x] Form to manage structure +- [x] Form to manage structures - [x] Structure naming & movement -- [x] easyPlace rule -- [ ] Automatic Armor stand posing +- [x] Easyplace +- [x] Correct block placement checking - [ ] Automatic material gathering from inventories -- [ ] Correct block placement checking - [ ] Structure Mirroring & Rotation - [ ] Structure Merging into SuperStructures ## Issues & Suggestions -If you have any issues or suggestions, please open an issue on this repo. Additionally, if you're interested in contributing to the project, feel free to open a pull request! +If you have any issues or suggestions, please don't hesitate to open an issue on this repo. Additionally, if you're interested in contributing to the project, feel free to open a pull request!