Skip to content

Commit

Permalink
Merge branch 'master' into distribute
Browse files Browse the repository at this point in the history
  • Loading branch information
aksiome committed Feb 26, 2025
2 parents 9d72b25 + a8f05f8 commit 8f0c67c
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 6 deletions.
1 change: 1 addition & 0 deletions docs/_templates/changelog/v3.0.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
- <abbr title="GitHub & CI/CD">⚙️</abbr> **[#285](https://github.com/mcbookshelf/Bookshelf/pull/285)** - Modules now require a `README.md` and a `pack.png`.
- <abbr title="GitHub & CI/CD">⚙️</abbr> **[#285](https://github.com/mcbookshelf/Bookshelf/pull/285)** - Updated GitHub with new issue templates and a code of conduct.
- <abbr title="GitHub & CI/CD">⚙️</abbr> **[#285](https://github.com/mcbookshelf/Bookshelf/pull/285)** - Added new workflows with automatic deployment to **Modrinth** and **Smithed**.
- <abbr title="Download">📥</abbr> **[#333](https://github.com/mcbookshelf/Bookshelf/issues/333)** - Bookshelf now has its own download page on its [website](https://mcbookshelf.dev). From it, you can choose which modules you want to download, see their dependencies, and download your custom bundle.


### `🧱 bs.block`
Expand Down
17 changes: 11 additions & 6 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,19 @@ This page gives a quick overview of how to get started with the Bookshelf librar
:::::{tab-set}
::::{tab-item} 🔌 from manager

The Bookshelf Manager is still in its development phase, and there is no straightforward installation process at the moment. If you're not familiar with datapacks, feel free to join our Discord, we'll be delighted to assist you with the installation and usage of the library!
The [Bookshelf Manager](https://mcbookshelf.dev) is the official tool for creating your own custom Bookshelf bundle. Here are its main advantages:

- 🎯 **Precise Selection**: Choose exactly the modules you need
- 📊 **Dependency Visualization**: Intuitive interface showing relationships between modules
- 🏷️ **Tag System**: Easily identify modules with tags, grouping them by purpose

```{admonition} 🤝 Help us improve the installation process
:class: info
Getting started:
1. Visit [mcbookshelf.dev](https://mcbookshelf.dev)
2. Select your desired modules
3. Review automatically added dependencies
4. Download your custom bundle

We are actively searching for web developers to create the new version of the Bookshelf Manager, a website that helps users download modules and their respective dependencies. We've already finalized the mockup for the website, you can [check it here](https://www.figma.com/file/kVAmQnmP5pWWzun0Iq2kBa/Bookshelf-Manager-V2.0-prod?type=design&node-id=0-1). If you are interested in helping us, please contact us on Discord!
```
This method is recommended for creators who want precise control over their installation.

::::
::::{tab-item} 🏷️ from release
Expand Down Expand Up @@ -77,7 +82,7 @@ Bookshelf relies on persistent entities to enhance performances. Therefore, it's

### 📖 Good Practices

Bookshelf is designed to minimize unintended side effects. However, complications can arise when multiple datapacks utilize the same one. To prevent potential issues, its always recommended to set inputs prior to executing a function. This holds true even though Bookshelf adheres to a strict policy of preserving inputs. By following this practice, you can ensure smoother operation and prevent unexpected behaviors.
Bookshelf is designed to minimize unintended side effects. However, complications can arise when multiple datapacks utilize the same one. To prevent potential issues, it's always recommended to set inputs prior to executing a function. This holds true even though Bookshelf adheres to a strict policy of preserving inputs. By following this practice, you can ensure smoother operation and prevent unexpected behaviors.

:::{note}
This section is in progress. If you have some ideas about how to improve the first steps with Bookshelf, please share it on our [Discord server](https://discord.gg/MkXytNjmBt).
Expand Down

0 comments on commit 8f0c67c

Please sign in to comment.