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

https://github.com/oraxen/oraxen

Oraxen is a minecraft plugin that allows to easily use Minecraft 1.14 features in order to create new items with custom textures. It handles the resourcepack generation, upload (using Polymath) and has an extensible API.
https://github.com/oraxen/oraxen

java minecraft minecraft-plugin spigot spigot-plugin

Last synced: 21 days ago
JSON representation

Oraxen is a minecraft plugin that allows to easily use Minecraft 1.14 features in order to create new items with custom textures. It handles the resourcepack generation, upload (using Polymath) and has an extensible API.

Awesome Lists containing this project

README

          




Oraxen Logo


Oraxen


Source code of the Oraxen Spigot plugin, made with love in Java.



CodeFactor Score


Version


Spigot


bStats Servers


bStats Players


What is it?
Features
Contributing
API
License

---

## What is it?

Oraxen is a Minecraft plugin that allows you to modify the game by adding new items, weapons, blocks, and more. One of its key features is the ability to generate the texture pack automatically from the configuration, which greatly simplifies the work of administrators. It also includes an extensive API which can be used by developers to expand Oraxen's capabilities.

## Features

- Automatically generate the resource-pack
- Automatically upload the resource-pack
- Automatically send the resource-pack to your players
- Create new items in a few lines of configuration
- Support for custom items, weapons, armors, blocks, and more
- Modular mechanics system to empower your items
- Automatic configuration updates when you update the plugin
- Handle configuration errors gracefully

## Contributing

If you want to contribute to Oraxen, you can do so by creating a pull request. You should make a pull-request to the `develop` branch.

1. Fork Oraxen on GitHub
2. Clone your forked repository (`git clone`)
3. Create your feature branch (`git checkout -b my-feature`)
4. Commit your changes (`git commit -am 'Add my feature'`)
5. Push to the branch (`git push origin my-feature`)
6. Create a new Pull Request to the `develop` branch
7. Wait for your pull request to be reviewed and merged
8. Celebrate your contribution!

## API

Oraxen's API is primarily found in these four classes:

| Class | Description |
|-------|-------------|
| `OraxenItems` | Methods related to Oraxen items |
| `OraxenBlocks` | Methods related to custom blocks in Oraxen |
| `OraxenFurniture` | Methods related to custom furniture in Oraxen |
| `OraxenPack` | Methods related to the resource-pack |

### Repository

Gradle (Kotlin DSL)

```kotlin
maven("https://repo.oraxen.com/releases")
```

Gradle (Groovy)

```groovy
maven {
url "https://repo.oraxen.com/releases"
}
```

Maven

```xml

oraxen
Oraxen Repository
https://repo.oraxen.com/releases

```

### Dependency

[![version](https://img.shields.io/maven-metadata/v?metadataUrl=https://repo.oraxen.com/releases/io/th0rgal/oraxen/maven-metadata.xml)](https://repo.oraxen.com/#/releases/io/th0rgal/oraxen)

The latest version can be found at the badge above.

Gradle (Kotlin DSL)

```kotlin
compileOnly("io.th0rgal:oraxen:VERSION")
```

Gradle (Groovy)

```groovy
compileOnly 'io.th0rgal:oraxen:VERSION'
```

Maven (with exclusions)

```xml

io.th0rgal
oraxen
1.167.0


me.gabytm.util
actions-spigot


org.jetbrains
annotations


com.ticxo
PlayerAnimator


com.github.stefvanschie.inventoryframework
IF


io.th0rgal
protectionlib


dev.triumphteam
triumph-gui


org.bstats
bstats-bukkit


com.jeff-media
custom-block-data


com.jeff-media
persistent-data-serializer


com.jeff_media
MorePersistentDataTypes


gs.mclo
java


provided

```

Snapshot builds are also available at [https://repo.oraxen.com/snapshots](https://repo.oraxen.com/snapshots).

## License

*Click here to read [the entire license](https://github.com/Th0rgal/Oraxen/blob/master/LICENSE.md).*

Oraxen is a paid plugin. To use it you must purchase a license on [spigotmc.org](https://spigotmc.org), [polymart.org](https://polymart.org/product/629/), or [builtbybit.com](https://builtbybit.com/resources/oraxen-custom-items-blocks-more.16594/). Nevertheless we will not try to prevent you from downloading the source code and rebuilding it, as long as you do not distribute it (whether it is modified or intact and compiled or whether it is the source code, partial or complete). Public forks are allowed as long as you comply with the license (in order to propose a pull request). Buying a license will not only save you time, I will do my best to help you if you have any concerns and it will show me that you appreciate my work.