{"id":20674799,"url":"https://github.com/btarg/origami","last_synced_at":"2025-09-27T03:31:05.379Z","repository":{"id":191086789,"uuid":"680952019","full_name":"btarg/Origami","owner":"btarg","description":"(WIP) A Minecraft Paper plugin that allows for adding new blocks and items in YAML, using resource packs","archived":false,"fork":false,"pushed_at":"2023-12-20T14:45:23.000Z","size":641,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-11-16T21:07:27.764Z","etag":null,"topics":["custom-blocks","custom-items","minecraft","paper","paper-plugin","papermc","plugin","resource-pack"],"latest_commit_sha":null,"homepage":"https://btarg.gitbook.io/origami-docs/","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/btarg.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":"btarg","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2023-08-20T23:34:56.000Z","updated_at":"2024-06-22T12:25:55.000Z","dependencies_parsed_at":"2023-12-16T00:53:55.370Z","dependency_job_id":null,"html_url":"https://github.com/btarg/Origami","commit_stats":null,"previous_names":["icrazyblaze/customitemsplugin","btarg/customitemsplugin","btarg/origami"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/btarg%2FOrigami","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/btarg%2FOrigami/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/btarg%2FOrigami/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/btarg%2FOrigami/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/btarg","download_url":"https://codeload.github.com/btarg/Origami/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234376923,"owners_count":18822417,"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":["custom-blocks","custom-items","minecraft","paper","paper-plugin","papermc","plugin","resource-pack"],"created_at":"2024-11-16T21:07:33.318Z","updated_at":"2025-09-27T03:31:00.013Z","avatar_url":"https://github.com/btarg.png","language":"Java","funding_links":["https://ko-fi.com/btarg"],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n    \u003ca href=\"https://thenounproject.com/browse/icons/term/origami-crane/\"\u003e\u003cimg title=\"Origami Crane by Kelig Le Luron from The Noun Project\" src=\"https://github.com/iCrazyBlaze/CustomItemsPlugin/blob/master/origami-logo.png?raw=true\" align=\"center\" style=\"max-width: 500px\" alt=\"Origami\"\u003e\u003c/a\u003e\n  \u003ca rel=\"license\" href=\"http://creativecommons.org/licenses/by-nc/4.0/\"\u003e\u003cimg alt=\"Creative Commons License\" style=\"border-width:0\" src=\"https://i.creativecommons.org/l/by-nc/4.0/88x31.png\" /\u003e\u003c/a\u003e\u003cbr /\u003eThis work is licensed under a \u003ca rel=\"license\" href=\"http://creativecommons.org/licenses/by-nc/4.0/\"\u003eCreative Commons Attribution-NonCommercial 4.0 International License\u003c/a\u003e.\n    \u003cbr /\u003e\n    \u003ch2\u003eCustom blocks and items for \u003ca href=\"https://papermc.io\"\u003ePaper\u003c/a\u003e\u003c/h2\u003e\n\u003c/div\u003e\n\nOrigami is a Minecraft server plugin which allows a server admin to easily add configurable custom\nblocks,\nitems and crafting recipes using YAML configuration files.\n\nThe plugin generates and hosts resource packs to allow **vanilla** clients to connect and play with your custom content.\n\n[![Build status](https://github.com/btarg/Origami/actions/workflows/gradle.yml/badge.svg)](https://github.com/btarg/Origami/actions)\n\n# What makes this different from other plugins\n\nOrigami is designed to be as simple as possible for a Minecraft server owner to create custom content quickly.\nIt is **NOT** an advanced custom block/item API for other developers to use, and it does not require any coding\nknowledge to\nuse by design.\nOther plugins tend to be more developer-focused rather than being as human-friendly as possible for the average user.\n\n# Getting Started\n\n\u003e 📖 View the official docs on [GitBook](https://btarg.gitbook.io/origami-docs/) for information on how to use the\n\u003e plugin.\n\nThe docs are also open source at [btarg/origami-docs](https://github.com/btarg/origami-docs).\n\n## Supported versions\n\nThis plugin will only ever support the latest version of Minecraft (Paper) at the time of its release.\n\n## Reporting issues\n\nYou can report issues with the plugin or the docs on this GitHub repository's issues page.\nWhen reporting a bug, send a full log file and walk\nthrough the steps needed to replicate the bug.\n\n# Current progress\n\n\u003e This is not a comprehensive list of features, but serves instead as a developer to-do list.\n\n- [x] Reload commands for all content\n- [x] \"Content Packs\": content can be organised into folders under the `custom` folder\n- [x] Example content generation for first-time users\n    - [x] Example crafting recipe\n    - [x] Example block\n    - [ ] Example item\n    - [ ] Example models\n- [x] Custom blocks via YAML\n    - [x] Custom models via Minecraft JSON model format\n    - [x] Custom block break speed (needs more work)\n    - [x] Loot tables\n    - [x] Sounds for breaking and placing blocks\n    - [x] Blocks can be pushable\n    - [ ] Custom stairs and slabs\n    - [ ] Custom breaking particles\n    - [ ] World awareness (e.g. detecting when another block is near it, when a player steps on it)\n    - [ ] Custom containers\n- [x] Custom items via YAML\n    - [x] Custom models via Minecraft JSON model format\n    - [x] Custom name, lore and flags\n        - [x] Translated strings support\n        - [x] Legacy formatting *and* [MiniMessage](https://docs.advntr.dev/minimessage/index.html) support\n        - [ ] [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/) support\n    - [x] Custom durability (tools, armour etc.)\n    - [x] Editable enchantments\n        - [ ] Configurable allowed enchantments\n    - [ ] Editable attributes (e.g. attack power, armour defense stat)\n    - [ ] NBT override via NBT string\n    - [ ] Custom food items (function on consume)\n    - [ ] Custom tool levels and blocks that can only be broken with custom tools\n    - [ ] Custom sounds for breaking\n- [x] Custom crafting recipes via YAML\n    - [x] Cooking recipes (Furnaces, Campfires etc.)\n    - [x] Smithing recipes (still very janky)\n    - [ ] Potion recipes\n    - [ ] Villager trades\n    - [ ] Custom item repair recipes (defined in the item's YAML rather than as a separate \"recipe\")\n- [ ] Custom enchantments\n- [x] YAML event system: events can be subscribed to such as when a block is broken, when an item is used or consumed\n  etc. via a string in a YAML file\n    - [ ] TODO: add more events\n- [x] Resource pack generation\n    - [x] Resource pack hosting\n    - [ ] Resource pack merging / multiple pack support\n- [X] In-game UI for obtaining items (AKA \"creative mode\")\n- [ ] Web UI for visual editing *(see preliminary work [here](https://github.com/btarg/vuejava))*\n    - [ ] Backend API with Javalin\n    - [ ] Vue.js frontend\n\n# Credits and special thanks\n\n- The [PaperMC Discord](https://discord.gg/papermc) for being incredibly helpful and quick to respond to any questions\n- [Unnamed Team](https://unnamed.team) for creating\n  the [Creative](https://unnamed.team/docs/creative/latest/getting-started) API and [yusshu](https://github.com/yusshu)\n  for helping me with implementing it\n- [Dannegm on GitHub](https://github.com/dannegm/BlockEntities) for providing an initial implementation of custom blocks\n  using Item Display entities\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbtarg%2Forigami","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbtarg%2Forigami","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbtarg%2Forigami/lists"}