Skip to content

Commit cb48188

Browse files
committed
GITBOOK-2: No subject
1 parent 4777adc commit cb48188

File tree

9 files changed

+258
-3
lines changed

9 files changed

+258
-3
lines changed

gitbook/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ layout:
1919

2020
Thank you for checking out the documentation! This should contain everything from why BEComTweaks exists, to the fine details on how it works, and how to contribute!
2121

22-
#### Jump right in
22+
If you need more help, you are welcome to join our discord! It is available at [https://becomtweaks.github.io/discord](https://becomtweaks.github.io/discord)
23+
24+
#### Jump right in!
25+
26+
<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Getting Started</strong></td><td>Learn on the basics required in any repo!</td><td><a href="getting-started.md">getting-started.md</a></td></tr><tr><td><strong>Creating new things</strong></td><td>Learn to create new items like Packs, Sections and Compatibilities</td><td><a href="broken-reference">Broken link</a></td></tr><tr><td><strong>Who are we?</strong></td><td>Want to know who we are?</td><td><a href="who-are-we.md">who-are-we.md</a></td></tr></tbody></table>
2327

24-
<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Getting Started</strong></td><td>Learn on the basics required in any repo!</td><td><a href="getting-started.md">getting-started.md</a></td></tr><tr><td><strong>Creating new things</strong></td><td>Learn to create new items like Packs, Sections and Compatibilities</td><td><a href="broken-reference">Broken link</a></td></tr><tr><td><strong>Who are we?</strong></td><td>Want to know who we are?</td><td></td></tr></tbody></table>

gitbook/SUMMARY.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,12 @@
1111

1212
* [New Category](new-category.md)
1313
* [New Compatibility](new-compatibility.md)
14+
15+
## Miscellaneous
16+
17+
* [FAQ](miscellaneous/faq.md)
18+
19+
***
20+
21+
* [Impossible Packs](impossible-packs.md)
22+
* [Who are we?](who-are-we.md)

gitbook/creating-a/new-pack.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Open the newly cloned folder using VSCode. In the directory list, open the `json
1414

1515
The format for a pack is as follows
1616

17+
{% code overflow="wrap" lineNumbers="true" fullWidth="true" %}
1718
```json
1819
{
1920
"pack_id": "<pack id>",
@@ -31,6 +32,7 @@ The format for a pack is as follows
3132
"regolith": "<bool>"
3233
}
3334
```
35+
{% endcode %}
3436

3537
The only required definitions are `pack_id`, `pack_name` and `pack_description`. For the rest, they aren't required. Let's go through what each one defines.
3638

@@ -59,12 +61,14 @@ The only required definitions are `pack_id`, `pack_name` and `pack_description`.
5961
* An extra stylised description is used to provide additional information to the user. This has no purpose in the backend.
6062
* Must be in the format below, but can be omitted
6163

64+
{% code overflow="wrap" fullWidth="true" %}
6265
```json
6366
"message": [
6467
"error/info/warn",
6568
"<information>"
6669
]
6770
```
71+
{% endcode %}
6872

6973
* A message of level `error` has the information show up as <mark style="color:red;">red</mark>
7074
* A message level of `info` has the information show up as <mark style="color:blue;">cyan</mark>
@@ -102,29 +106,37 @@ After you have created the pack icon,&#x20;
102106

103107
Now, using your terminal, head to the folder with the repository. Ensure that you have an active Python Virtual Environment (refer to [#setting-up-the-modules](../getting-started.md#setting-up-the-modules "mention") if you have not set it up). Run
104108

109+
{% code overflow="wrap" fullWidth="true" %}
105110
```sh
106111
python pys/pre_commit.py --format
107112
```
113+
{% endcode %}
108114

109115
You can choose to add in a `--no-stash` if you are sure you won't accidentally nuke your workspace.
110116

111117
After the script finishes running, you can run
112118

119+
{% code overflow="wrap" fullWidth="true" %}
113120
```sh
114121
git status
115122
```
123+
{% endcode %}
116124

117125
to see your changed files. If they are all right, you can run
118126

127+
{% code overflow="wrap" fullWidth="true" %}
119128
```sh
120129
git add .
121130
```
131+
{% endcode %}
122132

123133
to stage your added files, then
124134

135+
{% code overflow="wrap" fullWidth="true" %}
125136
```sh
126137
git commit -m "<message>"
127138
```
139+
{% endcode %}
128140

129141
where `<message>` is a summary of the changes you made. Finally, run
130142

gitbook/getting-started.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,24 +60,30 @@ You should now see a new directory with the name you set.
6060

6161
Create a new python environment using either python's `venv` module by running
6262

63+
{% code overflow="wrap" lineNumbers="true" fullWidth="true" %}
6364
```sh
6465
python -m venv venv
6566
venv/Scripts/activate
6667
python -m pip install -r requirements.txt
6768
```
69+
{% endcode %}
6870

6971
or using [uv](https://docs.astral.sh/uv/getting-started/installation/#highlights)
7072

73+
{% code overflow="wrap" lineNumbers="true" %}
7174
```sh
7275
uv venv venv
7376
venv/Scripts/active
7477
uv pip sync requirements.txt
7578
```
79+
{% endcode %}
7680

7781
If you are working on server-backend or want the formatter, make sure to run
7882

83+
{% code overflow="wrap" fullWidth="true" %}
7984
```sh
8085
pnpm install
8186
```
87+
{% endcode %}
8288

8389
That's it! You have setup the repository for editing!

gitbook/impossible-packs.md

Lines changed: 176 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
---
2+
icon: circle-xmark
3+
---
4+
5+
# Impossible Packs
6+
7+
## Impossible Packs <a href="#impossible-packs" id="impossible-packs"></a>
8+
9+
A non-exhaustive page on packs that will **NOT** be added to both BedrockTweaks due to Bedrock issues and DrAV's preferences.\
10+
Keep in mind that some might be added to BEComTweaks as toned-down versions.
11+
12+
### Resource Packs <a href="#resource-packs" id="resource-packs"></a>
13+
14+
**1. Bushy Leaves**
15+
16+
There is no way to edit a block's geometry to make it bushy in Vanilla Bedrock. While pre-defined blockshapes can be used, with the closest one being Cactus, it does not match the original aesthetic of Bushy Leaves, hence why it is left out.
17+
18+
**2. Visual Cauldron Stages**
19+
20+
Cauldron does not support transparent textures, so just removing the center line doesn't help. Cauldrons do not have any visual changes when adding/removing water/powdered snow.\
21+
However, Lava Cauldrons do have a seperate Block State, but that misses the entire point of Visual Cauldron Stages.
22+
23+
**3. Visual Honey Stages**
24+
25+
The Bee Hive and Nest only visually change while full, so any other progress in-between cannot be shown in the pack. This prevents DrAV from adding the pack to BedrockTweaks
26+
27+
Available on BEComTweaks. [Link ↗](https://becomtweaks.github.io/resource-packs/?st_raw=N4IgTghg7iBcDaIBiBXANmgEgewHYFMBPAZQBcIBzfEAXQF8g)
28+
29+
**4. Visual Noteblock Pitch**
30+
31+
Noteblocks have no change in Block States when switching pitches or instruments, so having it change textures is out of the question. However, [lonelyang](https://github.com/lonelyang) discovered that you can edit the Particle emitted by the Note Block to show the current Pitch of it. Again, DrAV doesn't like the implementation of it and will not add it to Bedrock Tweaks
32+
33+
Available on BEComTweaks. [Link ↗](https://becomtweaks.github.io/resource-packs/?st_raw=N4IgTghg7iBcDaIByB7ALgUwEIBsUGMBrABQEs18ALYiMNU-HDEAXQF8g)
34+
35+
**5. Directional Droppers and Dispensers**
36+
37+
This is because of Minecraft Bedrock's issue. Mojang decided to combine both the sideways facing dropper textures and the vertical facing dropper textures into a single block without any blockstates.
38+
39+
<details>
40+
41+
<summary>Technical Findings</summary>
42+
43+
`blocks.json`
44+
45+
{% code overflow="wrap" lineNumbers="true" fullWidth="true" %}
46+
```json
47+
"dropper" : {
48+
"sound" : "stone",
49+
"textures" : {
50+
"down" : "dropper_top",
51+
"east" : "dropper_front_vertical",
52+
"north" : "dropper_side",
53+
"south" : "dropper_front_horizontal",
54+
"up" : "dropper_top",
55+
"west" : "dropper_side"
56+
}
57+
}
58+
```
59+
{% endcode %}
60+
61+
Have you noticed the East and South textures?
62+
63+
{% code fullWidth="true" %}
64+
```json
65+
"down" : "dropper_top",
66+
"east" : "dropper_front_vertical",
67+
"north" : "dropper_side",
68+
"south" : "dropper_front_horizontal",
69+
"up" : "dropper_top",
70+
```
71+
{% endcode %}
72+
73+
Yeah, Mojang decided to set the Upwards and Downwards facing Dropper textures with East and South. They couldn't bother setting a special blockshape for them, like the hopper. What a party pooper.
74+
75+
</details>
76+
77+
Available on BEComTweaks. [Link ↗](https://becomtweaks.github.io/resource-packs/?st_raw=N4IgTghg7iBcDaIAiBLMBTAxgFxQewDsIAbVAZwAd0Cz0wyQAaZNLXQkpMPCq%2BkALoBfIA)
78+
79+
**6. Most of the 3D Category**
80+
81+
Currently supported 3D Packs are 3D Mace and 3D Sun and Moon. [BEComTweaks](https://becomtweaks.github.io/resource-packs) also has 3D Fungi, but anything else is not possible mainly because Custom Geometry cannot be set for Vanilla Blocks. 3D Fungi itself was made using Azalea's Block Shape.
82+
83+
**7. Connected Textures**
84+
85+
Only borderless versions, like Borderless Glass is available, as a block is unable to check whether there is another block of the same type touching it. Shaders could be made, but they aren't officially supported on the main version.
86+
87+
**8. Wavy Leaves and Plants**
88+
89+
Either with a flipbook texture or shaders.
90+
91+
* Shaders\
92+
Not possible as it is not officially supported.[<sup>\[1\]</sup>](https://becomtweaks.github.io/docs/misc/impossible-packs.html#fn1)
93+
* Flipbook Texture\
94+
Very demanding, especially on mobile as it utilises extremely high resolution textures
95+
96+
**9. Fullbright/Hardcode Darkness/Warm Glow/Mob Spawn Indicator**
97+
98+
No shader support.
99+
100+
**10. Endless End Rods**
101+
102+
Requires a bit more testing. Theoretically, adding a `"blockshape": "block"` should fix it, but the block turns black.
103+
104+
**11. Randomly Rotated Sunflowers / Taller Sunflowers**
105+
106+
Custom Geometry can't be set for Vanilla Blocks.
107+
108+
**12. Redstone Power Levels**
109+
110+
No shader support. There is a buggy version by dhan on mcpedl which doesn't show directions. [Link ↗](https://mcpedl.com/redstone-signal-indicator-for-mcpe/)
111+
112+
**13. Groovy Levers**
113+
114+
Custom Geometry can't be set for Vanilla Blocks.
115+
116+
**14. Visual Sapling Growth**
117+
118+
No block states to depend on to change textures.
119+
120+
**15. No Beacon Beam**
121+
122+
Beacon Beam doesn't support opacity, so if I put a transparent texture, the beam would just turn black.
123+
124+
**16. Old Alex & Steve / Dungeons Alex & Steve**
125+
126+
Minecraft no longer loads Alex and Steve textures from resource packs.
127+
128+
**17. Big Dripleaf Stem Fix / Small Dripleaf Stem Fix**
129+
130+
Can't make sure the stem properly use the texture, so it could result in the wrong side having no stems
131+
132+
**18. Slime Particle Fix / Proper Break Particles / Don't Eat the Bowl**
133+
134+
Vanilla bug that cannot be fixed. The particles' colors cannot be changed and are hardcoded by default.
135+
136+
**19. Iron Bars Fix**
137+
138+
General Issue. Z-Fighting cannot usually be fixed unless the shader is properly set or the cube is above the other cube by the smallest dimensions. However, shaders can't be changed and custom geometry cannot be set.
139+
140+
**20. Pixel Consistent Trip Wire**
141+
142+
Custom Geometry can't be set for Vanilla Blocks.
143+
144+
**21. Diminshing Tools**
145+
146+
The current durability can be obtained, but the item texture cannot be changed based on the durability. Even if it was able to, there would be a ton of textures, lagging the game a lot.
147+
148+
**22. Spinning Skull on Fire Painting**
149+
150+
Minecraft Bedrock has all the painting in a single PNG file of resolution 256x256. There are, at minimum, 12 frames. The resolution would become 256x3072. Yeah.
151+
152+
### Crafting Tweaks <a href="#crafting-tweaks" id="crafting-tweaks"></a>
153+
154+
None at the moment.
155+
156+
### Behaviour Packs <a href="#behaviour-packs" id="behaviour-packs"></a>
157+
158+
**1. Player Heads**
159+
160+
**Player Drop Heads** is entirely possible as the game stands right now, but not how you would expect it to function. World Owners would have to do a bit or a lot of manual file editting to make the packs work, and you would be responsible for keeping it up to date as best as you can - we provide the script you provide the textures sort of arrangement.
161+
162+
<details>
163+
164+
<summary>Technical Jargon and Reasoning</summary>
165+
166+
The main reason a pack like this would work in game is its quite easy to make a custom block with the skull geometry and provide a flattened player skin (or part of it) so that the block will have all the correct textures on each side to represent the head, the issue stems from we have no way of doing just that without manually doing it. Whilst yes there is a HTTP library as part of the @minecraft Scripting API (not to be confused with Legacy Scripting), we cannot save the result of the call to the file system the server is running on, even with Bedrock Dedicated Server Software (the only place that currently is even allowed to use the HTTP library). So we cannot generate the "player head" blocks in runtime, which is ideally how and when it should be done so our pack remains small in size and compatible with everyone's systems.
167+
168+
</details>
169+
170+
There is hope and a possible solution, but its ugly. If someone was willing to put the effort into making a "Player Head Generator" we could ask players to upload their skins, then the system would generate a pack including all the skins they wanted (like Hermit Heads + our ugly mugs on the dev team) and their own, they could then use the generated pack. However this would require significant resources that DrAv cannot spare.
171+
172+
> \~ SquatchHunter, Moderator of drav.dev and member of Bedrock Tweaks
173+
174+
**2. Off-Hand**
175+
176+
It became impossible after 1.20 when Mojang updated the Beta API system to prevent any changes to the player on the gametick that an event happens. FoxyNoTail's [Offhand Addon](https://foxynotail.com/add-ons/off-hand/) heavily relied on this, as it needed the event to change objects from mainhand to offhand on the same gametick that you are placing the block.

gitbook/miscellaneous/faq.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
icon: question
3+
---
4+
5+
# FAQ
6+
7+
## FAQ <a href="#faq" id="faq"></a>
8+
9+
**1. When will Addons come back?**
10+
11+
Soon™
12+
13+
Addons will take a while to be added to [Bedrock Tweaks](https://bedrocktweaks.net) as DrAV is making some addon bases and making sure they work in the latest version, 1.21. Currently, [BEComTweaks](https://becomtweaks.github.io/behaviour-packs) still have some important addons.
14+
15+
**2. When will X be added? / Why is Y not added yet?**
16+
17+
Refer to Impossible Packs before asking this.
18+
19+
The list will continue to expand as more questions are asked.

gitbook/new-category.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Open the folder with VSCode. Inside the folder sidebar, open `jsons/packs`. Crea
1010

1111
### JSON Format
1212

13+
{% code overflow="wrap" lineNumbers="true" fullWidth="true" %}
1314
```json
1415
{
1516
"$schema": "https://becomtweaks.github.io/schema/packs.json",
@@ -19,6 +20,7 @@ Open the folder with VSCode. Inside the folder sidebar, open `jsons/packs`. Crea
1920
"packs": []
2021
}
2122
```
23+
{% endcode %}
2224

2325
The required keys are `topic` and `packs` while `$schema` helps for autocomplete (important!)
2426

@@ -53,9 +55,11 @@ Open the `app.js` inside `webUI` and add the following at the end of the `catego
5355

5456
Now run
5557

58+
{% code overflow="wrap" fullWidth="true" %}
5659
```sh
5760
python pys/pre_commit.py --format --no-stash
5861
```
62+
{% endcode %}
5963

6064
And it should be reflected inside `webUI/index.html`. Open it up with any browser and you should see the new category!
6165

gitbook/new-compatibility.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ icon: nfc
66

77
BEComTweaks had just received its overhauled compatibility handler, so here is a full doc on it
88

9-
<pre class="language-json"><code class="lang-json">{
9+
<pre class="language-json" data-overflow="wrap" data-line-numbers data-full-width="true"><code class="lang-json">{
1010
"max_simultaneous": 3,
1111
"3way": [
1212
{
@@ -60,6 +60,7 @@ Say you want to add a 4 way compatibility while using the example `compatibility
6060

6161
Here is how the key would look like
6262

63+
{% code overflow="wrap" lineNumbers="true" fullWidth="true" %}
6364
```json
6465
"4way": [
6566
{
@@ -74,6 +75,7 @@ Say you want to add a 4 way compatibility while using the example `compatibility
7475
}
7576
],
7677
```
78+
{% endcode %}
7779

7880
What do each of the keys do?
7981

gitbook/who-are-we.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
icon: face-thinking
3+
---
4+
5+
# Who are we?
6+
7+
We are **B**edrock **E**dition **Com**munity **Tweaks**, also known as BEComTweaks.
8+
9+
* Take BedrockTweaks as the popular guy in school.
10+
* BEComTweaks is that nerdy guy who wants the same attention.
11+
12+
Started out as a mini-project back in March, it is now a full-time project aimed to challenge Bedrock Tweaks.
13+
14+
***
15+
16+
#### What is the difference between BedrockTweaks and BEComTweaks? <a href="#what-is-the-difference-between-bedrocktweaks-and-becomtweaks" id="what-is-the-difference-between-bedrocktweaks-and-becomtweaks"></a>
17+
18+
1. More packs!
19+
* BEComTweaks has 500+ resource packs alone that is available right on our site. These did not have to be in VanillaTweaks and are available for more to know about.
20+
2. More updates!
21+
* BEComTweaks is updated daily!
22+
* This can be in branches or on the main one, but I assure you, we never lose our streak!
23+
3. Behaviour Packs!
24+
* BEComTweaks will always leave behaviour packs on! Addons are coming soon™ as well!

0 commit comments

Comments
 (0)