{"id":20791553,"url":"https://github.com/bspfsystems/pluginevents","last_synced_at":"2025-08-16T17:04:30.058Z","repository":{"id":177459050,"uuid":"376299292","full_name":"bspfsystems/PluginEvents","owner":"bspfsystems","description":"An event handler for subscribing to custom events for plugins that do not have dependencies on Bukkit or BungeeCord.","archived":false,"fork":false,"pushed_at":"2022-08-19T13:44:17.000Z","size":38,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-16T17:02:48.619Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bspfsystems.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"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}},"created_at":"2021-06-12T13:41:19.000Z","updated_at":"2022-05-03T04:05:52.000Z","dependencies_parsed_at":null,"dependency_job_id":"dfb101d9-2488-4537-bbf4-defe7f76c41e","html_url":"https://github.com/bspfsystems/PluginEvents","commit_stats":null,"previous_names":["bspfsystems/pluginevents"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/bspfsystems/PluginEvents","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bspfsystems%2FPluginEvents","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bspfsystems%2FPluginEvents/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bspfsystems%2FPluginEvents/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bspfsystems%2FPluginEvents/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bspfsystems","download_url":"https://codeload.github.com/bspfsystems/PluginEvents/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bspfsystems%2FPluginEvents/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270742043,"owners_count":24637504,"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","status":"online","status_checked_at":"2025-08-16T02:00:11.002Z","response_time":91,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-11-17T15:45:30.661Z","updated_at":"2025-08-16T17:04:30.015Z","avatar_url":"https://github.com/bspfsystems.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PluginEvents Project\n\nAn event handler for subscribing to custom events for plugins that do not have dependencies on Bukkit or BungeeCord. Specifically, this library is used when a Bukkit and/or BungeeCord project has a core module that has no interactions with the Bukkit and/or BungeeCord API(s). Events can still be passed from project core to project core, all without relying on unnecessary APIs.\n\n## Obtaining PluginEvents\n\nYou can obtain a copy of PluginEvents via the following methods:\n- Download a pre-built copy from the [Releases page](https://github.com/bspfsystems/PluginEvents/releases/latest/). The latest version is 0.3.0-SNAPSHOT.\n- Build from source (see below).\n- Include it as a dependency in your project (see the Development API section).\n\n### Build from Source\n\nPluginEvents uses [Apache Maven](https://maven.apache.org/) to build and handle dependencies.\n\n#### Requirements\n\n- Java Development Kit (JDK) 8 or higher\n- Git\n- Apache Maven\n\n#### Compile / Build\n\nRun the following commands to build the library `.jar` file:\n```\ngit clone https://github.com/bspfsystems/PluginEvents.git\ncd PluginEvents/\nmvn clean install\n```\n\nThe `.jar` file will be located in the `target/` folder.\n\n## Developer API\n\n### Add PluginEvents as a Dependency\n\nTo add PluginEvents as a dependency to your project, use one of the following common methods (you may use others that exist, these are the common ones):\n\n_**PLEASE NOTE:** PluginEvents is in the initial buildout stage. PluginEvent's API artifacts only exist in the `snapshots/` repositories at this time. When an initial release has been made, the repository will switch to `releases/`. Please be sure to update your code to reflect this status._\n\n**Maven:**\u003cbr /\u003e\nInclude the following in your `pom.xml` file:\u003cbr /\u003e\n```\n\u003crepositories\u003e\n    \u003crepository\u003e\n        \u003cid\u003esonatype-repo\u003c/id\u003e\n        \u003curl\u003ehttps://oss.sonatype.org/content/repositories/snapshots/\u003c/url\u003e\n    \u003c/repository\u003e\n\u003c/repositories\u003e\n\n\u003cdependencies\u003e\n    \u003cdependency\u003e\n        \u003cgroupId\u003eorg.bspfsystems\u003c/groupId\u003e\n        \u003cartifactId\u003epluginevents\u003c/artifactId\u003e\n        \u003cversion\u003e0.3.0-SNAPSHOT\u003c/version\u003e\n        \u003cscope\u003ecompile\u003c/scope\u003e\n    \u003c/dependency\u003e\n\u003c/dependencies\u003e\n```\n\n**Gradle:**\u003cbr /\u003e\nInclude the following in your `build.gradle` file:\u003cbr /\u003e\n```\nrepositories {\n    maven {\n        url \"https://oss.sonatype.org/content/repositories/snapshots/\"\n    }\n}\n\ndependencies {\n    implementation \"org.bspfsystems:pluginevents:0.3.0-SNAPSHOT\"\n}\n```\n\n### API Examples\n\nThese are some basic usages of PluginEvents; for a full scope of what the library offers, please see the Javadocs section below.\n```\n// Create a custom Event for a plugin\npublic class PluginStartEvent extends Event {\n    \n    private final String pluginName;\n    \n    public PluginStartEvent(String pluginName) {\n        this.pluginName = pluginName;\n    }\n    \n    public String getPluginName() {\n        return this.pluginName;\n    }\n}\n\n////////////////////////////////////////////////////////////////\n\n// Create a custom EventHandler for the Event\npublic class PluginStartEventListener implements EventListener {\n    \n    @EventHandler(priority = EventPriority.NORMAL)\n    public void onPluginStartEvent(PluginStartEvent event) {\n        System.out.println(\"Plugin \" + event.getPluginName() + \" is starting.\");\n    }\n}\n\n////////////////////////////////////////////////////////////////\n\n// Register the EventHandler with the EventBus\nLogger listenerLogger = Logger.getLogger(\"PluginStartEventListener\");\nEventBus eventBus = EventBus.getInstance();\n\neventBus.registerListener(new PluginStartEventListener(), listenerLogger);\n\n// Call the event\neventBus.callEvent(new PluginStartEvent(\"ExamplePlugin\"));\n```\n\n### Javadocs\n\nThe API Javadocs can be found [here](https://bspfsystems.org/docs/pluginevents/), kindly hosted by [javadoc.io](https://javadoc.io).\n\n## Contributing, Support, and Issues\n\nPlease check out [CONTRIBUTING.md](CONTRIBUTING.md) for more information.\n\n## Licensing\n\nPluginEvents uses the following licenses:\n- [The Apache License, Version 2.0](https://apache.org/licenses/LICENSE-2.0.html)\n\n### Contributions \u0026 Licensing\n\nContributions to the project will remain licensed under the respective license, as defined by the particular license. Copyright/ownership of the contributions shall be governed by the license. The use of an open source license in the hopes that contributions to the project will have better clarity on legal rights of those contributions.\n\n_Please Note: This is not legal advice. If you are unsure on what your rights are, please consult a lawyer._\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbspfsystems%2Fpluginevents","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbspfsystems%2Fpluginevents","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbspfsystems%2Fpluginevents/lists"}