https://github.com/okaeripoland/okaeri-platform
Whole ecosystems built on top of the best okaeri packages
https://github.com/okaeripoland/okaeri-platform
bukkit bungeecord cli java javalin minecraft paper spigot web
Last synced: about 1 year ago
JSON representation
Whole ecosystems built on top of the best okaeri packages
- Host: GitHub
- URL: https://github.com/okaeripoland/okaeri-platform
- Owner: OkaeriPoland
- License: mit
- Created: 2021-04-02T22:54:17.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2025-04-02T22:11:35.000Z (about 1 year ago)
- Last Synced: 2025-04-02T22:27:22.995Z (about 1 year ago)
- Topics: bukkit, bungeecord, cli, java, javalin, minecraft, paper, spigot, web
- Language: Java
- Homepage:
- Size: 1020 KB
- Stars: 26
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Okaeri Platform (WIP)
[](https://discord.gg/hASN5eX)
Whole ecosystems built on top of the best okaeri packages.
- Based on dependency injection/beans/components schema:
- `@Component` registration with `@Register` or `@Scan`
- automatic field/constructor injection and bean creation
- Lots of platform specific utilities:
- register platform specific services as components
- use commons for the most boring tasks and cleaner code
## Real-life use cases
- [okaeri-poly](https://github.com/OkaeriPoland/okaeri-poly): Minecraft scripting plugin with the support for Groovy, JavaScript, and Python — a great addition to traditional plugins and a rapid prototyping tool
- [okaeri-minecraft](https://github.com/OkaeriPoland/okaeri-minecraft): Minecraft plugins built for various [okaeri services](https://www.okaeri.eu), based around integrating Minecraft servers with the WEB APIs
## Supported platforms
```shell
# platform
─ core
└─ minecraft
├─ bukkit
├─ velocity
└─ bungee
└─ standalone
├─ web
└─ cli
# extensions
─ ext-scheduler-quartz
```
- **Minecraft**
- [bukkit](https://github.com/OkaeriPoland/okaeri-platform/tree/master/bukkit): your platform of choice for best Spigot/Paper development experience (*beta - possible breaking changes*)
- [velocity](https://github.com/OkaeriPoland/okaeri-platform/tree/master/velocity): your platform of choice for unified Velocity development experience (*alpha - missing features, possible breaking changes*)
- [bungee](https://github.com/OkaeriPoland/okaeri-platform/tree/master/bungee): your platform of choice for best BungeeCord development experience (*beta - possible breaking changes*)
- **Standalone**
- [web](https://github.com/OkaeriPoland/okaeri-platform/tree/master/web): best used as web side of other platforms but can be used fully standalone (*beta - basic features, possible breaking changes*)
- [cli](https://github.com/OkaeriPoland/okaeri-platform/tree/master/cli): allows access to platform features with minimal fuss, useful for bots or other standalone tools (*beta - possible breaking changes*)
## Documentation
Okaeri Platform is a private use first project, not a public benefit project, and should be treated as such, the documentation might be non-existing or lacking.
Feel free to explore README files of supported platforms for some basic guidance and [Real-life use cases](https://github.com/OkaeriPoland/okaeri-platform?tab=readme-ov-file#real-life-use-cases) projects.
You can search for or make any okaeri-platform related questions in [discussions](https://github.com/OkaeriPoland/okaeri-platform/discussions).
## Recommendations
It is highly recommended to use `-parameters` compiler flag for better overall feature support.
### Maven (Java)
```xml
org.apache.maven.plugins
maven-compiler-plugin
3.8.1
-parameters
```
### Maven (Kotlin)
```xml
org.jetbrains.kotlin
kotlin-maven-plugin
${kotlin.version}
-java-parameters
```
### Gradle (Java)
```groovy
compileJava {
options.compilerArgs << '-parameters'
}
```
### Gradle (Kotlin)
```groovy
compileKotlin {
kotlinOptions {
javaParameters = true
}
}
```