Overview:
Animated Floors is a plugin ready to turn any rectangular area on the x and z axis to a disco floor!

It essentially changes blocks constantly to allow a nice scrolling effect, Entities standing on them will not glitch as the blocks are changed.



Features:
- A list of different animations to select
- Fully customizable
- Custom user specified block lists with custom data-value support
- Simple to use and configure
- Simple in-game user interaction via commands


Commands:


• /AnimatedFloor or /af
The main command, shows a list of all commands for AnimatedFloors


• /addFloor <Floor name> <BlockPaternName> <Animation Ticks> <Animation Type> <ResetItem>
Add a new animated floor.


• /removeFloor <Floor name>
Remove an animated floor




• /listFloors
See a list of all known animated floors




Permissions:


• af.help (for /animatedfloor or /af)
• af.list (For /listfloors)
• af.remove (For /removeFloor)
• af.add (For /addFloor)




How to use:
--{Instalation}--
To install this plugin, simply go to the 'Plugins' folder in your server's folder and put in the jar file downloaded. Then, either reload or restart your server and the plugin will generate the requiered files.


--{Configuration}--
Open the Config.yml file, it will look something like:




StopFloorsWhenEmpty: turn this to true to stop floor animations when
no players are online. Just to save resources. Note: it will stop blocks from being changed, the tasks will run as normal.


BlockPaterns: under this section you can create lists of blocks that will later be used in the AnimatedFloor.yml in the "BlockPatern" option. The format is itemID;datavalue See the examples provided. You can add as many as you like. If you input just the item ID without any data value next to it, that is also fine.


WARNING: List names such as Glass_List should not apear more than once! Different case letters do not make it different!


Now after you have added your lists of blocks, You can proceed to AnimatedFloors.yml. It will initially look like that:

That is not it though. This is the file where animated floors you add will be stored. So go ahead and add a animated floor either by command ingame or write it directly in this file, And example:

It is important to maintain the correct spacing. Also do not use tabs! use spaces instead.
So, lets go over this file a litle bit:
FloorName will be the name of this animating floor, Each floor should have a different name, Case difference does not count.


AnimationDelayTicks is the delay between each block change per animation, it is in Ticks, Ticks is a time scale used by Bukkit and Spigot (and not only) where 1 second  = 20 ticks.  So if you input 20, that is 1 second between each animation step, 40 is 2 seconds and so on. All positive values (excluding 0) are accepted.


LocationFrom: The location from where the floor begins. (one corner of the rectangle)


LocationTo: The diagonal corner of 'LocationFrom'.


BlockPatern is the list of blocks to be used in this animation. Remember the lists of blocks we talked about in the "Config.yml" ? Those are the ones. This option is not case sensitive.


DoReset is the option that controlls weather or not the animation will reset the floor after it is done or not. In large scales of floors this may cause some lag for a moment.


ResetItemID, here you can input the id of the block that will be used to reset the floor. You have to add this ONLY if you set "DoReset" to true. So when a reset occurs, the entire floor will become whatever block is represented by this id.


AnimationType is the type of anymation (as the name sugests) that will be displayed on this floor.
All animation types:



--{Ingame Configuration}--
You can add floors via commands too! instead of having to go through the trouble of adding them via the files.
To do that use
/addFloor <Floor name> <BlockPaternName> <Animation Ticks> <Animation Type> [ResetItem]


Floor name is the name of the floor to be added, it has to be unique
Block Patern Name is the name of the list (the ones in config,yml)
Animation Ticks: The delay between each animation step.
Animation Type: Check out the available types ^
Reset Item: This parameter is not required, if you specify it, then the animation will reset when it finishes. This parameter represents the block id that the floor will be set to.