dtlAnimations

Dev builds

Development builds of this project can be acquired at the provided continuous integration server. These builds have not been approved by the BukkitDev staff. Use them at your own risk.

Dev Builds

How it works

This plugin uses the vanilla server packets to send fake information about changes done the to world. So it does not affect the server.

Animations are stored in the animations.yml file, on server start all schematics are converted into Minecraft Packets, and send to clients that is in range of an animation.

If no players are in range of a animation, the connection is not affected in any way by this animation.

Limitations

So no one will ask if something is possible or not. Here are some limitations for this plugin.

1. Because how this plugin works, there are some limitations on animations sizes and animation numbers. You can suffer connection problems if you send too many or really big animations to many players at once. So be aware of the sizes of your animation.
   
2. You need to be aware what animations your creating, if you would create an animation that allows walking on it but on the server side there is nothing just air, server will see this as a fly hack
   
3. when using this plugin along with denizens be aware when creating "player animations", because these animations will see only one player ;)
   
4. Plugin updates are coming with a 1-3 days delay, each plugin version is only usable for the specified bukkit version.

For what things it's used in the best way

Mainly this project was created to create animations for things like Windmill's, Chimney smoke, and other simple things that allows to make the world more dynamic, with such things the server suffers like nothing up to 20 players (didn't tested it on larger servers yet, so any information would be helpful)

Any ideas are welcome :)

Animation script

A animation set in the aniamtions.yml should look like this

animation:
  name: Animation name
  schedule: 40 # default frame timer (20 = 1 second)
  distance: 60 #distance (radius) how far players should get packets
  location: 
    x: -2.0
    y: 95.0
    z: -99.0
    world: world
  frames:
    1:
      # the schematic file in the frames folder (without the .schematic)
      file: frame1
      # a frame specific schedule time 
      schedule: 20 #(20 = 1 second)
    2:
      file: frame2
    3:
      file: frame3
    4:
      file: frame4

Commands

With v1.3 soon for download you can use the following commands

Frame Commands:

1. /frame list - Shows a list of all frames in the animation
   
2. /frame show <name> - pastes the schematic to the server so you can feel and touch the frame.
   
3. /frame edit <name> - pastes the schematic to the server, and sets the frame into "settings step" so you can change it's schedule time
   
4. /frame save <name> - saves the current frame, the selection to a schematic file in the frames folder, and loads it to the animation.
   
5. /frame saveat <index> <name> - saves the current frame on the specific index, selection to a schematic file in the frames folder, and loads it to the animation.
   
6. /frame replace <name> - replaces the current frame with the existing frame, selection to a schematic file in the frames folder, and loads it to the animation.
   
7. /frame schedule <time> - sets a specific schedule time to the current frame (usable after /frame save)
   
8. /frame next - allows to add a new frame to the animation
   
9. /frame cancel - cancels the creation of a new frame

Animation Commands:

1. /anim create <name> - creates a new session to create an animation with name: <name>
   
2. /anim load <name> - creates a new session with an existing animation: <name>
   
3. /anim schedule <time> - sets the general animation schedule time
   
4. /anim distance <dist> - sets the distance when animation packets should be send to players
   
5. /anim finish - ends the session and saves the animation to the file
   
6. /anim cancel - cancels the animation session (WARNING! if you replaced any frame during this session or changed the schematic it will persist)
   
7. /anim start <name> - starts an animation if it's not running already
   
8. /anim stop <name> - stops the selected animation if it's running

Contact

You can reach me on my IRC channel on "irc.esper.net", Link here. You are always welcome :)