{"id":16329255,"url":"https://github.com/josantonius/minecraft-whitelist","last_synced_at":"2025-05-15T08:33:55.875Z","repository":{"id":165747658,"uuid":"640104023","full_name":"josantonius/minecraft-whitelist","owner":"josantonius","description":"A basic whitelist plugin based on player nicknames only","archived":false,"fork":false,"pushed_at":"2023-05-15T22:52:07.000Z","size":2248,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-17T10:13:17.411Z","etag":null,"topics":["minecraft","minecraft-plugin","minecraft-whitelist","whitelist"],"latest_commit_sha":null,"homepage":"https://josantonius.dev","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/josantonius.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","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},"funding":{"github":["Josantonius"]}},"created_at":"2023-05-13T02:27:37.000Z","updated_at":"2024-08-28T16:23:36.000Z","dependencies_parsed_at":null,"dependency_job_id":"a302ec4b-1e38-40e6-8e07-18d2acb8ae4b","html_url":"https://github.com/josantonius/minecraft-whitelist","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/josantonius%2Fminecraft-whitelist","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/josantonius%2Fminecraft-whitelist/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/josantonius%2Fminecraft-whitelist/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/josantonius%2Fminecraft-whitelist/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/josantonius","download_url":"https://codeload.github.com/josantonius/minecraft-whitelist/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254304768,"owners_count":22048462,"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":["minecraft","minecraft-plugin","minecraft-whitelist","whitelist"],"created_at":"2024-10-10T23:14:56.432Z","updated_at":"2025-05-15T08:33:55.838Z","avatar_url":"https://github.com/josantonius.png","language":"Kotlin","funding_links":["https://github.com/sponsors/Josantonius"],"categories":[],"sub_categories":[],"readme":"# Minecraft PvP Plugin\n\n[![License](https://img.shields.io/github/license/josantonius/minecraft-whitelist)](LICENSE)\n\nA basic whitelist plugin based on player nicknames only.\n\n## [Watch demo on YouTube](https://www.youtube.com/watch?v=LRzij_6m5wE)\n\n## Requirements\n\n- Java 17 or higher.\n- Purpur server 1.19.3 or Bukkit/Spigot/Paper server compatible with the Purpur API version used.\n\n## Installation\n\n1. Download the JAR file: [whitelist-1.0.0-purpur-1.19.3.jar](/build/libs/whitelist-1.0.0-purpur-1.19.3.jar).\n\n1. Place the JAR file in the plugins folder of your Minecraft server.\n\n1. Restart the server to load the plugin.\n\n## Building\n\nTo build the plugin yourself, follow these steps:\n\n1. Make sure you have `Java 17` or higher and `Gradle` installed on your system.\n\n1. Clone the plugin repository on your local machine:\n\n    ```bash\n    git clone https://github.com/josantonius/minecraft-whitelist.git\n    ```\n\n1. Navigate to the directory of the cloned repository:\n\n    ```bash\n    cd minecraft-whitelist\n    ```\n\n1. Use Gradle to compile the plugin:\n\n    ```bash\n    gradle build\n    ```\n\n## Commands\n\n- `/wl on` - Enable whitelist\n\n- `/wl off` - Disable whitelist\n\n- `/wl add \u003cplayer\u003e` - Add player to whitelist\n\n- `/wl remove \u003cplayer\u003e` - Remove player from whitelist\n\n- `/wl info \u003cplayer\u003e` - Check if player is on the whitelist\n\n- `/wl help` - Show help\n\n- `/wl reload` - Reload the plugin\n\nAll commands requires the `wl.admin` permission to be used.\n\n## Configuration\n\nThe `plugins/Whitelist/config.yml` file contains specific plugin configurations.\n\n### Enable or disable the whitelist\n\nIf enabled, only players on the whitelist will be able to join the server. If disabled,\nall players will be able to join the server.\n\n```yaml\nenabled: true\n```\n\n### Exclude ops from the whitelist\n\nIf enabled, ops will be able to join the server even if they are not on the whitelist.\nIf disabled, ops will not be able to join the server if they are not on the whitelist.\n\n```yaml\nexcludeOps: true\n```\n\n### Kick players who are not on the whitelist\n\nIf enabled, players who are not on the whitelist will be kicked from the server when use\nthe command `/wl on` or `wl del \u003cplayer\u003e`.\n\n```yaml\nnotifyOps: true\n```\n\n### Notify ops when a player tries to connect to the server and is not on the whitelist\n\n```yaml\nnotifyOps: true\n```\n\n## Messages\n\nThe `plugins/Whitelist/messages.yml` file contains all the messages that the plugin uses.\nYou can change the messages to your liking.\n\n## TODO\n\n- [ ] Add new feature\n- [ ] Create tests\n- [ ] Improve documentation\n\n## Changelog\n\nDetailed changes for each release are documented in the\n[release notes](https://github.com/josantonius/minecraft-whitelist/releases).\n\n## Contribution\n\nPlease make sure to read the [Contributing Guide](.github/CONTRIBUTING.md), before making a pull\nrequest, start a discussion or report a issue.\n\nThanks to all [contributors](https://github.com/josantonius/minecraft-whitelist/graphs/contributors)! :heart:\n\n## Sponsor\n\nIf this project helps you to reduce your development time,\n[you can sponsor me](https://github.com/josantonius#sponsor) to support my open source work :blush:\n\n## License\n\nThis repository is licensed under the [MIT License](LICENSE).\n\nCopyright © 2023-present, [Josantonius](https://github.com/josantonius#contact)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjosantonius%2Fminecraft-whitelist","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjosantonius%2Fminecraft-whitelist","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjosantonius%2Fminecraft-whitelist/lists"}