Repository files navigation

Skript is a Minecraft plugin for Paper, which allows server owners and other peopleto modify their servers without learning Java. It can also be useful if youdo know Java; some tasks are quicker to do with Skript, and so it can be usedfor prototyping etc.

This Github fork of Skript is based on Mirreski's improvements which was builton Njol's original Skript.

Skript requiresPaper to work. You heard it right,Spigot doesnot work.

Skript supports the last 18 months of Minecraft versions, counting from the release date of Skript's newest version.For example, this means that 1.20.4 is supported, but 1.20.3 isnot.

New Minecraft versions will be supported as soon as possible.

You can find the downloads for each version with their release notes in thereleases page.

Two major feature updates are expected each year in January and July, with monthly patches occurring in between. For full details, please review ourrelease model.

Documentation is availablehere for thelatest version of Skript.

Please see ourcontribution guidelinesbefore reporting issues.

Wanting to help test Skript's new features and releases?You can head on over to ourOfficial Testing Discord, and whenever we start testing new features/releases you will be the first to know.

Please note this is not a help Discord.If you require assistance with how to use Skript please check out theRelevant Links section for a list of available resources to assist you.

We don't support add-ons here, even though some of Skript developers have alsodeveloped their own add-ons.

Skript uses Gradle for compilation. Use your command prompt of preference andnavigate to Skript's source directory. Then you can just call Gradle to compileand package Skript for you:

./gradlew clean build# on UNIX-based systems (mac, linux)gradlew clean build# on Windows

You can get source code from thereleases page.You may also clone this repository, but that code may or may not be stable.

Parts of Skript are provided as Gradle subprojects. They require Skript, sothey are compiledafter it has been built. For this reason, if you want themembedded in Skript jar, you must re-package it after compiling once. For example:

./gradlew jar

Note that modules are not necessary for Skript to work. Currently, they areonly used to provide compatibility with old WorldGuard versions.

Skript has some tests written in Skript. Running them requires a Minecraftserver, but our build script will create one for you. Running the tests is easy:

./gradlew (quickTest|skriptTest|skriptTestJava17|skriptTestJava21)

quickTest runs the test suite on newest supported server version.skriptTestJava21 (1.20.6+) runs the tests on Java 21 supported versions.skriptTestJava17 (1.20.4) runs the tests on Java 17 supported versions.skriptTest runs the tests on all versions.That is, it runs skriptTestJava17, and skriptTestJava21.

By running the tests, you agree to Mojang's End User License Agreement.

./gradlew clean build./gradlew <flavor>Release

Available flavors are github and spigot. Please do not abuse flavors bycompiling your own test builds as releases.

Please review ourcontribution guidelines.In addition to that, if you are contributing Java code, check ourcoding conventions.

If you use Skript as (soft) dependency for your plugin, and use maven or Gradle,this is for you.

First, you need to add the Maven repository at theEND of all your repositories. Skript is not available in Maven Central.

repositories {    maven {        url'https://repo.skriptlang.org/releases'    }}

Or, if you use Maven:

<repositories>    <repository>        <id>skript-releases</id>        <name>Skript Repository</name>        <url>https://repo.skriptlang.org/releases</url>    </repository></repositories>

For versions of Skript after dev37 you might need to add the paper-api repository to prevent build issues.

maven {    url'https://repo.destroystokyo.com/repository/maven-public/'}

Or, if you use Maven:

<repository>    <id>destroystokyo-repo</id>    <url>https://repo.destroystokyo.com/content/repositories/snapshots/</url></repository>

Then you will also need to add Skript as a dependency.

dependencies {    implementation'com.github.SkriptLang:Skript:[versionTag]'}

An example of the version tag would be2.8.5.

Note: If Gradle isn't able to resolve Skript's dependencies, justdisable the resolution of transitive dependencies for Skript in your project.

Or, if you use Maven:

<dependency>    <groupId>com.github.SkriptLang</groupId>    <artifactId>Skript</artifactId>    <version>[versionTag]</version>    <scope>provided</scope></dependency>

• skUnity forums
• skUnity addon releases
• skUnity Discord invite
• Skript Chat Discord invite
• Skript Hub
• Original Skript at Bukkit (inactive)

Note that these resources are not maintained by Skript's developers. Don'tcontact us about any problems you might have with them.

You can find all contributorshere.

All code is owned by its writer, licensed for others under GPLv3 (seeLICENSE).Some contributors may choose to release their code under the MIT License.Further information can be found withinLICENSING.md.