Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Khazoda authored Sep 13, 2023
1 parent e71cf81 commit d4c3f62
Showing 1 changed file with 40 additions and 17 deletions.
57 changes: 40 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,40 @@
__Required__:
[Fabric API](https://www.modrinth.com/mod/fabric-api/versions) **OR**
[Quilted Fabric API](https://modrinth.com/mod/qsl/versions)

__Required__:
[GeckoLib](https://www.modrinth.com/mod/geckolib/versions)

__Optional__:
[Roughly Enough Items](https://www.modrinth.com/mod/rei/versions),
[EMI](https://modrinth.com/mod/emi/versions)

</p>
<div style="min-width:100%; display:block;">
<img src="https://raw.githubusercontent.com/Khazoda/Plushables/1.20.1-FABRIC/web_assets/info_1.1.2.png" alt="Plushables Information" />
<img src="https://raw.githubusercontent.com/Khazoda/Plushables/1.20.1-FABRIC/web_assets/description_1.1.2.rv0.png" alt="Plushables Description" />
</div>
</div>
![Plushables Banner](https://github.com/Khazoda/Plushables/blob/Web-Assets/description_common/banner.png?raw=true)

# Important 🐻

Plushables is a mod that works with *Fabric* and *Quilt*. You will *need* to download the following:
| Using Fabric | [Fabric API](https://legacy.curseforge.com/minecraft/mc-mods/fabric-api) | [GeckoLib](https://legacy.curseforge.com/minecraft/mc-mods/geckolib) | [Patchouli](https://legacy.curseforge.com/minecraft/mc-mods/patchouli-fabric) |
| ----- | ----- | ----- | ----- |
| Using Quilt | [Quilted Fabric API](https://legacy.curseforge.com/minecraft/mc-mods/qsl) | [GeckoLib](https://legacy.curseforge.com/minecraft/mc-mods/geckolib) | [Patchouli](https://legacy.curseforge.com/minecraft/mc-mods/patchouli-fabric) |

# About 🦣

Plushables adds many new decorative blocks that are crafted within a new crafting interface, the Plushable Builder.
These 'plushables' can have sound and particle effects on interaction, as well as animations.
![highlight](https://github.com/Khazoda/Plushables/blob/Web-Assets/description_common/highlight.png?raw=true)

# Getting Started 📖

- Pick up a copper ingot to unlock the recipe for the Plushable Builder in your recipe book, a block that is used to craft every plushable.
- Once you've crafted the builder you will be granted the Plushable Codex, a book item that details the recipes of every plush.
- Every plushable needs either a Heart of Gold or a Powered Heart of Gold. Both recipes can be found in your recipe book at the same time you unlock the builder recipe.
![Crafting recipe](https://github.com/Khazoda/Plushables/blob/Web-Assets/description_common/crafting.png?raw=true)

# Optional Mods 🌻

Plushables has optional features that you may want to use. To unlock everything this mod has to offer, consider downloading any of the mods below to use in your game.

- [EMI](https://www.curseforge.com/minecraft/mc-mods/emi) OR [REI](https://www.curseforge.com/minecraft/mc-mods/roughly-enough-items) - Both of these mods fulfil similar functions, and you should only install one of them. Recipe viewer mods such as EMI and REI allow you to see a searchable list of every item in the game. This includes plushables and their recipes in the plushable builder.
- [Bovines and Buttercups](https://www.curseforge.com/minecraft/mc-mods/bovines-and-buttercups) - This content mod adds mooblooms to your world. With it installed, you can unlock a new texture for the moobloom plushable by enabling a built-in resource pack!

# Frequently Asked Questions (FAQ) 🧡

- Is there a forge version?
_`Currently there is no forge version. It is planned, but don't expect it any time soon.`_
- Can you backport the mod to Minecraft 1.X.X?
_`Unfortunately I don't have the time to backport Plushables to earlier versions. The mod will however support each new version of Minecraft.`_
- I found a bug / my game crashed
_`If you find any problems with Plushables, please feel encouraged to create an issue on the GitHub repository issue tracker. Bug reports are incredibly helpful, and help make Plushables the best it can be.`_

![divider](https://github.com/Khazoda/Plushables/blob/Web-Assets/description_common/divider.png?raw=true)
![footer](https://github.com/Khazoda/Plushables/blob/Web-Assets/description_common/footer.png?raw=true)

0 comments on commit d4c3f62

Please sign in to comment.