Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/skriptlang/skript
Skript is a Bukkit plugin which allows server admins to customize their server easily, but without the hassle of programming a plugin or asking/paying someone to program a plugin for them.
https://github.com/skriptlang/skript
bukkit gradle hacktoberfest java minecraft scripting-language skript spigot
Last synced: 1 day ago
JSON representation
Skript is a Bukkit plugin which allows server admins to customize their server easily, but without the hassle of programming a plugin or asking/paying someone to program a plugin for them.
- Host: GitHub
- URL: https://github.com/skriptlang/skript
- Owner: SkriptLang
- License: gpl-3.0
- Created: 2016-03-08T13:42:04.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-04-15T11:15:37.000Z (5 months ago)
- Last Synced: 2024-04-15T11:57:25.084Z (5 months ago)
- Topics: bukkit, gradle, hacktoberfest, java, minecraft, scripting-language, skript, spigot
- Language: Java
- Homepage: https://docs.skriptlang.org
- Size: 22.3 MB
- Stars: 973
- Watchers: 54
- Forks: 348
- Open Issues: 578
-
Metadata Files:
- Readme: README.md
- Contributing: .github/contributing.md
- License: LICENSE
- Security: security.md
Awesome Lists containing this project
README
---
# Skript
**Skript** is a Minecraft plugin for Paper/Spigot, 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 Skript, and so it can be used
for prototyping etc.
This Github fork of Skript is based on Mirreski's improvements which was built
on Njol's original Skript.
## Requirements
Skript requires **Spigot** to work. You heard it right, **CraftBukkit** does *not* work.
**Paper**, which is a fork of Spigot, is recommended; it is required for some
parts of Skript to be available.
Skript supports only the **latest** patch versions of Minecraft 1.13+.
For example, this means that 1.16.5 is supported, but 1.16.4 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.
## Download
You can find the downloads for each version with their release notes in the [releases page](https://github.com/SkriptLang/Skript/releases).
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](CLOCKWORK_RELEASE_MODEL.md).
## Documentation
Documentation is available [here](https://docs.skriptlang.org/) for the
latest version of Skript.
## Reporting Issues
Please see our [contribution guidelines](https://github.com/SkriptLang/Skript/blob/master/.github/contributing.md)
before reporting issues.
## Help Us Test
Wanting to help test Skript's new features and releases?
You can head on over to our [Official Testing Discord](https://discord.gg/ZPsZAg6ygu), 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 the [Relevant Links](https://github.com/SkriptLang/Skript#relevant-links) section for a list of available resources to assist you.
## A Note About Add-ons
We don't support add-ons here, even though some of Skript developers have also
developed their own add-ons.
## Compiling
Skript uses Gradle for compilation. Use your command prompt of preference and
navigate to Skript's source directory. Then you can just call Gradle to compile
and package Skript for you:
```bash
./gradlew clean build # on UNIX-based systems (mac, linux)
gradlew clean build # on Windows
```
You can get source code from the [releases page](https://github.com/SkriptLang/Skript/releases).
You may also clone this repository, but that code may or may not be stable.
### Compiling Modules
Parts of Skript are provided as Gradle subprojects. They require Skript, so
they are compiled *after* it has been built. For this reason, if you want them
embedded 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 are
only used to provide compatibility with old WorldGuard versions.
### Testing
Skript has some tests written in Skript. Running them requires a Minecraft
server, but our build script will create one for you. Running the tests is easy:
```
./gradlew (quickTest|skriptTest|skriptTestJava11|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.17-1.20.4) runs the tests on Java 17 supported versions.
skriptTestJava11 (1.13-1.16) runs the tests on Java 11 supported versions.
skriptTest runs the tests on all versions.
That is, it runs skriptTestJava11, skriptTestJava17, and skriptTestJava21.
By running the tests, you agree to Mojang's End User License Agreement.
### Importing to Eclipse
With new Eclipse versions, there is integrated Gradle support, and it actually works now.
So, first get latest Eclipse, then import Skript 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. Skript'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.
### Importing to IDEA
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.
### Releasing
```
./gradlew clean build
./gradlew Release
```
Available flavors are github and spigot. Please do not abuse flavors by
compiling your own test builds as releases.
## Contributing
Please review our [contribution guidelines](https://github.com/SkriptLang/Skript/blob/master/.github/contributing.md).
In addition to that, if you are contributing Java code, check our
[coding conventions](https://github.com/SkriptLang/Skript/blob/master/code-conventions.md).
## Maven Repository
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 the **END** of all your repositories. Skript is not available in Maven Central.
```gradle
repositories {
maven {
url 'https://repo.skriptlang.org/releases'
}
}
```
Or, if you use Maven:
```maven
skript-releases
Skript Repository
https://repo.skriptlang.org/releases
```
For versions of Skript after dev37 you might need to add the paper-api repository to prevent build issues.
```gradle
maven {
url 'https://repo.destroystokyo.com/repository/maven-public/'
}
```
Or, if you use Maven:
```maven
destroystokyo-repo
https://repo.destroystokyo.com/content/repositories/snapshots/
```
Then you will also need to add Skript as a dependency.
```gradle
dependencies {
implementation 'com.github.SkriptLang:Skript:[versionTag]'
}
```
An example of the version tag would be ```2.8.5```.
> Note: If Gradle isn't able to resolve Skript's dependencies, just [disable the resolution of transitive dependencies](https://docs.gradle.org/current/userguide/resolution_rules.html#sec:disabling_resolution_transitive_dependencies) for Skript in your project.
Or, if you use Maven:
```
com.github.SkriptLang
Skript
[versionTag]
provided
```
## Relevant Links
* [skUnity forums](https://forums.skunity.com)
* [skUnity addon releases](https://forums.skunity.com/forums/addon-releases)
* [skUnity Discord invite](https://discord.gg/0l3WlzBPKX7WNjkf)
* [Skript Chat Discord invite](https://discord.gg/0lx4QhQvwelCZbEX)
* [Skript Hub](https://skripthub.net)
* [Original Skript at Bukkit](https://dev.bukkit.org/bukkit-plugins/skript) (inactive)
Note that these resources are not maintained by Skript's developers. Don't
contact us about any problems you might have with them.
## Developers
You can find all contributors [here](https://github.com/SkriptLang/Skript/graphs/contributors).
All code is owned by its writer, licensed for others under GPLv3 (see LICENSE)
unless otherwise specified.