Skip to content

Latest commit

 

History

History
171 lines (156 loc) · 6.52 KB

README.md

File metadata and controls

171 lines (156 loc) · 6.52 KB
Raw


oraxen.com logo

☄️ Source code of the Oraxen spigot plugin, made with love in Java.

spigot

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 to be able 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 be able to increase oraxen features.

Features

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

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:

  • 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:

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

Groovy:

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

Maven

<repository>
  <id>oraxen</id>
  <name>Oraxen Repository</name>
  <url>https://repo.oraxen.com/releases</url>
</repository>

Dependency version version

The latest version can be found at above.
Gradle Kotlin:

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

Groovy:

compileOnly 'io.th0rgal:oraxen:VERSION'

Maven

Maven with exclusions 
<dependency>
    <groupId>io.th0rgal</groupId>
    <artifactId>oraxen</artifactId>
    <version>1.167.0</version>
    <exclusions>
        <exclusion>
            <groupId>me.gabytm.util</groupId>
            <artifactId>actions-spigot</artifactId>
        </exclusion>
        <exclusion>
            <groupId>org.jetbrains</groupId>
            <artifactId>annotations</artifactId>
        </exclusion>
        <exclusion>
            <groupId>com.ticxo</groupId>
            <artifactId>PlayerAnimator</artifactId>
        </exclusion>
        <exclusion>
            <groupId>com.github.stefvanschie.inventoryframework</groupId>
            <artifactId>IF</artifactId>
        </exclusion>
        <exclusion>
            <groupId>io.th0rgal</groupId>
            <artifactId>protectionlib</artifactId>
        </exclusion>
        <exclusion>
            <groupId>dev.triumphteam</groupId>
            <artifactId>triumph-gui</artifactId>
        </exclusion>
        <exclusion>
            <groupId>org.bstats</groupId>
            <artifactId>bstats-bukkit</artifactId>
        </exclusion>
        <exclusion>
            <groupId>com.jeff-media</groupId>
            <artifactId>custom-block-data</artifactId>
        </exclusion>
        <exclusion>
            <groupId>com.jeff-media</groupId>
            <artifactId>persistent-data-serializer</artifactId>
        </exclusion>
        <exclusion>
            <groupId>com.jeff_media</groupId>
            <artifactId>MorePersistentDataTypes</artifactId>
        </exclusion>
        <exclusion>
            <groupId>gs.mclo</groupId>
            <artifactId>java</artifactId>
        </exclusion>
        <exclusion>
            <groupId>fr.euphyllia</groupId>
            <artifactId>energie</artifactId>
        </exclusion>
    </exclusions>
    <scope>provided</scope>
</dependency>

Snapshot builds are also available at https://repo.oraxen.com/snapshots.

License

Click here to read the entire license.

Oraxen is a paid plugin, to use it you must purchase a license on spigotmc.org, nevertheless I 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.