Magic Sandbox Editor

# This is the key name of this spell
# It must be unique across the server, and is used in commands such as /mage, /wand and /mgive
# to refer to this spell.
myspell:
  # Name and description may be added here and will appear in lore for this spell.
  name: My New Spell
  description: Damage Your Target
  # Choose an icon, used when showing this spell in a wand inventory.
  icon: stick
  # Actions define what this spell does when cast. In this case we will damage the target.
  actions:
    # Actions can be triggered from a few different events, but the most common is "cast",
    # which will happen immediately when the spell is cast.
    cast:
    - class: Damage
  # Effects are particle or sound effects that are shown when the spell is cast.
  effects:
    cast:
    - location: target
      effectlib:
        class: Sphere
    - sound: magic.zap
  # Parameters change how a spell behaves, these may be base spell parameters or
  # specific to the set of actions you are using.
  parameters:
    range: 32
    damage: 10

mysphere:
  name: My Sphere
  description: Make a temporary sphere of blocks
  icon: slime_ball
  actions:
    cast:
    # Some actions may be chained together.
    # In this case, the Sphere action selects blocks within a Spehere
    # and then it will run the actions in its "actions" list on each of those blocks.
    #
    # Actions that call other actions like this are called "compound" actions.
    # They are generally separated into two categories: those that target blocks, and
    # those that target entities.
    # It only makes sense to use the right type of action with the right type of compound action,
    # using a Damage or PotionEffect action inside a Sphere would do nothing.
    - class: Sphere
      actions:
      # The ModifyBlock action is the most common action to use within a block-based compound action.
      - class: ModifyBlock
  effects:
    cast:
    - sound: magic.zap
    - location: target
      effectlib:
        class: Sphere
        # Variables can be used in effect parameters.
        # They will refer to spell parameters in the main "parameters" section (see below)
        # This keeps effects in sync with spell behaviors, for instance this
        # Sphere effect will always match up to the Sphere action radius
        radius: $radius
        # Likewise, this effect will only last until the Sphere disappears.
        duration: $undo
  parameters:
    # This will make the spell ignore entities and only target blocks
    target: block
    range: 16
    # This makes the spell cast even if it misses, that is does not hit a block
    # this allows for the creation of a sphere in mid-air
    allow_max_range: true
    radius: 3
    # A "brush" in Magic is a material or other special tool used for modifying blocks
    # in this case we are simply using glass.
    brush: glass
    # Spells won't modify air by default, here we allow this spell to only modify air so it won't break anything.
    modifiable: air
    # Almost everything in Magic is undoable. We don't want our world filled with
    # random spheres, so we will make this one last only 10 seconds.
    undo: 10000
    # Spell can be given cooldowns, so they can't be spam-cast.
    # This spell is limited to every 15 seconds, allowing it to undo
    # before it can be cast again.
    cooldown: 15000

mybreak:
  name: My Break
  description: Break a Block
  icon: sulphur
  actions:
    cast:
    # The BreakBlock action can be used to slowly break blocks, using packet effects
    # to mimic vanilla block breaking.
    - class: BreakBlock
  effects:
    cast:
    - sound: magic.zap
    - location: target
      particle: block_crack
      # Some particles, like block_crack, require extra data like a material to work with.
      # However, in this case we will let the particle use the target block, which is the default
      # behavior if you don't specify a material. Try uncommenting the following line to see what happens.
      # material: glass

# These parameters can be used to fill out particle effects without sending
      # additional particle packets to players.
      # This is an efficient way to give your effects more punch.
      particle_count: 30
      # The offset X/Y/Z parameters make the particles randomly spawn within a volume around the
      # target location
      particle_offset_x: 0.5
      particle_offset_y: 0.5
      particle_offset_z: 0.5

parameters:
    # This will make the spell ignore entities and only target blocks
    target: block
    range: 16
    # This determines how much block durability to take away with each cast
    # Repeated casts will do more damage, eventually destroying the block.
    break_durability: 10
    # Only certain blocks are destructible by default. Here we make this spell
    # able to break any solid block.
    destructible: solid
    # Almost everything in Magic is undoable. We don't want our world filled with
    # random holes, so we will make this one last only 10 seconds.
    undo: 10000

goldwalker:
  name: Goldwalker
  description: Turn everything around you to gold
  icon: gold_ingot
  actions:
    cast:
    # The repeat action repeats its contained actions
    # multiple times.
    - class: Repeat
      actions:
      # The Retarget action updates the target location
      # Otherwise each iteration of this Repeat would target
      # the same location.
      - class: Retarget
      - class: Sphere
        actions:
        - class: ModifyBlock
      # The delay action delays for some amount of time
      # before letting the spell proceed on to the next actions
      # This is often used inside of a Repeat action to make a spell
      # animate over several ticks.
      # without the Delay, the Repeat would run through its repetitions
      # immediately.
      - class: Delay
  parameters:
    target: self
    radius: 4
    brush: gold_block
    repeat: 100
    # Delaying for 500 milliseconds (1/2 a second) in between each
    # repeat, meaning this runs twice a second.
    delay: 500
    # Here we use a "negated" material set. The ! character at the start
    # means "not", so this will modify anything that's not transparent.
    # This prevents tall grass and other passthrough blocks from turning
    # to gold.
    # We would still like to be able to walk on lava and water, though,
    # so we add those to the list.
    modifiable: "all_water,all_lava,!transparent"
    # This parameter doesn't affect the spell behavior at all, but will
    # advertise that this spell lasts for 50 seconds, which is
    # delay x repeat.
    total_duration: 50000
    undo: 10000
    # The undo_speed parameter can be used to make undo animated.
    # This will undo 20 blocks per second, rather than undoing all at once.
    undo_speed: 20
    cooldown: 2000

Welcome to the Magic spell editor!

This editor will assist you in creating and editing spell configurations. If this is your first time here, it is strongly recommended that you follow this brief tutorial!

Just click anywhere on the screen to proceed to the next slide.

Press the escape key at any point to close this tutorial.

This is the main editor area. This is where you will type in your spell configurations!

The editor was made specifically for spell creation, it will check for errors, highlight your spell code for readability, and automatically suggest new properties or values in a context-aware way.

You won't have to leave this page to look up names for materials, particles or anything else you'll need to type here!

The editor comes preloaded with a simple example configuration that describes the general anatomy of a spell. It is a good idea to read through this configuration, paying special attention to its comments, in order to understand how the spell works.

Use this button to clear the editor and start with a completely blank canvas.

This drop-down contains several example spell templates you can load into the editor.

It is highly recommended that you load and read through each one if you are not familiar with the basics of spell configuration!

Each option represents a common use pattern found in many magic spells, though they are really only here to give you ideas. Once you are familiar with the basics of spell anatomy, and the spell actions available to you, the possibilities are endless!

The Load button can be used to load any spell created by any player using this editor, including your own.

All of the builtin survival spells are also available to load here. Some of them are documented with comments, but most of them may not be. It might take some time to fully understand how they work.

If you are not already logged in, there are many benefits to creating a login using this Login button!

You do not have to enter any information other than your in-game name.

You will then need to log into sandbox.elmakers.com with your Minecraft client, and enter your unique code.

Once you have done this, you will be able to save your spell configurations and share them with the community!

But even better, in-game on the sandbox server you will be given a wand containing all of the spells you have made and saved in this editor. Your changes here will show up immediately in-game, allowing for rapid prototyping, testing and debugging of your new spell configs.

Once you log in, you will stay logged in and will not be shown this tutorial again.

When you have something you want to try out, you can use the Save button.

Saving a spell will keep it for later, and also share it with the community! Anyone will be able to load your spell, try it out, and make copies of it to modify or improve it.

Saving a spell will also add it onto your Sandbox Wand in-game on the sandbox server so you can try it out live. Each time you click the Save button, your spell configs on the sandbox server will reload so you can easily test out changes.

If you find a config you like using the Load button, you may want to try it out in-game or modify it.

Since every spell in the game needs to have a unique name, you won't be able to save someone else's spell directly. You don't want to overwrite their creation!

So instead you need to rename it to something unique. If you're at a creative loss for a new name, simply hit the Fork button and a new unique name will be created for you.

If, for some reason, you've made a mistake saving a spell and you really want it gone, use the Delete button.

This will delete the spell you currently have loaded in the editor.

Just remember- forever is a long time!

Once you have a spell you're happy with and you'd like to use it on your own server, click the Download button to download the spell config.

Then just drop that file into the plugins/Magic/spells folder on your server, use /magic load and your spell will be available!

For players to use it, you will need to add it to a path config or a shop, or provide some other way for it to be obtainable.

For detailed information on all spell actions, effect classes and just about everything else in Magic, click the Reference button to open the reference guide.

This tutorial is a work in progress, click this button if you ever wish to see it again.

Thank you for reading through the tutorial!

Best of luck with your new creations! If you invent something amazing please share it with the community on the SpigotMC Discussion Board or in the Magic discord channel .