{"id":16378704,"url":"https://github.com/cyberpwnn/surge","last_synced_at":"2025-07-11T06:37:35.033Z","repository":{"id":89832657,"uuid":"107469023","full_name":"cyberpwnn/Surge","owner":"cyberpwnn","description":"A quick, shade-able api for making bukkit plugins quickly","archived":false,"fork":false,"pushed_at":"2018-05-11T09:49:51.000Z","size":1090,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-01T17:42:40.745Z","etag":null,"topics":["here","phantom","was"],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cyberpwnn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2017-10-18T22:16:16.000Z","updated_at":"2018-10-05T06:29:41.000Z","dependencies_parsed_at":null,"dependency_job_id":"6553076d-4d46-4a2d-af34-ec2333255f18","html_url":"https://github.com/cyberpwnn/Surge","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyberpwnn%2FSurge","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyberpwnn%2FSurge/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyberpwnn%2FSurge/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyberpwnn%2FSurge/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cyberpwnn","download_url":"https://codeload.github.com/cyberpwnn/Surge/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240018705,"owners_count":19734873,"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":["here","phantom","was"],"created_at":"2024-10-11T03:46:15.530Z","updated_at":"2025-02-21T13:14:51.071Z","avatar_url":"https://github.com/cyberpwnn.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Compiling with your Plugin\nYou need maven to use Surge obviously if there is shading involved\n\n### 1. Add the maven coordinates to your pom\n\nIn your pom.xml\n``` xml\n\u003crepository\u003e\n  \u003cid\u003esurge\u003c/id\u003e\n  \u003curl\u003ehttps://raw.githubusercontent.com/cyberpwnn/Central/master/\u003c/url\u003e\n\u003c/repository\u003e\n\n\u003cdependency\u003e\n  \u003cgroupId\u003eorg.cyberpwn\u003c/groupId\u003e\n  \u003cartifactId\u003eSurge\u003c/artifactId\u003e\n  \u003cversion\u003e1.7\u003c/version\u003e\n  \u003cscope\u003eprovided\u003c/scope\u003e\n\u003c/dependency\u003e\n```\n\n### 2. Update your plugin.yml\n\nYour plugin.yml will no longer specify YOUR plugin. Instead it will specify a ghost plugin inside of surge (which will exist at runtime)\n``` yaml\nname: YOUR_NAME\nversion: YOUR_VERSION\nmain: surge.Main\n```\n\n### 3. Create a Plugin class\n\nYou do not need to extend java plugin, just create a class like so\n\n``` java\nimport surge.control.Disable;\nimport surge.control.Enable;\nimport surge.control.Instance;\nimport surge.control.Plugin;\n\n@Plugin\npublic class SomeCoolPlugin\n{\n\t// Auto instance creation\n\t@Instance\n\tpublic SomeCoolPlugin instance;\n\n\t@Enable\n\tpublic void enable()\n\t{\n\t\t// you can call this method whatever you like\n\t}\n\n\t@Disable\n\tpublic void disable()\n\t{\n\t\t// you can call this method whatever you like\n\t}\n}\n```\n\n### 4. Configure your pom SHADE plugin\nYou need to include surge in your jar\n\nIn your build section: \n``` xml\n\u003cbuild\u003e\n    \u003cplugins\u003e\n        \u003cplugin\u003e\n            \u003cgroupId\u003eorg.apache.maven.plugins\u003c/groupId\u003e\n            \u003cartifactId\u003emaven-shade-plugin\u003c/artifactId\u003e\n            \u003cversion\u003e3.1.0\u003c/version\u003e\n            \u003cexecutions\u003e\n                \u003cexecution\u003e\n                    \u003cphase\u003epackage\u003c/phase\u003e\n                    \u003cgoals\u003e\n                        \u003cgoal\u003eshade\u003c/goal\u003e\n                    \u003c/goals\u003e\n                    \u003cconfiguration\u003e\n\t\t        \u003cartifactSet\u003e\n                            \u003cincludes\u003e\n                                \u003cinclude\u003eorg.cyberpwn:*\u003c/include\u003e\n                            \u003c/includes\u003e\n                        \u003c/artifactSet\u003e\n                    \u003c/configuration\u003e\n                \u003c/execution\u003e\n            \u003c/executions\u003e\n        \u003c/plugin\u003e\n    \u003c/plugins\u003e\n\u003c/build\u003e\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcyberpwnn%2Fsurge","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcyberpwnn%2Fsurge","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcyberpwnn%2Fsurge/lists"}