Skript

Skript is a Paper plugin that enables administrators to create unique and inspiring features for their servers. It is simple to use with no prior experience necessary. For those who already know how to write plugins, Skript makes it easy to build prototypes that can later be developed into full plugins. Altogether, Skript is more than capable of creating a feature-rich server experience.

About Skript

Originally released in 2011 on dev.bukkit.org by Njol, Skript has always been about inclusive programming. Skript is an easy-to-use language that provides a path for server admins to easily create unique and inspiring features for their Minecraft server with no prior experience necessary. Today, the project lives on GitHub and is completely community made. With thousands of contributions and community hours poured into continued development, Skript is a very powerful plugin for any server owner.

Unlike other scripting plugins, Skript's syntax is easy to understand and follow. The focus is on simple English sentences that can be written and read by anyone. No odd syntax patterns, line breaks, or difficult setups. Plus, a large, helpful, and rapidly growing community exists to provide you with the support and directions you need.

Features

Skript is packed with useful syntax for building both simple and complex creations.

Natural Syntax
Simple-to-use and easy to understand English sentences power Skript to customize your server.

Custom Commands
Define custom commands to integrate your creations or override existing ones to change their behavior.

Functions
No need to copy and paste. Functions allow you to run the same code over and over again with customizable inputs.

Effective Error Messages
While traditional errors can be harder to understand for beginners, Skript focuses on presenting them as simply as possible. If Skript is unable to fix your error for you, it will report back in clear terms what went wrong.

Extendable
The community continues to build addons that further enhance Skript's capabilities. If Skript cannot do something, it is likely that someone has built as an addon that can.

As an example, it is easy to build a simple home system with Skript:

 command /sethome:
     permission: skript.home # Permission required for this command
     description: Set your home # Description of this command
     executable by: players # Console won't be able to run this command
     trigger: # The actual trigger/code that will run when someone do /sethome
         # Set a unique variable to sender's location
         set {home::%player%} to location of player
         # Send a message to the sender
         message "Set your home to <grey>%location of player%<reset>"
 
 command /home:
     permission: skript.home
     description: Teleport yourself to your home
     trigger:
         # Check if that variable we used in /sethome has been set (in other words, if player ever ran /sethome)
         if {home::%player%} is not set:
             message "<red>You have not set your home yet! Run /sethome first."
             stop trigger # stop the code here, lines below won't run
         # Teleport the player to their home
         teleport player to {home::%player%}
         send "<lime>You have been teleported to your home."

Requirements

Skript requires Paper to work. You heard it right, Spigot does not work.

Skript supports the last 18 months of Minecraft versions, counting from the release date of Skript's newest version.

When new Minecraft versions are released, we will work as quickly as possible to support them. It is worth noting that the latest version of Skript may work fine on new versions, but without support for any new features.

Downloading Skript, Addons and Scripts

Skript
You can download the latest stable version of Skript by clicking the download button above. For pre-releases, see the project's GitHub releases page. As with any plugin, place the downloaded Skript file inside the server's plugins folder. Restart the server, and once it loads, you will be ready to begin.

Addons
Addons follow the same setup as any plugin. Place the downloaded file into the server's plugins folder and restart. Some addons may have different setups or require tweaking. Be sure to review the addon's download page for any installation instructions.

Scripts
Creating a new script is easy. Simply create a new .sk file in Skript's scripts directory. Installing a script works the same way: simply move it to that same scripts directory. Then, you can load the script using /sk reload <file name>.

Having an Issue with Skript?

If you experience unexpected behavior with Skript, you can report it as an issue on our GitHub Repository. Understand that this platform is for bug reports only. If you need help with your scripts, please review the linked resources below.

Resources

Getting Help
Community support is available through the skUnity Discord Server, and the SkriptHub Discord Server. skUnity also hosts tutorials for those new to Skript.

Skript Documentation
Tutorials are available on our documentation site: docs.skriptlang.org. You will also be able to find a list of all syntax Skript has to offer. Community-built documentation is available on skUnity and SkriptHub too.

Addons and Scripts
You can find a wide selection of addons and scripts from multiple community platforms, including skUnity and SkriptHub. As with any plugin or tool that has the ability to modify your server's functionality, take caution in what you install.

Contributing to Skript

Skript is a large project with many parts working together. If you are new to Java, Skript is not the project for you. Due to Skript's size and development history, working on the project demands prior Java experience. It can be useful to familiarize yourself with Skript's codebase by exploring many of the addons that have been built for it (see below). Anyone interesed in contributing should review our contributing guidelines.