Skip to content

Commit 213a335

Browse files
bbfh-devbbfh-dev
committed
docs: Add README
1 parent 39b21c9 commit 213a335

2 files changed

Lines changed: 148 additions & 0 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# 🤝 Contributing / Help
2+
3+
I appreciate everybody who helps the project in any shape or form!
4+
5+
<!-- vim-markdown-toc GFM -->
6+
7+
* [Translators](#translators)
8+
* [Developers](#developers)
9+
* [Financial support](#financial-support)
10+
11+
<!-- vim-markdown-toc -->
12+
13+
## Translators
14+
15+
If you wish to translate the project into a language, just tell me in discord or create an [issue](https://github.com/bbfh-dev/bubblellaneous-pack/issues/new). You'll be able to change translation with a Google Sheet document or using your own editor that supports importing from `.tsv` files.
16+
17+
## Developers
18+
19+
If you wish to create your own fork / improve the project feel free to create pull requests.
20+
21+
You can find instructions on how to build project from source [here](./README.md#%EF%B8%8F-building-from-source).
22+
23+
## Financial support
24+
25+
You can reach out to me if you wish to make a donation to help out the project.

‎README.md‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/RGn_skcWKsg" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
2+
3+
# 🫧 Bubblellaneous Pack
4+
5+
This Minecraft pack adds Furniture, Technology, Food & Miscellaneous blocks and items.
6+
7+
To use it you must [install the data pack](https://minecraft.wiki/w/Data_pack#Usage) in your world. All players playing on your server must have [the resource pack installed](https://minecraft.wiki/w/Resource_pack#Java_Edition).
8+
9+
- Use `/function menu:bubblellaneous` for settings/debugging!
10+
- Use `/function give:bubblellaneous/<item_name>` to give an item.
11+
- Use `/function spawn:bubblellaneous/<item_name>` to spawn an item.
12+
- Use `/function place:bubblellaneous/<block_name>` to place a block.
13+
14+
| Minecraft version | Status |
15+
| ------------------ | -------------------------------------- |
16+
| 1.20.2 and earlier | 🚫 Broken due to Minecraft limitations |
17+
| 1.20.3 | ✅ Supported (only 2.0.0) |
18+
| 1.20.4 | ✅ Supported (only 2.0.0) |
19+
| 1.21.0—1.21.9 | ✅ Supported (only to 2.2.3) |
20+
| 1.21.11 | ✅ Supported (only 3.0.0 and later) |
21+
22+
If you wish to contribute, refer to [CONTRIBUTING.md](https://github.com/bbfh-dev/bubblellaneous-pack/blob/main/CONTRIBUTING.md)
23+
24+
# 🔖 Translations
25+
26+
Thanks to wonderful people you can enjoy this pack in different languages:
27+
28+
| Maintainer | Translation |
29+
| -------------------------------------------------------- | ------------------------------ |
30+
| [BubbleFish](https://modrinth.com/user/BubbleFish) | 🇺🇸 English (US) \[100%\] |
31+
| [BubbleFish](https://modrinth.com/user/BubbleFish) | 🇬🇧 English (UK) \[100%\] |
32+
| [BubbleFish](https://modrinth.com/user/BubbleFish) | 🇷🇺 Russian \[100%\] |
33+
| [Unintegrated](https://linktr.ee/unintegrated) | 🇨🇿 Czech \[100%\] |
34+
| [Unintegrated](https://linktr.ee/unintegrated) | 🌍 Toki Pona \[100%\] |
35+
| [Atten007](https://github.com/Atten007) | 🇩🇪 German \[100%\] |
36+
| Caesar_Galahad | 🇨🇳 Chinese \[100%\] |
37+
| [Antoha256M](https://modrinth.com/user/Antoha256M) | 🇷🇺 Russian Pre-Reform \[100%\] |
38+
| [FBreakDance30](https://modrinth.com/user/FBreakDance30) | 🇮🇹 Italian \[99%\] |
39+
| Dorlonkho | 🇯🇵 Japanesse \[17%\] |
40+
41+
If you want to help with translations, refer to [CONTRIBUTING.md](https://github.com/bbfh-dev/bubblellaneous-pack/blob/main/CONTRIBUTING.md)
42+
43+
# 🖥️ About Bubblellaneous
44+
45+
This data pack was originally published by me on Nov 21st, 2021. This is a complete rework, designed to be great for survival, map making, and the creation of your content.
46+
47+
- You can obtain all custom content without memorizing recipes using Bubble Bench: Drop a glass bottle onto a crafting table!
48+
49+
![bubble bench](https://github.com/bbfh-dev/bubblellaneous-pack/blob/main/docs/bubble_bench.png?raw=true)
50+
51+
- Many blocks/items have different variants (variating in color and material):
52+
53+
![variants](https://github.com/bbfh-dev/bubblellaneous-pack/blob/main/docs/block_variations.png?raw=true)
54+
55+
- Have fun with all the content! Feel free to [join my discord](https://discord.gg/5kugW5Q7wB):
56+
57+
# 📦 For Map Makers / Developers
58+
59+
## Storing blocks
60+
61+
Bubblellaneous uses entities to display blocks, this may become inconvenient for mapmakers. For this reason, there's a way of restoring the block's state when loading from structures using structure blocks or `/place`:
62+
63+
1. Prevent copying before you save all of the blocks: `/function bubblellaneous:blocks/copy_properties/prevent_copying`.
64+
1. Store blocks that you want to save: `/execute as @e[tag=bbln.block] run function bubblellaneous:blocks/copy_properties/save_to_block`.
65+
1. Save the structure. You can now break the blocks.
66+
1. Start copying state: `/function bubblellaneous:blocks/copy_properties/stop_prevent_copying`.
67+
1. Now you can place the saved structure template anywhere and it will automatically restore all data.
68+
1. If you encounter errors, create a GitHub Issue telling which block and how exactly it broke.
69+
70+
## Events
71+
72+
Bubblellaneous has several events that can be used to extend the data pack logic. The way you hook to these events is by creating a [Function tag](https://minecraft.wiki/w/Tag#Java_Edition) in the specified path. The function tag is executed by a certain entity that you can refer to.
73+
74+
> \[!NOTE\]
75+
> If your project requires more events, create a GitHub Issue or message me on Discord, and I'll add it.
76+
77+
**Entity tag** is `@e[tag=bbln.<value>]`. e.g. if the value is `name.test`, then the actual selector is `@e[tag=bbln.name.test]`.
78+
79+
| Function tag | Entity tag | Description |
80+
| ------------------------------------------------- | ------------------- | ---------------------------------------------------------------------- |
81+
| `#bubblellaneous:settings/on_load` | - | Settings were loaded/changed |
82+
| `#bubblellaneous:block/all/on_place` | block | A block was placed |
83+
| `#bubblellaneous:block/all/on_break` | block | A block was broken. Use `/return 1` to prevent the block from breaking |
84+
| `#bubblellaneous:block/bear_trap/on_catch` | name.bear_trap | Bear Trap caught a player |
85+
| `#bubblellaneous:block/bear_trap/on_release` | name.bear_trap | Bear Trap released the player |
86+
| `#bubblellaneous:block/electrical_box/on_enable` | name.electrical_box | An electrical box was toggled on |
87+
| `#bubblellaneous:block/electrical_box/on_disable` | name.electrical_box | An electrical box was toggled off |
88+
| `#bubblellaneous:block/alarm_block/on_trigger` | name.alarm_block | An alarm block was triggered with redstone |
89+
90+
## Bubble Bench Blacklist
91+
92+
You can hide certain blocks/items from Bubble Bench, preventing players from crafting them.
93+
94+
> Substitute `<unit>/<id>` with the following values:
95+
>
96+
> - `<unit>` is either `block` or `item`.
97+
> - `<id>` is the id of the block/item. The same ID is used in commands like `/function give:bubblellaneous/...` for reference.
98+
99+
**Adding unit into blacklist**:
100+
101+
```mcfunction
102+
data modify storage minecraft:bubblellaneous bench_blacklist append value {entry: "<unit>/<id>"}
103+
104+
# Example:
105+
data modify storage minecraft:bubblellaneous bench_blacklist append value {entry: "block/acacia_table"}
106+
```
107+
108+
**Removing unit from blacklist**:
109+
110+
```mcfunction
111+
data remove storage minecraft:bubblellaneous bench_blacklist[{entry: "<unit>/<id>"}]
112+
113+
# Example:
114+
data remove storage minecraft:bubblellaneous bench_blacklist[{entry: "item/white_key"}]
115+
```
116+
117+
The changes will apply on the next `/reload`.
118+
119+
## 🔗 Links
120+
121+
You can leave a comment on the PMC page!
122+
123+
[![PMC](https://www.planetminecraft.com/images/layout/themes/modern/planetminecraft_logo.png)](https://www.planetminecraft.com/data-pack/bubblellaneous/)

0 commit comments

Comments
 (0)