DeflatedPickle/Quiver

# Quiver

<a href="https://www.codefactor.io/repository/github/deflatedpickle/quiver"><img src="https://www.codefactor.io/repository/github/deflatedpickle/quiver/badge" alt="CodeFactor" /></a>
<a href="https://codebeat.co/projects/github-com-deflatedpickle-quiver-rewrite"><img alt="codebeat badge" src="https://codebeat.co/badges/65a2da8a-28b9-4cd4-ac82-c521cc531a63" /></a>
<a href="https://www.codacy.com/gh/DeflatedPickle/Quiver/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=DeflatedPickle/Quiver&amp;utm_campaign=Badge_Grade"><img src="https://app.codacy.com/project/badge/Grade/ed4a4e2eb4d844eba3f8897869406128"/></a>
<a href="https://snyk.io/test/github/DeflatedPickle/Quiver"><img src="https://snyk.io/test/github/DeflatedPickle/Quiver/badge.svg"/></a>
<a href="https://codeclimate.com/github/DeflatedPickle/Quiver/maintainability"><img src="https://api.codeclimate.com/v1/badges/0f980169bbebf3f680b4/maintainability" /></a>

A resource pack creator and manager for Minecraft.

## Downloading

You can find pre-built versions of Quiver [here](https://github.com/deflatedpickle/quiver/releases). The most recent
build will be labeled as such. Any of the older builds *will* ***not*** be supported, especially `v0.*.*`, so please
stay up-to-date.

## Running

You will first need to download a version *(hopefully the latest)* of Quiver *(it should be a zip)*, you will then need
to unzip it and then run either `Quiver.bat` or `Quiver` *(depending on if you're on Windows or Linux/MacOS)*

This program requires a Java 8 JRE. It is not compatible with anything higher, as I'm old and lazy.

If everything works, great! If not, please submit an
issue [here](https://github.com/DeflatedPickle/Quiver/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc).

## Building

In order to build this program, you will need a Java 8 JDK

- [Windows](https://github.com/ojdkbuild/ojdkbuild/releases/tag/java-1.8.0-openjdk-debug-1.8.0.265-1.b01)
- [Linux](http://openjdk.java.net/install/)

You will then want to clone this repository into a directory, `cd` into it and run `gradlew distZip`

## Extending

This program uses the [haruhi](https://github.com/DeflatedPickle/haruhi) framework, allowing it to have plugins and
configs.

Though there isn't an official way to develop external plugins, there are two routes I can think of;

1. Clone this repository and develop your plugin as a submodule
    - **Pro:** Easier to debug
    - **Con:** Harder to distribute
2. Develop your plugin in its own repository, then build it and place the build in your install of Quiver's `/plugins`
directory when you want to test it
    - **Pro:** Doesn't require the Quiver source
    - **Con:** Harder to test

## Credits

### Libraries

- core
    - [log4j](https://github.com/apache/logging-log4j2)
    - [commons-lang](https://github.com/apache/commons-lang)
    - [underscore](https://github.com/javadev/underscore-java)
    - [kappdirs](https://github.com/erayerdin/kappdirs)
    - [zip4j](https://github.com/srikanth-lingala/zip4j)
    - [reflections](https://github.com/ronmamo/reflections)
    - [classgraph](https://github.com/classgraph/classgraph)
    - [discord-rpc](https://github.com/Vatuu/discord-rpc)
    - [fuzzywuzzy](https://github.com/xdrop/fuzzywuzzy)
    - [jankson](https://github.com/falkreon/Jankson)
    - [jOOr](https://github.com/jOOQ/jOOR)
    - [kunion](https://github.com/renatoathaydes/kunion)
    - [marvin](https://github.com/DeflatedPickle/marvin)
    - [undulation](https://github.com/DeflatedPickle/undulation)
    - [haruhi](https://github.com/DeflatedPickle/haruhi)
    - [easy-events](https://github.com/Fylipp/easy-events)
    - [jsplitbutton](https://github.com/rhwood/jsplitbutton)
    - [swingx](https://github.com/smartbow-gmbh/swingx)
    - [jide-oss](https://github.com/jidesoft/jide-oss)
    - [balloontip](https://github.com/timmolderez/balloontip)
    - [rsyntaxtextarea](https://github.com/bobbylight/RSyntaxTextArea)
        - [languagesupport](https://github.com/bobbylight/RSTALanguageSupport)
        - [spellchecker](https://github.com/bobbylight/SpellChecker)
        - [autocomplete](https://github.com/bobbylight/AutoComplete)
        - [rstaui](https://github.com/bobbylight/RSTAUI)
        - [rsyntaxtextarea-antlr4-extension](https://github.com/tisoft/rsyntaxtextarea-antlr4-extension)
    - [dockingframes](https://github.com/Benoker/DockingFrames)
    - [oxbow](https://github.com/eugener/oxbow)
    - [wraplayout](https://github.com/DeflatedPickle/WrapLayout)
    - [tosuto](https://github.com/DeflatedPickle/tosuto)
    - [nagato](https://github.com/DeflatedPickle/Nagato)
- launcher
    - [jansi](https://github.com/fusesource/jansi)
- markdownviewer
    - [flexmark](https://github.com/vsch/flexmark-java)
    - [flyingsaucer](https://github.com/flyingsaucerproject/flyingsaucer)
- treeviewer
    - [NBT](https://github.com/Querz/NBT)
- docxviewer
    - [flyingsaucer](https://github.com/flyingsaucerproject/flyingsaucer)
    - [mammoth](https://github.com/mwilliamson/java-mammoth)

### Tools

- [PackSquash](https://github.com/ComunidadAylas/PackSquash)