SETTING UP THE CONFIGURATION

Follow this guide to successfully install the Tool Skins configuration on your Minecraft server.

DOWNLOADING THE CONFIGURATION

Visit the marketplace you bought the Tool Skins on. It's either BuiltByBit or KFX Marketplace.

Download the configuration. It should be in a .ZIP format, extract it on your desktop using WinRAR, 7-zip or any other program.

REQUIREMENTS

• A Minecraft: Java Edition server, version 1.21.5 or newer.

Required plugins:

Make sure you have all required plugins installed on your server:

• DeluxeMenus
• Skript
• Sk-Bee
• skript-placeholders

Some of these plugins are dependent on some other plugins you probably already have on your server (PlaceholderAPI, Vault, any economy plugin...)

Optional plugins:

• ItemsAdder – fully supported, with included ItemsAdder files for easier management.
• Oraxen/Nexo/CraftEngine – configuration not included, but you can merge the Tool Skins pack with these plugins.

UPLOADING THE CONFIGURATION

1. Make sure you have all required plugins, and your server is supported by Tool Skins.
2. Open the .ZIP file you downloaded, navigate to "plugins" folder, and move everything from there to your server's "plugins" folder.
3. If you don't use ItemsAdder on your server, you don't have to move the "ItemsAdder" folder.
4. If you already use DeluxeMenus on your server and you don't want to lose access to your existing menus, don't overwrite DeluxeMenus' config.yml file when uploading! Copy over the settings from our configuration to your existing config.yml file.
5. Restart your server.

CONFIGURING THE RESOURCE PACK

Tool Skins is based on resource packs. You will have to set up the resource pack so you can be able to see all skins in-game.

Using a resource pack manager (plugin):

If use ItemsAdder, simply move the "ItemsAdder" folder (from the .ZIP file) to your "plugins" folder, type /iazip and that's it.

If you use Oraxen, Nexo or CraftEngine, you will have to merge Tool Skins resource pack with these plugins. Click on the name of the plugin you're using to learn more about that process.

Vanilla resource pack, without any resource pack managers:

• If you do not have a resource pack yet, this YouTube Video explains how to connect the pack with your server.
• If you already have a resource pack, this website tool can help you merge your existing pack with Tool Skins' resource pack.

FINAL STEPS

After you've done everything above and restarted your server, you should be able to see all skins in the /toolskin menu.

Configuration (ToolSkins.sk)

# Tool Skins v1.8 configuration, might not be the same for every version.

  # The money required to set the skin. (If they have a permission)
  # Set to 0 to completely disable economy.
cost: 1000

  # This is the design that will be applied after each item's name in the menu.
  # If the cost above is set to 0, it will be removed from all menus.
  #
  # Available placeholders: [cost]
  # Please don't use any colors here, they're defined in DeluxeMenus.
cost-design: ($[cost])

  # Placeholders: [diff] -> how much is missing, [cost] -> total cost
no-money: <##850f0f>✘ <##d82625>You need $[cost] to change the skin.
no-money-sound: entity.villager.no

  # Placeholders: [diff] -> how much is missing, [cost] -> total cost
no-money-message: <##d82625>&lTool Skins &8| &fYou need <##d44746>$[diff] &fmore to set skins.

  # Permission format -> It's always format.skin_name (e.g. toolskin.ruby)
permission-format: toolskin.

  # Placeholders: [skin] -> Show the skin's name
no-permission-actionbar: <##850f0f>✘ <##d82625>You haven't unlocked the <##d82625>[skin] <##d82625>Skin!
no-permission-sound: entity.villager.no

  # Placeholders: [skin] -> Show the skin's name
no-permission-message: <##997d1c>⭐ <##d1a91d>Buy a rank to unlock the <##f9d350>[skin] Skin <##d1a91d>and more!


  # A command to open the first gui. Used only when there are no arguments on /toolskin.
  # Don't touch this option unless you use a different gui system.
gui-command: dmenu open skins_sword1 [player]

  # Don't change unless you add more skins or remove existing ones.
number-of-skins: 20


  # Action bar messages shown when the skin was successfully applied:
applied-sword: <##4a730a>✔ <##83ca16>Your sword now has the [skin] Skin!
applied-pickaxe: <##4a730a>✔ <##83ca16>Your pickaxe now has the [skin] Skin!
applied-axe: <##4a730a>✔ <##83ca16>Your axe now has the [skin] Skin!
applied-shovel: <##4a730a>✔ <##83ca16>Your shovel now has the [skin] Skin!
applied-hoe: <##4a730a>✔ <##83ca16>Your hoe now has the [skin] Skin!

  # Chat messages shown when the skin gets successfuly applied:
applied-sword-1: <##83ca16>&lTool Skins &8| &fApplied <##9dc3ed>[skin] Skin &fto your sword!
applied-pickaxe-1: <##83ca16>&lTool Skins &8| &fApplied <##9dc3ed>[skin] Skin &fto your pickaxe!
applied-axe-1: <##83ca16>&lTool Skins &8| &fApplied <##9dc3ed>[skin] Skin &fto your axe!
applied-shovel-1: <##83ca16>&lTool Skins &8| &fApplied <##9dc3ed>[skin] Skin &fto your shovel!
applied-hoe-1: <##83ca16>&lTool Skins &8| &fApplied <##9dc3ed>[skin] Skin &fto your hoe!

applied-sound: entity.experience_orb.pickup

  # If a player uses the tool with a skin that they don't own, should the skin get hidden?
  # Default: false. Enabling this option will temporarily hide skins as long as the items
  # are not used by their original owner.
  #
  # EXPERIMENTAL FEATURE:
  # Please note that enabling this can affect the performance of the server, enable it
  # only if you know what you're doing.
hide-skin: false

  # After you set the skin, this lore will be automatically applied to let everyone
  # know what skin was applied. Set it to "no" to disable ("applied-...-lore: no")
  #
  # [player] -> applier's name, [skin] -> skin name, [nl] -> new line
applied-sword-lore: [nl]&7Sword of <##f9d350>[player][nl]&8→ [skin] Skin
applied-pickaxe-lore: [nl]&7Pickaxe of <##f9d350>[player][nl]&8→ [skin] Skin
applied-axe-lore: [nl]&7Axe of <##f9d350>[player][nl]&8→ [skin] Skin
applied-shovel-lore: [nl]&7Shovel of <##f9d350>[player][nl]&8→ [skin] Skin
applied-hoe-lore: [nl]&7Hoe of <##f9d350>[player][nl]&8→ [skin] Skin


  # Action bar messages shown when players attempt to remove skins from the item:
skin-removed: <##4a730a>✔ <##83ca16>Skin successfully removed from your item.
skin-removed-sound: entity.horse.armor
no-skin: <##850f0f>✘ <##d82625>Your item doesn't have a skin applied.
no-skin-sound: entity.villager.no

  # Shown when the item doesn't support skins.
unsupported: <##850f0f>✘ <##d82625>Can't apply skins to your item.
unsupported-sound: entity.villager.no

Disabling the economy feature:

If you want to disable the economy feature for each skin, you can set the "cost" option to 0. This will automatically remove the price from each skin in the /toolskin menu.

Disabling skin setting on special items:

Certain items may already have their own model/texture on your server. If you want to prevent players from applying Tool Skins to them, you should can add the INT NBT tag "kfx;skin" to "100" for that item {kfx;skin:100}. No need to add this if the item is not of supported material type (a sword, pickaxe, axe, shovel or hoe).

All items containing that NBT tag will be excluded from the skin applying feature.

Per-skin permissions:

The base permission is "toolskin.*" by default. Giving this permission to a player/group will automatically unlock all skins for them.

All default skins have their own permissions as well. For example, if the skin's name is "Tech", the permission to unlock that skin is toolskin.tech, and so on.

GETTING THE SUPPORT

As always, our team is always ready to help. Don't hesitate to open a ticket on our Discord server if you need help setting up or using the configuration.

SETTING UP YOUR SERVER

This page serves as a comprehensive guide to assist you with setting up your SkyPvP server on most hosting platforms (Pterodactyl Panel).

If you use other hostings, such as Pebblehost, please contact them for guides on how to upload server files, or open a ticket on our Discord!

DOWNLOADING SETUP FILES

The initial step is to download the purchased setup, which will be available in a compressed .zip file format.

Download on BuiltByBit or KFX Marketplace.

REQUIREMENTS

• Java version 8 (this can be configured on your server's panel). Later Minecraft versions use Java 12, 17, 21 or higher, but since the setup is made for MC 1.8, you'll have to stick with Java 8.

UPLOADING THE SETUP

Locate the downloaded .zip file on your computer. Open the File manager page of your server host, and delete all existing server files (in case you need to save anything, backup them first).

• After you've deleted everything, upload the setup .ZIP file.

• Click 'Unarchive' to extract all server files from the .ZIP file!

Upon completion of the unarchiving process, start the server and proceed to accept the end-user license agreement. This can be accomplished by accessing the eula.txt file and updating the value from 'false' to 'true'. That's it! ✨

GETTING SUPPORT

As always, our team is always ready to help. Don't hesitate to open a ticket on our Discord server if you need help setting up or using the setup.

PASTING BUILDS

This page will assume you already have FastAsyncWorldEdit or WorldEdit in your server's plugins folder. Other plugins may support importing/pasting .schem(atic) files, too.

ADDING THE BUILD TO WORLDEDIT

Some builds will come in a .schem format file, 1.8-1.12 ones may be in a .schematic format as well.

Open your FastAsyncWorldEdit or WorldEdit folder, there should be a schematics folder (if not, make a new folder and name it 'schematics'). Add your build file to that folder.

LOADING YOUR BUILD

For builds that come in a .schematic format, run the following command on your server:

//schematic load <file name>.schematic

For builds that come in a .schem format (1.13+), run the following command on your server:

//schematic load <file name>.schem

PASTING YOUR BUILD

Pasting is the same for all builds. Navigate to the place in-game where you want to paste your build (the central location of your build will be there), then type the following command:

//paste

You can also type //paste -a to ignore air blocks when pasting, if that's something you want to do.

And that's it, enjoy your new build! ✨

GETTING HELP

As always, our team is always ready to help. Don't hesitate to open a ticket on our Discord server if you need help pasting schematics.