StructureAPI
The StructureAPI
~ Loading and placing schematics has NEVER been SO EASY ~
The StructureAPI is that provides a convenient way to load and place schematics. Players can pick these schematics (also referred to as plans) from a menu and place them in the world. Scroll down to 'Quick Start' or watch the 'Quick Demo' to know more about how to setup your server with plans. StructureAPI aims to provide servers with a wide range of tools to place structures.
For older versions...
see structureapi 2.1.0 for the old page
Upgrading from 2.0.0 or 2.1.0? READ THIS!!
If you haven't created a backup yet CREATE BACKUPS OF YOUR SETTLERCRAFT-CORE DIRECTORY!!!. This update will upgrade the database and THERE IS NOW WAY BACK, NO DOWNGRADE POSSIBLE. Unless ofcourse you made backups ^^
Current Features
- Generate plans from schematics
- Loading plans into a fancy menu
- Select plans from a menu
- Buy plans from a menu (requires Vault)
- Build a structure or continue construction of a existing one
- Demolish a structure
- Rollback structures (since 2.2.0)
- Stop construction or demolition of a structure
- Structures don't overlap each other
- Substructures, structures may be placed inside other structures (configurable to enable/disable)
Quick Demo (2.0.0)
Quick Start
- Download schematics from any website (for example minecraft-schematics.com)
- Place the downloaded schematics within "plugins/SettlerCraft-StructureAPI/generate"
- Start the server or execute the command "stt generate plans" in the server console
- Place the schematics together with the generate XML in "plugins/SettlerCraft-StructureAPI/plans"
- Restart or reload the server
- Plans are now available in the menu, you can open the menu by either using the /stt menu or /stt shop
Note: There is a small requirement for loading the schematics into SettlerCraft. All schematics need to be placed in neutral position which means the schematic needs to be aligned to the east (front pointing to west), unless you don't care about it's orientation. You can do this by simply using the command '/stt rotate [structureid][degrees]' which will rotate a schematic permanently.
Commands (2.2.0)
See github commands for StructureAPI 2.2.x
Permissions
See github permissions for StructureAPI 2.2.x
Installation
See github installation for installing StructureAPI 2.2.x or higher
Required plugins/dependencies
- SettlerCraft-Core - Core functionality of SettlerCraft, contains a distribution of Neo4j database
- SettlerCraft-MenuAPI - Menu library of SettlerCraft
- WorldEdit 6.1
- AsyncWorldEdit - version 2.2.x (Note: you will need both AsyncWorldEdit and AsyncWorldEditInjector)
Optional Hooks
- StructureAPI-WorldGuard - WorldGuard support (requires worldguard 6.1)
- StructureAPI-HolographicDisplays - Hologram support (requires HolographicDisplays 2.1.x)
- StructureAPI-Towny - Support for Towny (since SettlerCraft-2.1.0) and ofcourse requires Towny. Mayors are able to place structures in the wildernis and players won't be able to place structures on or across plots they don't own.
- Vault 1.5.x
Optional Client Plugins (LiteLoader)
Developers
Project is under heavy development. Current implementation is very subject to change, extending this project will most likely break your code. A proper API and documentation is planned after this project has moved to Spigot.
https:github.com/chingo247/StructureAPI
Proper documentation is still in progress... Sorry! Also the API is still very subject to change.
Upcoming Features
- WorldGuard Default flags for structures
- Manual construction - Feed blocks to structures and make them grow
Found a bug ?
Report it here! and I'll try to fix it as soon as possible!
Ideas?
Ideas? Feel free to post below or PM me if u want!
They are single use. However the problem you are adressing may still remain. I can imagine someone creating a loop like this:
Buy Schematic -> Place Schematic -> Destroy Blocks -> Sell Blocks -> Buy Schematic -> etc
I've been thinking about a situation like this for a long time though. I'm considering marking 'schematic blocks' using NBT tags. When a block breaks, I will check for the tag. If it has the tag, then it will drop no resources.
I haven't found the time yet to implement and test this idea...
When you buy schematics... do they or can they be "Single Use?". We use an economy and creating a situation where a person can buy a schematic and build a few hundred houses from that single schematic; which they could get tons of unlimited resources from....
Announcement
I'm currently moving to Spigot. It could still take a month or two. StructureAPI 2.3.0 will be my last update on the bukkit website (i'll still do any fixes).
The move to Spigot generally means that you can still continue to use StructureAPI when you are running a bukkit server.
The next update will take a while, I'm currently overthinking the way I'm organizing StructureAPI.
Release 2.3.0
Features:
Note: If you were using 2.1.0, you need to update to 2.2.0 first to apply the necessary updates
Update Announcement 2.3.0
I'll be releasing update
next weekend.It's a small update bringing some additional worldguard features:EDIT: Due to circumstances I wasn't able to fully test 2.3.0. Therefore I will be releasing the update later this week. Sorry for the inconvenience
@chingo247
Alright, thanks for the information, i'll be looking forward to it. Thanks by the way for your effort and time on doing this!
@AlbeRCGames The blockplacing is done by AsyncWorldEdit. If I want to update to 1.9 I have to move to AsyncWorldEdit Premium ($10).
Therefore I'm also looking at an Fast AsyncWorldEdit as an alternative: https://www.spigotmc.org/resources/free-fast-async-worldedit-%CE%B2.13932/updates
At the moment I'm short on time, but I can take a closer look within a week or two.
Will there be soon a version for MC 1.9?
HotFix 2.2.1
There was a bug in SettlerCraft-Core-2.2.1, which caused problems for creating a default config or menu.xml. Server owners which already had an older version of SettlerCraft installed weren't affected by it. However, for fresh installations it threw an error.
HotFix available at: https://github.com/chingo247/SettlerCraft/releases/tag/2.2.0
Old file has been deleted to avoid errors in new installations
Sorry for the inconvenience
Update 2.2.0 Released
If you are upgrading from 2.0.0 or 2.1.0 READ THIS
If you haven't created a backup yet CREATE BACKUPS OF YOUR SETTLERCRAFT-CORE DIRECTORY!!!. This update will upgrade the database and THERE IS NOW WAY BACK, NO DOWNGRADE POSSIBLE. Unless ofcourse you made backups ^^
Changelog
NOTES
Rollback for entities/mobs is not yet supported, but will be included in later release
Please report any bug when you find one ^^
Will be creating a new demo video tomorrow, also replace the external links to github
Announcement
Update 2.2.0 is pretty much ready, releasing it tomorrow ^^
Update (Coming soon)
Rollback Feature
I'm planning to do another release soon. Still need to test everything thoroughly.
New Features
Rollback
Construction ZonesConstruction-Zones: Setup a zone where players are allowed to place structure. In the config file, it will be possible to configure to have players be restricted to only be able to place structures within zones.Also the access to these zones come in 3 flavours:Private: Private Access means only players who are member of the zone can place structures within the zone.Public: Everyone can place structures in this zone. This access type only helps when you have configured that structures can only be placed within zones (otherwise it wouldn't make any sense).Restricted: No one can place structures within the zone.ConstructionZones need more testing/refinement, therefore this feature will be postponed... getting a stable release ready as soon as possible is taking top priority.
Other changes
@TheBlackBeltPanda
At the moment there is no command that can do that. There is a big restructure of the plugin coming up. I made some good progress Yesterday and will be able to tell more about the status of this plugin in upcoming weekend (probably Sunday though).
So in short, I can implement such a feature, but I would rather wait till the update I'm working on is done.
Trying to find a good plugin to use instead of iN_Blocks and came across this. Is there a command to give a player a specific schematic one time?
@chingo247
That's a brilliant idea so main buildings only placed in town but seige weapons etc can be placed in the wild
Ha ha yea I inow how difficult it is to keep requests in one place
@Hmmcrunchy
I could make it so that you could set a 'flag' on a StructurePlan that if set it will
accept the placement of a structure in the wildernis.
Also maybe It's a good idea for me to setup a ticket/issue tracker so features can actually be requested and such xD
@chingo247
No worries :) looking forward to update
I don't feel so bad if not too complex XD
Is there a way of allowing people to build in the towny wilderness at all too ? Handy to be able to buy and build siege engines outside others towns :)
@Hmmcrunchy
Great!
I don't think that what you are asking is unreasonable, a timeout on the protection is fairly small, but I rather do it after upcoming update .
Will comeback at you by then ;)
looking good :) finally managed to get it up and running on my server :) working great ! love it
just one query, is it possible to have the worldguard zone time out? so after an initial period it will be removed so the structure is permanent? be good to allow moving about initially, then it stays forever or perhaps a /stt set to set it in place.
this isn't essential, but just wanting to keep worlguard regions to a min - plus we then attack each other towns with troops and cannons XD and need the cannon to break the walls
@chingo247
ok, thanks :3