Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hackusatepvp/haa

Example addon for HeroAdventure.
https://github.com/hackusatepvp/haa

Last synced: 23 days ago
JSON representation

Example addon for HeroAdventure.

Awesome Lists containing this project

README

        

# HAA
Hero Adventure Addon. This is an example addon for the example project, [HeroAdventure](https://github.com/HackusatePvP/HeroAdventure).

## Addons
Addons are effectively DLC's. It allows you to add additional content to a game without modifying the main release source.
It also allows the community to develop third party modifications for the game.

Addons are placed in the 'addons' folder which is inside the 'game' folder.

## Setup
You will need the RenJava framework as a dependency. If you need to modify existing content in the main game you will need to add the main game as a dependency.
You will also have to add any addons this addon may use as a dependency as well.
```xml



me.piitex
RenJava
0.1.109-beta



me.piitex.game
HeroAdventure
1.0-SNAPSHOT



me.piitex
RenJava



me.piitex.game
SomeAddon
1.0-SNAPSHOT

```

First create a class which contains the framework implementation.

```java
import me.piitex.renjava.addons.Addon;

public class MyAddon extends Addon {

public MyAddon() {
super("My Addon"); // Do not use parameters for the super function
}

@Override
public void onLoad() {
// The addon is initialized. Create additional content here.
}

@Override
public void onDisable() {
// Calls when the application exists or unfortunately crashes.
}
}
```

### Build.info
The build.info is a file which contains information for the addon. It will be required to provide the compiled RenJava version your game uses. The version below is an example version please do not copy it.
```properties
dependencies="SomeAddon,OtherAddon"
ren.version="0.1.109"
```
This file is placed in the 'resources' directory. You will need to modify your pom file for the file to be included.
```xml



src/main/resources
false

**/*.*


```