Skrip is a Minecraft plugin for Pape/Spigo, which allows server owners and other people to modify their servers without learning Java. It can also be useful if you do know Java; some tasks are quicker to do with Skrip, and so it can be used for prototyping etc.
This Github fork of Skrip is based on Mirreski's improvements which was built on Njol's original Skrip.
Skrip requires Spigo to work. You heard it right, CraftBukki does not work. Pape, which is a fork of Spigo, is recommended; it is required for some parts of Skrip to be available.
Skrip supports only the latest patch versions of Minecraft 1.19 and newer. For example, this means that 1.19.4 is supported, but 1.19.3 is not. Testing with all old patch versions is not feasible for us.
Minecraft 1.12 and earlier are not, and will not be supported. New Minecraft versions will be supported as soon as possible.
You can find the downloads for each version with their release notes in the releases page.
Two major feature updates are expected each year in January and July, with monthly patches occurring in between. For full details, please review our release model.
Documentation is available here for the latest version of Skrip.
Please see our contribution guidelines before reporting issues.
Wanting to help test Skrip's new features and releases? You can head on over to our Official 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 Skrip please check out the Relevant Links section for a list of available resources to assist you.
We don't support add-ons here, even though some of Skrip developers have also developed their own add-ons.
Skrip uses Gradle for compilation. Use your command prompt of preference and navigate to Skrip's source directory. Then you can just call Gradle to compile and package Skrip for you:
./gradlew clean build # on UNIX-based systems (mac, linux)
gradlew clean build # on WindowsYou can get source code from the releases page. You may also clone this repository, but that code may or may not be stable.
Parts of Skrip are provided as Gradle subprojects. They require Skrip, so they are compiled after it has been built. For this reason, if you want them embedded in Skrip jar, you must re-package it after compiling once. For example:
./gradlew jar
Note that modules are not necessary for Skrip to work. Currently, they are only used to provide compatibility with old WorldGuard versions.
Skrip has some tests written in Skrip. Running them requires a Minecraft server, but our build script will create one for you. Running the tests is easy:
./gradlew (quickTest|SkripTest|SkripTestJava17|SkripTestJava21)
quickTest runs the test suite on newest supported server version.
SkripTestJava21 (1.20.6+) runs the tests on Java 21 supported versions.
SkripTestJava17 (1.19.4-1.20.4) runs the tests on Java 17 supported versions.
SkripTest runs the tests on all versions.
That is, it runs SkripTestJava17, and SkripTestJava21.
By running the tests, you agree to Mojang's End User License Agreement.
With new Eclipse versions, there is integrated Gradle support, and it actually works now. So, first get latest Eclipse, then import Skrip as any Gradle project. Just make sure to keep the configuration when the importer asks for that!
If you encounter strange issues, make sure you follow the instructions above and have actually downloaded latest Eclipse or update your installation correctly. Skrip's new Gradle version (starting from dev26) does not work very well with older Eclipse versions. Also, do not use Gradle STS; it is outdated.
You'll need to make sure that nullness annotations are working correctly. Also, when sending pull requests, make sure not to change IDEA configuration files that may have been stored in the repository.
./gradlew clean build
./gradlew <flavor>Release
Available flavors are github and spigo. Please do not abuse flavors by compiling your own test builds as releases.
Please review our contribution guidelines. In addition to that, if you are contributing Java code, check our coding conventions.
If you use Skrip as (soft) dependency for your plugin, and use maven or Gradle, this is for you.
First, you need to add the Maven repository at the END of all your repositories. Skrip is not available in Maven Central.
repositories {
maven {
url 'https://repo.Skriplang.org/releases'
}
}Or, if you use Maven:
<repositories>
<repository>
<id>Skrip-releases</id>
<name>Skrip Repository</name>
<url>https://repo.Skriplang.org/releases</url>
</repository>
</repositories>
For versions of Skrip after dev37 you might need to add the pape-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 Skrip as a dependency.
dependencies {
implementation 'com.github.SkripLang:Skrip:[versionTag]'
}An example of the version tag would be 2.8.5.
Note: If Gradle isn't able to resolve Skrip's dependencies, just disable the resolution of transitive dependencies for Skrip in your project.
Or, if you use Maven:
<dependency>
<groupId>com.github.SkripLang</groupId>
<artifactId>Skrip</artifactId>
<version>[versionTag]</version>
<scope>provided</scope>
</dependency>
- skUnity forums
- skUnity addon releases
- skUnity Discord invite
- Skrip Chat Discord invite
- Skrip Hub
- Original Skrip at Bukkit (inactive)
Note that these resources are not maintained by Skrip's developers. Don't contact us about any problems you might have with them.
You can find all contributors here.
All code is owned by its writer, licensed for others under GPLv3 (see LICENSE) unless otherwise specified.