Skip to content

Commit b102a19

Browse files
committed
update readme again
1 parent 18e9bb0 commit b102a19

File tree

1 file changed

+46
-31
lines changed

1 file changed

+46
-31
lines changed

README.md

Lines changed: 46 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -4,58 +4,73 @@
44

55
# Debug Stick
66

7-
This add-on implements a debug stick based on Minecraft: Java Edition.
7+
This add-on is a port of the infamous Debug Stick item, that was
8+
exclusive from Minecraft: Java Edition.
9+
10+
[**MCPEDL**][mcpedl] · [**CurseForge**][curseforge]
811

912
</div>
1013

11-
> [*Now available on MCPEDL!*](https://mcpedl.com/debug-stick/)
14+
> [*Now in CurseForge!*](https://www.curseforge.com/minecraft-bedrock/addons/debug-stick)
1215
13-
### Features
16+
Ever wish Bedrock had Java's debug stick? Yeah, me too &mdash; so I made one.
1417

15-
Similar to Java Edition, you can:
18+
This add-on lets you mess with the "block properties" in-game, just like the
19+
Java-exclusive debug stick item. Tap blocks to change their states. Long-press
20+
to choose what you wanna change. Sneak and tap to get detailed info.
1621

17-
- Modify block properties
18-
- Update property values
19-
- View messages on the action bar
20-
- Block viewer (as of 1.6.0, mc 1.20.60)
22+
### ✨ What You Can Do?
2123

22-
This add-on has been tested and functions correctly with Minecraft: Bedrock
23-
Edition 1.20.0 and above.
24+
- Tap blocks to cycle through their states (e.g., waterlog chests, lit or
25+
unlit furnaces, make ladders stick on air, etc.)
26+
- Long press to choose what you wanna change (e.g., direction of the block,
27+
type of wood, etc.)
28+
- Action bar msgs help you figure out what you're changing!
29+
- Sneak + tap = show detailed infos about a block (more on that below!)
2430

25-
### How to Obtain
31+
### 🔍 Block Viewer (Bonus Feature!)
2632

27-
- Download the add-on from the [releases section][releases], or download the
28-
latest version (for the most recent Minecraft release) directly [here][dl].
29-
- Import the add-on into Minecraft.
30-
- Activate it in your world.
31-
- \* Enable Experimental `Beta APIs` and `Holiday Creator Features`.
32-
- Open your world.
33-
- Enter the following command in the chat:
33+
This is a Bedrock-only thing I've added! Just sneak and tap a block to get all
34+
kinds of infos you may need:
3435

35-
```text
36-
/give @s vyt:debug_stick
37-
```
36+
- **Block ID** (i.e., `minecraft:log`)
37+
- **Location** (`0 1 2`)
38+
- **Matter state** (solid, liquid, gas)
39+
- **Redstone power** (amount of redstone, 0-15)
40+
- **Hard block** (passable by arrows?)
41+
- **Property states** (`pillar_axis`, `waterlogged`, etc.)
42+
- **Tags** (`#wood`, `#log`, etc.)
3843

39-
> [!NOTE]
40-
> As of version 1.2.0 (mc 1.20.30), the `Holiday Creator Features` experiment
41-
> is no longer required.
44+
Very useful to mapmakers, redstoners, or just curious players!
4245

4346
> [!NOTE]
44-
> As of version 1.15.0 (mc 1.21.70), the `Beta APIs` experiment
45-
> is no longer required.
47+
> This feature requires Minecraft Bedrock 1.20.60 or higher
48+
49+
### 🎁 How To Get It?
4650

47-
### Limitations
51+
1. Download the add-on
52+
2. Import the add-on to Minecraft
53+
3. Activate it in your world
54+
4. If your Minecraft version is *lower than 1.20.30*, enable
55+
`Holiday Creator Features` experiment.
56+
5. If your Minecraft version is *lower than 1.21.70*, enable
57+
`Beta APIs` experiment.
58+
6. Load up your world!
59+
7. Type `/give @s vyt:debug_stick`, or check the Creative menu.
60+
8. That's it!
4861

49-
- Some block properties from Minecraft: Java Edition are not accessible due to
50-
platform differences and parity limitations.
62+
### 🎉 Support
5163

52-
### Contribution
64+
If this helped you out, consider supporting me on Ko-fi! Every bit helps me
65+
stay in school and keep the add-on updated! ❤️
5366

54-
Feel free to contribute to the add-on.
67+
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/W7W51I5VSO)
5568

5669
### License
5770

5871
Copyright &copy; 2023-2025 Vincent Yanzee J. Tan. Licensed under the MIT License.
5972

73+
[mcpedl]: https://mcpedl.com/debug-stick
74+
[curseforge]: https://www.curseforge.com/minecraft-bedrock/addons/debug-stick
6075
[releases]: https://github.com/vytdev/debug-stick/releases
6176
[dl]: https://github.com/vytdev/debug-stick/releases/latest/download/debug-stick.mcpack

0 commit comments

Comments
 (0)