{"id":14969443,"url":"https://github.com/skriptlang/skript","last_synced_at":"2025-05-14T10:08:53.103Z","repository":{"id":37251684,"uuid":"53415151","full_name":"SkriptLang/Skript","owner":"SkriptLang","description":"Skript is a Spigot 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.","archived":false,"fork":false,"pushed_at":"2025-04-09T16:21:39.000Z","size":26769,"stargazers_count":1142,"open_issues_count":564,"forks_count":384,"subscribers_count":53,"default_branch":"master","last_synced_at":"2025-04-09T16:48:27.244Z","etag":null,"topics":["bukkit","gradle","hacktoberfest","java","minecraft","scripting-language","skript","spigot"],"latest_commit_sha":null,"homepage":"https://docs.skriptlang.org","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SkriptLang.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/contributing.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"security.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"SkriptLang","open_collective":"SkriptLang"}},"created_at":"2016-03-08T13:42:04.000Z","updated_at":"2025-04-09T15:56:53.000Z","dependencies_parsed_at":"2024-04-17T13:04:32.462Z","dependency_job_id":"a2157c49-ad77-4795-95c5-f8dc85af7f50","html_url":"https://github.com/SkriptLang/Skript","commit_stats":{"total_commits":3361,"total_committers":145,"mean_commits":"23.179310344827588","dds":0.8327878607557275,"last_synced_commit":"d82667540e5b8381456d87df0a6485c03517bddf"},"previous_names":[],"tags_count":170,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SkriptLang%2FSkript","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SkriptLang%2FSkript/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SkriptLang%2FSkript/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SkriptLang%2FSkript/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SkriptLang","download_url":"https://codeload.github.com/SkriptLang/Skript/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248340191,"owners_count":21087409,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bukkit","gradle","hacktoberfest","java","minecraft","scripting-language","skript","spigot"],"created_at":"2024-09-24T13:41:52.026Z","updated_at":"2025-04-11T04:21:00.112Z","avatar_url":"https://github.com/SkriptLang.png","language":"Java","readme":"![Skript Language](.github/assets/Cover.jpg)\n\n---\n\n# Skript\n**Skript** is a Minecraft plugin for Paper/Spigot, which allows server owners and other people\nto modify their servers without learning Java. It can also be useful if you\n*do* know Java; some tasks are quicker to do with Skript, and so it can be used\nfor prototyping etc.\n\nThis Github fork of Skript is based on Mirreski's improvements which was built\non Njol's original Skript.\n\n## Requirements\nSkript requires **Spigot** to work. You heard it right, **CraftBukkit** does *not* work.\n**Paper**, which is a fork of Spigot, is recommended; it is required for some\nparts of Skript to be available.\n\nSkript supports only the **latest** patch versions of Minecraft 1.19 and newer.\nFor example, this means that 1.19.4 is supported, but 1.19.3 is *not*.\nTesting with all old patch versions is not feasible for us.\n\nMinecraft 1.12 and earlier are not, and will not be supported. New Minecraft\nversions will be supported as soon as possible.\n\n## Download\nYou can find the downloads for each version with their release notes in the [releases page](https://github.com/SkriptLang/Skript/releases).\n\nTwo 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).\n\n## Documentation\nDocumentation is available [here](https://docs.skriptlang.org/) for the\nlatest version of Skript.\n\n## Reporting Issues\nPlease see our [contribution guidelines](https://github.com/SkriptLang/Skript/blob/master/.github/contributing.md)\nbefore reporting issues.\n\n## Help Us Test\nWanting to help test Skript's new features and releases?\nYou 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.\n\nPlease note this is not a help Discord.\nIf 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.\n\n## A Note About Add-ons\nWe don't support add-ons here, even though some of Skript developers have also\ndeveloped their own add-ons.\n\n## Compiling\nSkript uses Gradle for compilation. Use your command prompt of preference and\nnavigate to Skript's source directory. Then you can just call Gradle to compile\nand package Skript for you:\n\n```bash\n./gradlew clean build # on UNIX-based systems (mac, linux)\ngradlew clean build # on Windows\n```\n\nYou can get source code from the [releases page](https://github.com/SkriptLang/Skript/releases).\nYou may also clone this repository, but that code may or may not be stable.\n\n### Compiling Modules\nParts of Skript are provided as Gradle subprojects. They require Skript, so\nthey are compiled *after* it has been built. For this reason, if you want them\nembedded in Skript jar, you must re-package it after compiling once. For example:\n\n```\n./gradlew jar\n```\n\nNote that modules are not necessary for Skript to work. Currently, they are\nonly used to provide compatibility with old WorldGuard versions.\n\n### Testing\nSkript has some tests written in Skript. Running them requires a Minecraft\nserver, but our build script will create one for you. Running the tests is easy:\n\n```\n./gradlew (quickTest|skriptTest|skriptTestJava17|skriptTestJava21)\n```\n\n\u003ccode\u003equickTest\u003c/code\u003e runs the test suite on newest supported server version.\n\u003ccode\u003eskriptTestJava21\u003c/code\u003e (1.20.6+) runs the tests on Java 21 supported versions.\n\u003ccode\u003eskriptTestJava17\u003c/code\u003e (1.19.4-1.20.4) runs the tests on Java 17 supported versions.\n\u003ccode\u003eskriptTest\u003c/code\u003e runs the tests on all versions.\nThat is, it runs skriptTestJava17, and skriptTestJava21.\n\nBy running the tests, you agree to Mojang's End User License Agreement.\n\n### Importing to Eclipse\nWith new Eclipse versions, there is integrated Gradle support, and it actually works now.\nSo, first get latest Eclipse, then import Skript as any Gradle project. Just\nmake sure to **keep** the configuration when the importer asks for that!\n\nIf you encounter strange issues, make sure you follow the instructions above and have\nactually downloaded latest Eclipse or update your installation correctly. Skript's\nnew Gradle version (starting from dev26) does not work very well with older Eclipse\nversions. Also, do *not* use Gradle STS; it is outdated.\n\n### Importing to IDEA\nYou'll need to make sure that nullness annotations are working correctly. Also,\nwhen sending pull requests, make sure not to change IDEA configuration files\nthat may have been stored in the repository.\n\n### Releasing\n```\n./gradlew clean build\n./gradlew \u003cflavor\u003eRelease\n```\nAvailable flavors are github and spigot. Please do not abuse flavors by\ncompiling your own test builds as releases.\n\n## Contributing\nPlease review our [contribution guidelines](https://github.com/SkriptLang/Skript/blob/master/.github/contributing.md).\nIn addition to that, if you are contributing Java code, check our\n[coding conventions](https://github.com/SkriptLang/Skript/blob/master/code-conventions.md).\n\n## Maven Repository\nIf you use Skript as (soft) dependency for your plugin, and use maven or Gradle,\nthis is for you.\n\nFirst, you need to add the Maven repository at the **END** of all your repositories. Skript is not available in Maven Central.\n```gradle\nrepositories {\n    maven {\n        url 'https://repo.skriptlang.org/releases'\n    }\n}\n```\n\nOr, if you use Maven:\n```maven\n\u003crepositories\u003e\n    \u003crepository\u003e\n        \u003cid\u003eskript-releases\u003c/id\u003e\n        \u003cname\u003eSkript Repository\u003c/name\u003e\n        \u003curl\u003ehttps://repo.skriptlang.org/releases\u003c/url\u003e\n    \u003c/repository\u003e\n\u003c/repositories\u003e\n```\n\nFor versions of Skript after dev37 you might need to add the paper-api repository to prevent build issues.\n\n```gradle\nmaven {\n    url 'https://repo.destroystokyo.com/repository/maven-public/'\n}\n```\n\nOr, if you use Maven:\n```maven\n\u003crepository\u003e\n    \u003cid\u003edestroystokyo-repo\u003c/id\u003e\n    \u003curl\u003ehttps://repo.destroystokyo.com/content/repositories/snapshots/\u003c/url\u003e\n\u003c/repository\u003e\n```\n\nThen you will also need to add Skript as a dependency.\n```gradle\ndependencies {\n    implementation 'com.github.SkriptLang:Skript:[versionTag]'\n}\n```\n\nAn example of the version tag would be ```2.8.5```.\n\n\u003e 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.\n\nOr, if you use Maven:\n```\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.github.SkriptLang\u003c/groupId\u003e\n    \u003cartifactId\u003eSkript\u003c/artifactId\u003e\n    \u003cversion\u003e[versionTag]\u003c/version\u003e\n    \u003cscope\u003eprovided\u003c/scope\u003e\n\u003c/dependency\u003e\n```\n\n## Relevant Links\n* [skUnity forums](https://forums.skunity.com)\n* [skUnity addon releases](https://forums.skunity.com/forums/addon-releases)\n* [skUnity Discord invite](https://discord.gg/0l3WlzBPKX7WNjkf)\n* [Skript Chat Discord invite](https://discord.gg/0lx4QhQvwelCZbEX)\n* [Skript Hub](https://skripthub.net)\n* [Original Skript at Bukkit](https://dev.bukkit.org/bukkit-plugins/skript) (inactive)\n\nNote that these resources are not maintained by Skript's developers. Don't\ncontact us about any problems you might have with them.\n\n## Developers\nYou can find all contributors [here](https://github.com/SkriptLang/Skript/graphs/contributors).\n\nAll code is owned by its writer, licensed for others under GPLv3 (see LICENSE)\nunless otherwise specified.\n","funding_links":["https://github.com/sponsors/SkriptLang","https://opencollective.com/SkriptLang"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskriptlang%2Fskript","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fskriptlang%2Fskript","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskriptlang%2Fskript/lists"}