Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/endlesscodegroup/mimic
Abstraction API for Minecraft RPG plugins
https://github.com/endlesscodegroup/mimic
api bukkit items minecraft plugin rpg spigot
Last synced: about 18 hours ago
JSON representation
Abstraction API for Minecraft RPG plugins
- Host: GitHub
- URL: https://github.com/endlesscodegroup/mimic
- Owner: EndlessCodeGroup
- License: lgpl-3.0
- Created: 2017-03-03T20:49:54.000Z (over 7 years ago)
- Default Branch: develop
- Last Pushed: 2023-11-30T01:28:04.000Z (10 months ago)
- Last Synced: 2024-09-24T05:04:08.789Z (1 day ago)
- Topics: api, bukkit, items, minecraft, plugin, rpg, spigot
- Language: Kotlin
- Homepage: https://endlesscodegroup.github.io/Mimic/
- Size: 8.31 MB
- Stars: 12
- Watchers: 5
- Forks: 3
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Mimic
[][mavenCentral]
[][ci]
[][codacy]
[][license]
[](#)
Abstraction API for RPG plugins.
Other resources:
[SpigotMC](https://www.spigotmc.org/resources/82515/),
[SpigotMC Forum](https://www.spigotmc.org/threads/456931/),
[RuBukkit](http://rubukkit.org/threads/134308/)
Join us: [](https://discord.gg/5NfPsgb)
## What is MimicAPI?
The goal of MimicAPI is to make RPG plugins compatible with each other.
There is a lot of RPG plugins and to integrate them together you need to get copies of all these plugins (some of which are paid).
Inspired by [Vault], I wrote MimicAPI to avoid this problem.
With Mimic, you don't need to download all RPG plugins and write specific code for each plugin to support them, just use Mimic as a dependency.
### Available APIs
- [LevelSystem] - API to work with player's level and experience points.
Makes it possible to use in plugins levels and exp from another plugin.
- [ClassSystem] - API to work with player's classes.
Enables plugins to check player class.
- [PlayerInventory] *(experimental)* - API to access player's inventories content.
- [ItemsRegistry] - API adding the possibility to create and validate custom items created with plugins.
### Implementations
#### Bukkit
- [mimic-bukkit-api](mimic-bukkit-api) - mimic-api adopted for Bukkit. Use it in Bukkit plugins.
- [mimic-bukkit](mimic-bukkit) - Bukkit plugin containing some APIs implementations.
It also provides commands to test your API implementation.
Use it as example of Mimic APIs usage and implementation.
## Installation
If you are server owner, just get needed plugin from [Implementations](#implementations) section.
If you are developer you can use [Gradle] or [Maven] to plug MimicAPI to your plugin.
### Gradle
```kotlin
repositories {
mavenCentral()
}
dependencies {
compileOnly("ru.endlesscode.mimic:mimic-bukkit-api:0.8.0")
}
```
### Maven
```xml
ru.endlesscode.mimic
mimic-bukkit-api
0.8.0
provided
```
## Usage
> Look [Implementations](#implementations) pages for API usage examples on your platform.
## Contributing
Pull requests are welcome.
For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
[codacy]: https://www.codacy.com/app/EndlessCode-Group/MimicAPI?utm_source%3Dgithub.com%26amp;utm_medium%3Dreferral%26amp;utm_content%3DEndlessCodeGroup/MimicAPI%26amp;utm_campaign%3DBadge_Grade
[mavenCentral]: https://search.maven.org/search?q=g:ru.endlesscode.mimic
[ci]: https://github.com/EndlessCodeGroup/Mimic/actions/
[license]: LICENSE
[Vault]: https://github.com/MilkBowl/Vault
[Gradle]: https://gradle.org/
[Maven]: https://maven.apache.org/
[LevelSystem]: mimic-api/src/main/kotlin/level/LevelSystem.kt
[ClassSystem]: mimic-api/src/main/kotlin/classes/ClassSystem.kt
[PlayerInventory]: mimic-api/src/main/kotlin/inventory/PlayerInventory.kt
[ItemsRegistry]: mimic-api/src/main/kotlin/items/ItemsRegistry.kt