Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
btarg committed Dec 5, 2023
1 parent e7316a8 commit 0e76797
Showing 1 changed file with 17 additions and 8 deletions.
25 changes: 17 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,29 @@
<h2>Custom blocks and items for <a href="https://papermc.io">Paper</a></h2>
</div>

[![Build status](https://github.com/btarg/Origami/actions/workflows/gradle.yml/badge.svg)](https://github.com/btarg/Origami/actions)

Origami is a Minecraft server plugin which allows a server admin to easily add configurable custom
blocks,
items and crafting recipes using YAML configuration files.

The plugin generates and hosts resource packs to allow **vanilla** clients to connect and play with your custom content.

[![Build status](https://github.com/btarg/Origami/actions/workflows/gradle.yml/badge.svg)](https://github.com/btarg/Origami/actions)

# Getting Started

> 📖 View the official docs on [GitBook](https://btarg.gitbook.io/origami-docs/) for information on how to use the
> plugin.
## Supported versions

This plugin will only ever support the latest version of Minecraft (Paper) at the time of its release.

## Reporting issues

You can report issues with the plugin or the docs on this GitHub repository's issues page.
When reporting a bug, send a full log file and walk
through the steps needed to replicate the bug.

# Current progress

> This is not a comprehensive list of features, but serves instead as a developer to-do list.
Expand Down Expand Up @@ -60,15 +75,9 @@ The plugin generates and hosts resource packs to allow **vanilla** clients to co
- [x] Resource pack generation
- [x] Resource pack hosting
- [ ] Resource pack merging / multiple pack support
- [ ] Support for adding custom sounds (will probably just do this with pack merging)
- [ ] Web UI for visual editing *(see preliminary work [here](https://github.com/btarg/vuejava))*
- [ ] Backend API with Javalin
- [ ] Vue.js frontend
- [ ] [Geyser](https://geysermc.org) (Minecraft: Bedrock Edition) support

# Getting Started

View the official docs on [GitBook](https://btarg.gitbook.io/origami-docs/) for information on how to use the plugin.

# Credits and special thanks

Expand Down

0 comments on commit 0e76797

Please sign in to comment.