{"id":24325791,"url":"https://github.com/oraxen/documentation","last_synced_at":"2025-09-27T09:32:00.968Z","repository":{"id":41392620,"uuid":"266994426","full_name":"oraxen/documentation","owner":"oraxen","description":"The official oraxen documentation (made with gitbook)","archived":false,"fork":false,"pushed_at":"2024-10-29T19:51:10.000Z","size":17156,"stargazers_count":3,"open_issues_count":1,"forks_count":8,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-10-29T21:40:39.578Z","etag":null,"topics":["documentation","gitbook","markdown"],"latest_commit_sha":null,"homepage":"https://docs.oraxen.com","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oraxen.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-05-26T09:01:32.000Z","updated_at":"2024-09-11T08:47:54.000Z","dependencies_parsed_at":"2023-02-14T10:46:14.116Z","dependency_job_id":"3e4343ae-f8c8-4fa7-ad5e-e40dfab6d4d9","html_url":"https://github.com/oraxen/documentation","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oraxen%2Fdocumentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oraxen%2Fdocumentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oraxen%2Fdocumentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oraxen%2Fdocumentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oraxen","download_url":"https://codeload.github.com/oraxen/documentation/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234425403,"owners_count":18830720,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","gitbook","markdown"],"created_at":"2025-01-17T20:29:20.738Z","updated_at":"2025-09-27T09:31:54.775Z","avatar_url":"https://github.com/oraxen.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"---\ndescription: How to install and setup Oraxen on Paper or Spigot\nicon: play\ncover: https://images.polymart.org/resource/629/default.jpg\ncoverY: 0\nlayout:\n  cover:\n    visible: true\n    size: full\n  title:\n    visible: true\n  description:\n    visible: true\n  tableOfContents:\n    visible: true\n  outline:\n    visible: true\n  pagination:\n    visible: true\n---\n\n# Getting started\n\n## What Is Oraxen?\n\nOraxen is a Minecraft plugin which allows the creation of new items \u0026 blocks using custom textures and models. It also handles resourcepack generation, upload and storage (using Polymath), and is entirely open source with an extensible API.\n\n## How Does It All Work?\n\nWhen a Spigot server starts with Oraxen installed, the plugin will read all the item configurations (your .yml files inside /plugins/oraxen/items) and use them to generate .json models that link your .png textures to your new items. After this, Oraxen zips the resources using an optimized algorithm and uploads it to a polymath instance. Polymath is a free and opensource software written in Python to host Minecraft resourcepacks. By default Oraxen will use an Oraxen supplied Polymath instance, hosted in Switzerland on an oracle virtual private server. Whenever a player connects to your server, Oraxen will link them to the polymath instance which then sends them the resourcepack.\n\n## Install Oraxen In Seconds!\n\nInstalling Oraxen is a fairly straight forward process:\u0026#x20;\n\n* Drop the Oraxen and [ProtocolLib](https://www.spigotmc.org/resources/protocollib.1997/) .jar files into your /plugins/ folder.\n* Restart your server.\n\nThat's it! Although, we highly recommend heading into your settings.yml config and making any desired adjustments (then restarting once more) before continuing!\n\n{% hint style=\"info\" %}\nOraxen has been tested with Spigot and Paper 1.18 -\u003e 1.21.4\n{% endhint %}\n\nFor Minecraft 1.21.2+, using the latest version of Oraxen is advised. Oraxen is developed and designed for use with the [Paper](https://papermc.io/downloads/paper) server software. For older Minecraft versions, start by installing Oraxen 1.183.0 to get compatible configuration files. You can then update the jar file accordingly.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foraxen%2Fdocumentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foraxen%2Fdocumentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foraxen%2Fdocumentation/lists"}