{"id":28200997,"url":"https://github.com/rfresh2/zenithproxyexampleplugin","last_synced_at":"2025-06-12T18:32:14.118Z","repository":{"id":292772713,"uuid":"937808534","full_name":"rfresh2/ZenithProxyExamplePlugin","owner":"rfresh2","description":"Example Java Plugin for ZenithProxy","archived":false,"fork":false,"pushed_at":"2025-05-30T23:24:15.000Z","size":95,"stargazers_count":6,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"1.21.0","last_synced_at":"2025-06-05T09:42:15.572Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rfresh2.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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,"zenodo":null}},"created_at":"2025-02-23T23:34:12.000Z","updated_at":"2025-05-30T23:24:18.000Z","dependencies_parsed_at":null,"dependency_job_id":"c96b2d7e-55de-48d7-9552-3fe2ebf87f40","html_url":"https://github.com/rfresh2/ZenithProxyExamplePlugin","commit_stats":null,"previous_names":["rfresh2/zenithproxyexampleplugin"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/rfresh2/ZenithProxyExamplePlugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rfresh2%2FZenithProxyExamplePlugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rfresh2%2FZenithProxyExamplePlugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rfresh2%2FZenithProxyExamplePlugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rfresh2%2FZenithProxyExamplePlugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rfresh2","download_url":"https://codeload.github.com/rfresh2/ZenithProxyExamplePlugin/tar.gz/refs/heads/1.21.0","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rfresh2%2FZenithProxyExamplePlugin/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259519257,"owners_count":22870327,"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":[],"created_at":"2025-05-16T22:15:15.371Z","updated_at":"2025-06-12T18:32:14.110Z","avatar_url":"https://github.com/rfresh2.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ZenithProxy Example Plugin\n\n[ZenithProxy](https://github.com/rfresh2/ZenithProxy) is a Minecraft proxy and bot.\n\nThis repository is an example core plugin for ZenithProxy, allowing you to add custom modules and commands.\n\n## Installing Plugins\n\nPlugins are only supported on the `java` ZenithProxy release channel (i.e. not `linux`).\n\nPlace plugin jars in the `plugins` folder inside the same folder as the ZenithProxy launcher.\n\nRestart ZenithProxy to load plugins. Loading plugins after launch or hot reloading is not supported.\n\n## Creating Plugins\n\nUse this repository as a template to create your own plugin repository.\n\n### Plugin Structure\n\nEach plugin needs a main class that implements `ZenithProxyPlugin` and is annotated with `@Plugin`.\n\nPlugin metadata like its unique id, version, and supported MC versions is defined in the `@Plugin` annotation.\n\n[See example](https://github.com/rfresh2/ZenithProxyExamplePlugin/blob/1.21.0/src/main/java/org/example/ExamplePlugin.java)\n\n### Plugin API\n\nThe `ZenithProxyPlugin` interface requires you to implement an `onLoad` method.\n\nThis method provides a `PluginAPI` object that you can use to register modules, commands, and config files.\n\n`Module` and `Command` classes are implemented the same as in the ZenithProxy source code.\n\nI recommend looking at existing modules and commands for examples.\n\n* [Module](https://github.com/rfresh2/ZenithProxy/tree/1.21.0/src/main/java/com/zenith/module)\n* [Command](https://github.com/rfresh2/ZenithProxy/tree/1.21.0/src/main/java/com/zenith/command)\n\n### JavaDocs\n\nhttps://maven.2b2t.vc/javadoc/releases/com/zenith/ZenithProxy/1.21.0-SNAPSHOT\n\n### Building Plugins\n\nExecute the Gradle `build` task: `./gradlew build` - or double-click the task in Intellij\n\nThe built plugin jar will be in the `build/libs` directory.\n\n### Testing Plugins\n\nExecute the `run` task: `./gradlew run` - or double-click the task in Intellij\n\nThis will run ZenithProxy with your plugin loaded in the `run` directory.\n\n### New Plugin Checklist\n\n1. Edit `gradle.properties`:\n   - `plugin_name` - Name of your plugin, used in the plugin jar name (e.g. `ExamplePlugin`)\n   - `maven_group` - Java package for your project (e.g. `com.github.rfresh2`)\n1. Move files to your new corresponding package / maven group:\n   - Example: `src/main/java/org/example` -\u003e `src/main/java/com/github/rfresh2`\n   - First create the new package in `src/main/java`. Then click and drag original subpackages/classes to your new one\n   - Do this with Intellij to avoid manually editing all the source files\n   - You must also move folders/package for the `src/main/templates` folder\n   - Also make sure to update the package import at the very top of `BuiltConstants.java`, it will not be done automatically\n1. Edit `ExamplePlugin.java`, or remove it and create a new main class\n   - Make sure to update the `@Plugin` annotation\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frfresh2%2Fzenithproxyexampleplugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frfresh2%2Fzenithproxyexampleplugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frfresh2%2Fzenithproxyexampleplugin/lists"}