{"id":14969437,"url":"https://github.com/essentialsx/essentials","last_synced_at":"2025-05-13T22:04:11.884Z","repository":{"id":30413011,"uuid":"33965866","full_name":"EssentialsX/Essentials","owner":"EssentialsX","description":"The modern Essentials suite for Spigot and Paper.","archived":false,"fork":false,"pushed_at":"2025-04-28T21:49:13.000Z","size":406909,"stargazers_count":2046,"open_issues_count":197,"forks_count":1009,"subscribers_count":66,"default_branch":"2.x","last_synced_at":"2025-04-29T14:19:45.597Z","etag":null,"topics":["bukkit","bukkit-plugin","discord","essential","essentials","essentials-chat","essentials-core","essentials-spawn","essentialsx","hacktoberfest","java","minecraft","minecraft-oss","minecraft-plugin","minecraft-server","moss-discord-community","paper","spigot","spigot-plugin"],"latest_commit_sha":null,"homepage":"https://essentialsx.net","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/EssentialsX.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"patreon":"EssentialsX","github":"EssentialsX","open_collective":"EssentialsX"}},"created_at":"2015-04-15T01:20:08.000Z","updated_at":"2025-04-29T11:39:33.000Z","dependencies_parsed_at":"2023-10-11T06:46:22.489Z","dependency_job_id":"44c8c890-74c2-4d38-ba40-402296c2be9b","html_url":"https://github.com/EssentialsX/Essentials","commit_stats":{"total_commits":5761,"total_committers":305,"mean_commits":"18.888524590163936","dds":0.762020482555112,"last_synced_commit":"f7a8f86850c9c4f9dee9b6120e6da151cbe81ed0"},"previous_names":[],"tags_count":69,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EssentialsX%2FEssentials","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EssentialsX%2FEssentials/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EssentialsX%2FEssentials/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EssentialsX%2FEssentials/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/EssentialsX","download_url":"https://codeload.github.com/EssentialsX/Essentials/tar.gz/refs/heads/2.x","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251516951,"owners_count":21601911,"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","bukkit-plugin","discord","essential","essentials","essentials-chat","essentials-core","essentials-spawn","essentialsx","hacktoberfest","java","minecraft","minecraft-oss","minecraft-plugin","minecraft-server","moss-discord-community","paper","spigot","spigot-plugin"],"created_at":"2024-09-24T13:41:51.399Z","updated_at":"2025-04-29T14:19:51.796Z","avatar_url":"https://github.com/EssentialsX.png","language":"Java","readme":"[![EssentialsX](https://i.imgur.com/CP4SZpB.png)](https://essentialsx.net)\n\n[\u003cimg alt=\"Dev Builds\" src=\"https://img.shields.io/badge/-Download_dev_builds-D24939.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAMAAACdt4HsAAAAdVBMVEVHcEz////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////qLaloAAAAJnRSTlMA/go0+C4DzJ2IHr/rlvBznq9cGClUqdEiQuR74RHcPbdqw15Ykw3WSecAAAENSURBVFjD7ZdJFoIwEERpEgUBRXCe577/EV2ahBi6dKUvf1//BbpoIEn+lsvI4QIKFuywQI9Q2vkrfA0DMvM0wO/C1RSUH9zGqSmYfiDITUEeBVEQBVHw04Jvd+J8Ygom8Fqf7e0Xy7bA8unKfbWtDkh+eOYO5RAQjNkDMIkde9lJ83fyC+gmy580v0Fv8ALYSOrgFgCtQ5pxkCztKUDDPZzDdXj05ZmCdahZQB34tiOJgFq8ALI6rCsWUs19+cORxRxnngGWDOB5tmuG6Iyi0FCedCFZISHGjqBCBZUzQoaxr0HhAmX/HeACe7ekGoyTdhZDgx6gcaagwCPoznZsIYP2PNJqmYlZqiTy4gka59N5SBiJlAAAAABJRU5ErkJggg==\u0026style=flat-square\u0026logoColor=white\" height=32\u003e](https://essentialsx.net/downloads.html)\n\n[\u003cimg alt=\"Discord\" src=\"https://img.shields.io/badge/-Get_help_on_Discord-7289DA.svg?logo=discord\u0026style=flat-square\u0026logoColor=white\" height=32\u003e](https://discord.gg/casfFyh)\n\n[\u003cimg alt=\"Patreon\" src=\"https://img.shields.io/badge/-Support_on_Patreon-F96854.svg?logo=patreon\u0026style=flat-square\u0026logoColor=white\" height=32\u003e](https://www.patreon.com/essentialsx)\n\nThis is a fork of Essentials called EssentialsX.\n\nIf you are using this, do **NOT** ask Essentials for support.\n\nThe official upstream repository for the original Essentials project is at https://github.com/Essentials/Essentials.\n\n\n## Why use EssentialsX?\n\nEssentialsX is a continuation of the Essentials plugin suite, updated to support modern Minecraft and Spigot versions.\n\nIt provides countless new features, performance enhancements and fixes that are not available in the original\nEssentials or Spigot-Essentials. [For more details, see the wiki.](https://essentialsx.net/wiki/Improvements.html)\n\nIf you're coming from the original Essentials plugin, EssentialsX is a drop-in replacement for Essentials. It does,\nhowever, have some new requirements:\n\n* **EssentialsX requires CraftBukkit, Spigot or Paper to run.** Other server software may work, but these are not tested\n  by the team and we may not be able to help with any issues that occur.\n* **EssentialsX currently supports Minecraft versions 1.8.8, 1.9.4, 1.10.2, 1.11.2, 1.12.2, 1.13.2, 1.14.4, 1.15.2, \n  1.16.5, 1.17.1, 1.18.2, 1.19.4, 1.20.6, and 1.21.5.**\n* **EssentialsX currently requires Java 8 or higher.** We recommend using the latest Java version supported by your\n  server software.\n* **EssentialsX requires [Vault](http://dev.bukkit.org/bukkit-plugins/vault/) to enable using chat prefix/suffixes and\n  group support from supported permissions plugins.**\n  - **We recommend using [LuckPerms](https://luckperms.net) for permissions and groups.**\n  - If you have an unsupported permissions plugin but still want to use wildcards, **enable `use-bukkit-permissions` in\n    the configuration.** Otherwise, the plugin will fall back to config-based permissions.\n\n\n## Support\n\nNeed help with using EssentialsX? Join the [MOSS Discord community](https://discord.gg/casfFyh) to ask for help and discuss EssentialsX.\n\nIf you need to report a bug or want to suggest a new feature, you can [open an issue on GitHub](https://github.com/EssentialsX/Essentials/issues/new/choose).\n\n\n## Building\n\nTo build EssentialsX, you need JDK 8 or higher installed on your system.\n\nClone this repository, then run the following command:\n\n* On Linux or macOS: `./gradlew build`\n* On Windows: `gradlew build`\n\nYou can then find builds of EssentialsX modules in the `jars/` directory.\n\n### Running a test server\n\nYou can also run a test server from your development environment using the following command:\n\n* On Linux or macOS: `./gradlew build :runServer`\n* On Windows: `gradlew build :runServer`\n\nNote the `:` - without it, you will run several servers at once, which will likely crash Gradle.\n\n\n## Using EssentialsX in your plugin\n\nDo you want to integrate with EssentialsX in your plugin? You can build your plugin against the **EssentialsX API**,\navailable from the EssentialsX Maven repo.\n\nReleases are hosted on the Maven repo at `https://repo.essentialsx.net/releases/`, while snapshots (including dev\nbuilds) are hosted at `https://repo.essentialsx.net/snapshots/`.\n\nTo add EssentialsX to your build system, you should use the following artifacts:\n\n| Type           | Group ID          | Artifact ID   | Version           |\n|:---------------|:------------------|:--------------|:------------------|\n| Latest release | `net.essentialsx` | `EssentialsX` | `2.21.0`          |\n| Snapshots      | `net.essentialsx` | `EssentialsX` | `2.21.1-SNAPSHOT` |\n| Older releases | `net.ess3`        | `EssentialsX` | `2.18.2`          |\n\nNote: until version `2.18.2`, EssentialsX used the `net.ess3` group ID.  \nFrom `2.19.0` onwards, EssentialsX uses the `net.essentialsx` group ID.  \nWhen updating your plugin, make sure you use the correct group ID.\n\nYou can find more information, including Maven and Gradle examples, at the\n[wiki](https://essentialsx.net/wiki/Common-Issues.html#how-do-i-add-essentialsx-as-a-dependency).\n\n## Support the EssentialsX project\n\nWant to help improve EssentialsX? There are several ways you can support and contribute to the project.\n\n### Donate to EssentialsX\n\nDonations allow us to cover the costs of our infrastructure, and also enable us to keep updating EssentialsX with new\nfeatures and for new Minecraft versions.\n\nYou can support us with a one-off or monthly donation via [GitHub Sponsors](https://github.com/sponsors/EssentialsX),\nand you'll get a badge on GitHub for supporting the project through this.\n\nAlternatively, you can also donate monthly to the EssentialsX project on [Patreon](https://www.patreon.com/essentialsx/),\nor you can make a one-off donation on our [Ko-fi page](https://ko-fi.com/essentialsx).\n\nIf you can't make a donation, don't worry! There are lots of other ways to contribute:\n\n### Contributing directly to EssentialsX\n\n* Are you a developer? We're always happy to receive bug fixes and feature additions as pull requests.\n* Do you speak multiple languages? If so, we always welcome contributions to our community translations.\n  [Crowdin project](https://crowdin.com/project/essentialsx-official).\n\nSee [CONTRIBUTING.md](https://github.com/EssentialsX/Essentials/blob/2.x/CONTRIBUTING.md) to find out more.\n\n### Providing support to other users\n\n* Do you run a server? Take a look at our\n  [\"help wanted\"](https://github.com/EssentialsX/Essentials/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22help+wanted%22)\n  and [\"bug: unconfirmed\"](https://github.com/EssentialsX/Essentials/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22bug%3A+unconfirmed%22)\n  issues, where you can find issues that need extra testing and investigation.\n* Do you want to help others set up EssentialsX? You can contribute to the\n  [EssentialsX docs](https://github.com/EssentialsX/wiki). You can also join the\n  [MOSS Discord community](https://discord.gg/casfFyh) and provide direct community support to other EssentialsX users.\n","funding_links":["https://patreon.com/EssentialsX","https://github.com/sponsors/EssentialsX","https://opencollective.com/EssentialsX","https://www.patreon.com/essentialsx","https://www.patreon.com/essentialsx/","https://ko-fi.com/essentialsx"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fessentialsx%2Fessentials","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fessentialsx%2Fessentials","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fessentialsx%2Fessentials/lists"}