Skip to content

Commit

Permalink
Add readme, rename license file
Browse files Browse the repository at this point in the history
  • Loading branch information
copygirl committed Dec 30, 2016
1 parent 99e463a commit 474092b
Show file tree
Hide file tree
Showing 9 changed files with 117 additions and 7 deletions.
5 changes: 0 additions & 5 deletions .gitignore
Expand Up @@ -26,8 +26,3 @@
# Other
/eclipse/
/run/

# Project
/downloads/
/images/
/models/
File renamed without changes.
117 changes: 117 additions & 0 deletions README.md
@@ -0,0 +1,117 @@
# Wearable Backpacks

.. is a Minecraft mod which adds **backpacks**. But wait! It's not like anything you've
seen before. **Wearable Backpacks** continues the legacy of [BetterStorage][0]'s
backpacks, and brings with it a beautifully designed and balanced alternative backpack
option unlike any other!

![Backpacks!](docs/header.png)

*"Backpacks are love. Backpacks are life."* -asiekierka
*"copy-who?"* -MindlessPuppetz

## What's so great?

- **There can be only one!**
Where other mods store the contents of a backpack on the item itself, **WB** doesn't.
When a backpack is equipped, its contents are actually kept with the player itself.
This also means it's impossible to carry around multiple backpacks that contain items.

![](docs/picture_1.png)

- **Armor up, or storage up?**
With the default settings, backpacks will function as armor, taking up the chest armor
equipment slot, protecting from as well as taking damage just like leather armor. This
way, you have to *choose* between more protection or more storage. This is fully
configurable, though, in case you don't like it.

- **Play with friends, share backpacks!**
Having a backpack on your back looks cool and all, but if only you could do something
with that beauty. Well, lucky you! Other players (hopefully, without ill intentions)
can open your backpack and borrow a pick and some torches on a mining trip. This only
works as long as your back is facing towards them, though.

![](docs/picture_2.png)

- **Dying is [FUN][1]!**
Sick of losing all your valuables when you make a small little misstep into the nearest
pool of lava? Don't worry, the items inside your backpack will be... mostly safe. While
the backpack itself is not unbreakable, after death, it will gently place itself down
near your point of failure, ready to be retrieved.

- **Dyeing is fun~!**
Backpacks can be colored using Minecraft's *fantastic* dyeing system. Unlike some silly
mods that only allow the 16 base colors, with our pretties you can mix and match your
dyes to customize them in any way you like!

![](docs/picture_3.png)

- **Configuration Nation**
One aim of **WB** is to be incredibly configurable, allowing backpacks to be balanced,
whether they're used in a personal hand-picked pack, a huge kitchen sink modpack or a
deadly hardcore-massacre-of-doom experience with sprinkles on top.

## Usage

Think of **Wearable Backpacks** backpacks as portable, wearable chests. After you've
crafted one, simply place it on the ground and fill it with whatever you'd like to take
with you. Next, **sneak** and **break** the backpack to **equip** it. You'll notice that
equipping is faster than breaking.

Now that the backpack is where it belongs (your back), you can **unequip** it again by
**sneaking** and **right-clicking** the ground with an **empty hand** (specifically, the
top of a solid block).

### Crafting Recipe

- 7x Leather
- 1x Gold Ingot
- 1x Wool

![Backpack Recipe](docs/recipe_backpack.png)

## Download

Available for **Minecraft 1.10.2** right here through [GitHub Releases][2].

## License & Permissions

**Wearable Backpacks** is licensed under the [MIT license](LICENSE), though feel free to
consider it **public domain**. This applies to both the source code and releases, so you
are free to redistribute, include in modpacks, modify, fork, release your own versions
of this mod as much as you'd like.

If you want to contribute to this mod, do keep in mind that your contributions will be
treated the same.

## Credits

**Authors:** copygirl, asiekierka
**Contributers:** -
**Localizations:** -

### Special thanks to ...

- **asiekierka** for letting me to use [Charset](http://charset.asie.pl/) as a reference,
to the point where he's getting an honorable co-author mention, and in general being an
amazing friend ❤️
- The **Penguins' Revenge** server for encouraging me to rework / finish this mod.

## Contact

Feature requests and bug reports belong on the [issue tracker][3]. For general inqueries,
discussions and praise, you can contact **copygirl** directly at [Twitter (@koppeh)][4]
or via [email][5], but you're also very welcome to join our little community's
[IRC channel][6] and [Discord guild][7].

*In the event that this mod becomes self-aware, we are not responsible for any damage it causes.*


[0]: https://github.com/copygirl/BetterStorage
[1]: http://dwarffortresswiki.org/index.php/DF2014:Fun
[2]: https://github.com/copygirl/WearableBackpacks/releases
[3]: https://github.com/copygirl/WearableBackpacks/issues
[4]: https://twitter.com/koppeh
[5]: mailto:halfnerd.copygirl@gmail.com
[6]: irc://irc.esper.net/#obsidian
[7]: https://discord.gg/0bNJM8qj0Jiv6BlK
Binary file added docs/header.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/picture_1.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/picture_2.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/picture_3.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/recipe_backpack.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 0 additions & 2 deletions src/main/java/net/mcft/copy/backpacks/WearableBackpacks.java
Expand Up @@ -12,8 +12,6 @@
import net.mcft.copy.backpacks.config.BackpacksConfig;
import net.mcft.copy.backpacks.network.BackpacksChannel;

// TODO: Add a README file to the repository for GitHubs <3
// TODO: Add more documentation / comments to source code.
// TODO: Add achievement(s)! <3

@Mod(modid = WearableBackpacks.MOD_ID, name = WearableBackpacks.MOD_NAME)
Expand Down

0 comments on commit 474092b

Please sign in to comment.