Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/demkom58/velevents

Velocity eventbus adjusted to be reused
https://github.com/demkom58/velevents

event eventbus velocity

Last synced: 25 days ago
JSON representation

Velocity eventbus adjusted to be reused

Awesome Lists containing this project

README

        

# VelEvents

This repository contains adjusted source code of Velocity Events to be reused in other projects.
The original source code can be found [here](https://github.com/PaperMC/Velocity).

## Changes
Made adjustments includes:
- removed Guava dependency;
- Checker Framework annotations replaced with jspecify;
- plugin type made generic;
- unbounded from Velocity API;
- changed package name.

## Dependency
Dependency can be added using JitPack.

Gradle:
```gradle
repositories {
maven { url = 'https://jitpack.io' }
}

dependencies {
implementation 'com.github.demkom58.velevents:impl:1.0.0'
}
```

Maven:
```xml


jitpack.io
https://jitpack.io

com.github.demkom58.velevents
impl
1.0.0

```

## Usage

There is no difference in usage between the original and adjusted source code, so
the [original documentation](https://docs.papermc.io/velocity/dev/event-api) can be used.

To start using VelEvents, you need to create a new `VelEventManager` and call
`shutdown` on it for graceful shutdown. `EventManager` interface is meant
to be used by plugins to register and unregister event listeners.

## License

Velocity Events api is licensed under the MIT License,
but implementation is licensed under the GNU General Public License v3.0.