Skip to content

Commit

Permalink
Add readme for each module
Browse files Browse the repository at this point in the history
  • Loading branch information
aksiome committed Dec 27, 2024
1 parent 17a8c59 commit 18533d0
Show file tree
Hide file tree
Showing 26 changed files with 711 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@
<br/>
<br/>


# 🕵️‍♂️ What is Bookshelf?

Bookshelf (formerly known as Gunivers Libs) is a modular library datapack designed to simplify complex systems in Minecraft maps. Ideal for mapmakers looking for easy-to-implement tools.

<div align="center">
Expand All @@ -35,6 +37,7 @@ Bookshelf (formerly known as Gunivers Libs) is a modular library datapack design
</a>
</div>


# 🌟 Featured Modules

<div align="center">
Expand Down Expand Up @@ -73,17 +76,22 @@ Bookshelf (formerly known as Gunivers Libs) is a modular library datapack design
<p>And much more!</p>
</div>


# 🔥 Motivation

As developers, we understand the value of libraries: they save time, streamline workflows, and eliminate the need to reinvent the wheel. However, we’ve noticed that many mapmakers in the Minecraft community are less familiar with this concept.

That’s why we started this project, to provide a variety of reusable tools and encourage mapmakers to embrace the use of libraries.

While we strive to keep our modules as optimized as possible, our top priority is accessibility. We focus on creating features that are easy to use and simple to install, ensuring they’re practical for everyone.

> “I have seen further than others because I have stood on the shoulders of giants.”
>
> -- Isaac Newton

# 🤝 Contribution

If you have any doubts related to the project or want to discuss something, join [our Discord](https://discord.gg/MkXytNjmBt) server.

If you want to contribute, please refer to the [contribution docs](https://docs.bookshelf.dev/en/latest/contribute/index.html) for more information.
If you want to contribute, please refer to the [contribution docs](https://docs.mcbookshelf.dev/en/latest/contribute/index.html) for more information.
34 changes: 34 additions & 0 deletions modules/bookshelf/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# 📚 Bookshelf Library

This datapack brings together the full suite of **Bookshelf modules**, offering a versatile toolkit for Minecraft mapmakers. It includes modules such as:

- **🧱 Block**: Get and manipulate blocks (supports BlockStates and NBT).
- **🔦 Raycast**: Cast rays and see if they collide with blocks or entities.
- **🧮 Math**: Mathematical functions: sin, cos, exp, log, sqrt and much more!
- **🏗️ Generate**: Generate terrains and landscapes, incorporating natural features.
- **🎲 Random**: Random functions for different distributions and noise patterns.
- **❤️ Health**: Easily manage the health of a player or the lifetime of an entity!

*And much more...*

For more details and usage examples, check out the [documentation](https://docs.mcbookshelf.dev/en/latest/index.html).


## 🔥 Motivation

As developers, we understand the value of libraries: they save time, streamline workflows, and eliminate the need to reinvent the wheel. However, we’ve noticed that many mapmakers in the Minecraft community are less familiar with this concept.

That’s why we started this project, to provide a variety of reusable tools and encourage mapmakers to embrace the use of libraries.

While we strive to keep our modules as optimized as possible, our top priority is accessibility. We focus on creating features that are easy to use and simple to install, ensuring they’re practical for everyone.

> “I have seen further than others because I have stood on the shoulders of giants.”
>
> -- Isaac Newton

## 🤝 Contribution

If you have any doubts related to the project or want to discuss something, join [our Discord](https://discord.gg/MkXytNjmBt) server.

If you want to contribute, please refer to the [contribution docs](https://docs.mcbookshelf.dev/en/latest/contribute/index.html) for more information.
29 changes: 29 additions & 0 deletions modules/bs.bitwise/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# 🖥️ Bookshelf Bitwise

This datapack provides a collection of various bitwise operations, providing versatile tools for manipulating binary data.

> “Binary is a very simple numbering system, but it is incredibly powerful when used correctly.”
>
> -- Alan Turing
For more details and usage examples, check out the [documentation](https://docs.mcbookshelf.dev/en/latest/modules/bitwise.html).


## 🔥 Motivation

As developers, we understand the value of libraries: they save time, streamline workflows, and eliminate the need to reinvent the wheel. However, we’ve noticed that many mapmakers in the Minecraft community are less familiar with this concept.

That’s why we started this project, to provide a variety of reusable tools and encourage mapmakers to embrace the use of libraries.

While we strive to keep our modules as optimized as possible, our top priority is accessibility. We focus on creating features that are easy to use and simple to install, ensuring they’re practical for everyone.

> “I have seen further than others because I have stood on the shoulders of giants.”
>
> -- Isaac Newton

## 🤝 Contribution

If you have any doubts related to the project or want to discuss something, join [our Discord](https://discord.gg/MkXytNjmBt) server.

If you want to contribute, please refer to the [contribution docs](https://docs.mcbookshelf.dev/en/latest/contribute/index.html) for more information.
29 changes: 29 additions & 0 deletions modules/bs.block/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# 🧱 Bookshelf Block

This datapack allows you to manage blocks efficiently, including their states and NBT data, while providing advanced tools for transformations.

> “Architecture is the thoughtful making of space.”
>
> -- Louis Kahn
For more details and usage examples, check out the Bookshelf [documentation](https://docs.mcbookshelf.dev/en/latest/modules/block.html).


## 🔥 Motivation

As developers, we understand the value of libraries: they save time, streamline workflows, and eliminate the need to reinvent the wheel. However, we’ve noticed that many mapmakers in the Minecraft community are less familiar with this concept.

That’s why we started this project, to provide a variety of reusable tools and encourage mapmakers to embrace the use of libraries.

While we strive to keep our modules as optimized as possible, our top priority is accessibility. We focus on creating features that are easy to use and simple to install, ensuring they’re practical for everyone.

> “I have seen further than others because I have stood on the shoulders of giants.”
>
> -- Isaac Newton

## 🤝 Contribution

If you have any doubts related to the project or want to discuss something, join [our Discord](https://discord.gg/MkXytNjmBt) server.

If you want to contribute, please refer to the [contribution docs](https://docs.mcbookshelf.dev/en/latest/contribute/index.html) for more information.
29 changes: 29 additions & 0 deletions modules/bs.color/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# 🎨 Bookshelf Color

This datapack facilitate color conversion between various formats.

> “Color helps to express light, not the physical phenomenon, but the only light that really exists, that in the artist’s brain.”
>
> -- Henri Matisse
For more details and usage examples, check out the Bookshelf [documentation](https://docs.mcbookshelf.dev/en/latest/modules/color.html).


## 🔥 Motivation

As developers, we understand the value of libraries: they save time, streamline workflows, and eliminate the need to reinvent the wheel. However, we’ve noticed that many mapmakers in the Minecraft community are less familiar with this concept.

That’s why we started this project, to provide a variety of reusable tools and encourage mapmakers to embrace the use of libraries.

While we strive to keep our modules as optimized as possible, our top priority is accessibility. We focus on creating features that are easy to use and simple to install, ensuring they’re practical for everyone.

> “I have seen further than others because I have stood on the shoulders of giants.”
>
> -- Isaac Newton

## 🤝 Contribution

If you have any doubts related to the project or want to discuss something, join [our Discord](https://discord.gg/MkXytNjmBt) server.

If you want to contribute, please refer to the [contribution docs](https://docs.mcbookshelf.dev/en/latest/contribute/index.html) for more information.
25 changes: 25 additions & 0 deletions modules/bs.dump/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# 🔬 Bookshelf Dump

This datapack provides tools for printing the state of various "variables" (such as scores or NBT data), making it easier to debug and track values.

For more details and usage examples, check out the Bookshelf [documentation](https://docs.mcbookshelf.dev/en/latest/modules/dump.html).


## 🔥 Motivation

As developers, we understand the value of libraries: they save time, streamline workflows, and eliminate the need to reinvent the wheel. However, we’ve noticed that many mapmakers in the Minecraft community are less familiar with this concept.

That’s why we started this project, to provide a variety of reusable tools and encourage mapmakers to embrace the use of libraries.

While we strive to keep our modules as optimized as possible, our top priority is accessibility. We focus on creating features that are easy to use and simple to install, ensuring they’re practical for everyone.

> “I have seen further than others because I have stood on the shoulders of giants.”
>
> -- Isaac Newton

## 🤝 Contribution

If you have any doubts related to the project or want to discuss something, join [our Discord](https://discord.gg/MkXytNjmBt) server.

If you want to contribute, please refer to the [contribution docs](https://docs.mcbookshelf.dev/en/latest/contribute/index.html) for more information.
29 changes: 29 additions & 0 deletions modules/bs.environment/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# ⛰️ Bookshelf Environment

This datapack provides comprehensive information and tools related to weather and biome properties.

> “The most dangerous worldview is the worldview of those have not viewed the world.”
>
> -- Alexander von Humboldt
For more details and usage examples, check out the Bookshelf [documentation](https://docs.mcbookshelf.dev/en/latest/modules/environment.html).


## 🔥 Motivation

As developers, we understand the value of libraries: they save time, streamline workflows, and eliminate the need to reinvent the wheel. However, we’ve noticed that many mapmakers in the Minecraft community are less familiar with this concept.

That’s why we started this project, to provide a variety of reusable tools and encourage mapmakers to embrace the use of libraries.

While we strive to keep our modules as optimized as possible, our top priority is accessibility. We focus on creating features that are easy to use and simple to install, ensuring they’re practical for everyone.

> “I have seen further than others because I have stood on the shoulders of giants.”
>
> -- Isaac Newton

## 🤝 Contribution

If you have any doubts related to the project or want to discuss something, join [our Discord](https://discord.gg/MkXytNjmBt) server.

If you want to contribute, please refer to the [contribution docs](https://docs.mcbookshelf.dev/en/latest/contribute/index.html) for more information.
29 changes: 29 additions & 0 deletions modules/bs.generate/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# 🏗️ Bookshelf Generate

This datapack provides tools for generating a wide range of terrains and landscapes, utilizing various noise functions for natural-looking results.

> “Nature’s beauty is a reflection of the harmony of numbers and patterns.”
>
> -- Anonymous
For more details and usage examples, check out the Bookshelf [documentation](https://docs.mcbookshelf.dev/en/latest/modules/generate.html).


## 🔥 Motivation

As developers, we understand the value of libraries: they save time, streamline workflows, and eliminate the need to reinvent the wheel. However, we’ve noticed that many mapmakers in the Minecraft community are less familiar with this concept.

That’s why we started this project, to provide a variety of reusable tools and encourage mapmakers to embrace the use of libraries.

While we strive to keep our modules as optimized as possible, our top priority is accessibility. We focus on creating features that are easy to use and simple to install, ensuring they’re practical for everyone.

> “I have seen further than others because I have stood on the shoulders of giants.”
>
> -- Isaac Newton

## 🤝 Contribution

If you have any doubts related to the project or want to discuss something, join [our Discord](https://discord.gg/MkXytNjmBt) server.

If you want to contribute, please refer to the [contribution docs](https://docs.mcbookshelf.dev/en/latest/contribute/index.html) for more information.
29 changes: 29 additions & 0 deletions modules/bs.health/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# ❤️ Bookshelf Health

This datapack allows you to efficiently manage the lifecycle and health of entities in Minecraft.

> “He who has a why to live can bear almost any how.”
>
> -- Friedrich Nietzsche
For more details and usage examples, check out the Bookshelf [documentation](https://docs.mcbookshelf.dev/en/latest/modules/health.html).


## 🔥 Motivation

As developers, we understand the value of libraries: they save time, streamline workflows, and eliminate the need to reinvent the wheel. However, we’ve noticed that many mapmakers in the Minecraft community are less familiar with this concept.

That’s why we started this project, to provide a variety of reusable tools and encourage mapmakers to embrace the use of libraries.

While we strive to keep our modules as optimized as possible, our top priority is accessibility. We focus on creating features that are easy to use and simple to install, ensuring they’re practical for everyone.

> “I have seen further than others because I have stood on the shoulders of giants.”
>
> -- Isaac Newton

## 🤝 Contribution

If you have any doubts related to the project or want to discuss something, join [our Discord](https://discord.gg/MkXytNjmBt) server.

If you want to contribute, please refer to the [contribution docs](https://docs.mcbookshelf.dev/en/latest/contribute/index.html) for more information.
29 changes: 29 additions & 0 deletions modules/bs.hitbox/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# 🎯 Bookshelf Hitbox

This datapack allows you to get and check the hitboxes of blocks and entities.

> “Talent hits a target no one else can hit; Genius hits a target no one else can see.”
>
> -- Arthur Schopenhauer
For more details and usage examples, check out the Bookshelf [documentation](https://docs.mcbookshelf.dev/en/latest/modules/hitbox.html).


## 🔥 Motivation

As developers, we understand the value of libraries: they save time, streamline workflows, and eliminate the need to reinvent the wheel. However, we’ve noticed that many mapmakers in the Minecraft community are less familiar with this concept.

That’s why we started this project, to provide a variety of reusable tools and encourage mapmakers to embrace the use of libraries.

While we strive to keep our modules as optimized as possible, our top priority is accessibility. We focus on creating features that are easy to use and simple to install, ensuring they’re practical for everyone.

> “I have seen further than others because I have stood on the shoulders of giants.”
>
> -- Isaac Newton

## 🤝 Contribution

If you have any doubts related to the project or want to discuss something, join [our Discord](https://discord.gg/MkXytNjmBt) server.

If you want to contribute, please refer to the [contribution docs](https://docs.mcbookshelf.dev/en/latest/contribute/index.html) for more information.
29 changes: 29 additions & 0 deletions modules/bs.id/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# 🏷️ Bookshelf ID

This datapack helps manage entity IDs, which is essential in scenarios like shooting games, where you need to track who is targeting whom.

> “We know what we are, but know not what we may be.”
>
> -- William Shakespeare
For more details and usage examples, check out the Bookshelf [documentation](https://docs.mcbookshelf.dev/en/latest/modules/id.html).


## 🔥 Motivation

As developers, we understand the value of libraries: they save time, streamline workflows, and eliminate the need to reinvent the wheel. However, we’ve noticed that many mapmakers in the Minecraft community are less familiar with this concept.

That’s why we started this project, to provide a variety of reusable tools and encourage mapmakers to embrace the use of libraries.

While we strive to keep our modules as optimized as possible, our top priority is accessibility. We focus on creating features that are easy to use and simple to install, ensuring they’re practical for everyone.

> “I have seen further than others because I have stood on the shoulders of giants.”
>
> -- Isaac Newton

## 🤝 Contribution

If you have any doubts related to the project or want to discuss something, join [our Discord](https://discord.gg/MkXytNjmBt) server.

If you want to contribute, please refer to the [contribution docs](https://docs.mcbookshelf.dev/en/latest/contribute/index.html) for more information.
29 changes: 29 additions & 0 deletions modules/bs.interaction/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# 🖱️ Bookshelf Interaction

This datapack allows you attach interaction events (click, hover) to interaction entities, enabling dynamic player interactions.

> “As far as the customer is concerned, the interface is the product.”
>
> -- Jef Raskin
For more details and usage examples, check out the Bookshelf [documentation](https://docs.mcbookshelf.dev/en/latest/modules/interaction.html).


## 🔥 Motivation

As developers, we understand the value of libraries: they save time, streamline workflows, and eliminate the need to reinvent the wheel. However, we’ve noticed that many mapmakers in the Minecraft community are less familiar with this concept.

That’s why we started this project, to provide a variety of reusable tools and encourage mapmakers to embrace the use of libraries.

While we strive to keep our modules as optimized as possible, our top priority is accessibility. We focus on creating features that are easy to use and simple to install, ensuring they’re practical for everyone.

> “I have seen further than others because I have stood on the shoulders of giants.”
>
> -- Isaac Newton

## 🤝 Contribution

If you have any doubts related to the project or want to discuss something, join [our Discord](https://discord.gg/MkXytNjmBt) server.

If you want to contribute, please refer to the [contribution docs](https://docs.mcbookshelf.dev/en/latest/contribute/index.html) for more information.
Loading

0 comments on commit 18533d0

Please sign in to comment.