https://github.com/cyberpwnn/surge
A quick, shade-able api for making bukkit plugins quickly
https://github.com/cyberpwnn/surge
here phantom was
Last synced: 11 months ago
JSON representation
A quick, shade-able api for making bukkit plugins quickly
- Host: GitHub
- URL: https://github.com/cyberpwnn/surge
- Owner: cyberpwnn
- Created: 2017-10-18T22:16:16.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-05-11T09:49:51.000Z (about 8 years ago)
- Last Synced: 2025-01-01T17:42:40.745Z (over 1 year ago)
- Topics: here, phantom, was
- Language: Java
- Size: 1.04 MB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Compiling with your Plugin
You need maven to use Surge obviously if there is shading involved
### 1. Add the maven coordinates to your pom
In your pom.xml
``` xml
surge
https://raw.githubusercontent.com/cyberpwnn/Central/master/
org.cyberpwn
Surge
1.7
provided
```
### 2. Update your plugin.yml
Your plugin.yml will no longer specify YOUR plugin. Instead it will specify a ghost plugin inside of surge (which will exist at runtime)
``` yaml
name: YOUR_NAME
version: YOUR_VERSION
main: surge.Main
```
### 3. Create a Plugin class
You do not need to extend java plugin, just create a class like so
``` java
import surge.control.Disable;
import surge.control.Enable;
import surge.control.Instance;
import surge.control.Plugin;
@Plugin
public class SomeCoolPlugin
{
// Auto instance creation
@Instance
public SomeCoolPlugin instance;
@Enable
public void enable()
{
// you can call this method whatever you like
}
@Disable
public void disable()
{
// you can call this method whatever you like
}
}
```
### 4. Configure your pom SHADE plugin
You need to include surge in your jar
In your build section:
``` xml
org.apache.maven.plugins
maven-shade-plugin
3.1.0
package
shade
org.cyberpwn:*
```