Skip to content

Commit 7f27bca

Browse files
committed
update readme for curseforge compliance
1 parent b87f14e commit 7f27bca

File tree

2 files changed

+31
-28
lines changed

2 files changed

+31
-28
lines changed

README-curseforge.md

Lines changed: 26 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Debug Stick
22

3-
This add-on is a port of the infamous Debug Stick item, that was
4-
exclusive from Minecraft: Java Edition.
3+
This add-on is a port of the infamous Debug Stick item that was
4+
exclusive to Minecraft: Java Edition.
55

6-
[**Skip to the download page**][lnk-website-dl]
6+
[**Skip to the download page**][curseforge-dl]
77

88
Ever wish Bedrock had Java's debug stick? Yeah, me too — so I made one.
99

@@ -18,7 +18,7 @@ to choose what you wanna change. Sneak and tap to get detailed info.
1818
- **Long-press** to choose what you wanna change (e.g., direction of the
1919
block, type of wood, etc.)
2020
- **Sneak + tap** to show detailed info about a block (more on that below!)
21-
- **Actionbar msgs** help you figure out what you're changing!
21+
- **Actionbar messages** help you figure out what you're changing!
2222

2323
## 🔍 Block Viewer (Bonus Feature!)
2424

@@ -35,7 +35,7 @@ kinds of info you may need:
3535
- **Property states** (`pillar_axis`, `waterlogged`, etc.)
3636
- **Tags** (`#wood`, `#log`, etc.)
3737

38-
Very useful to mapmakers, redstoners, or just curious players!
38+
Very useful for mapmakers, redstoners, or just curious players!
3939

4040
*(This feature requires Minecraft Bedrock 1.20.60 or higher)*
4141

@@ -49,7 +49,7 @@ Very useful to mapmakers, redstoners, or just curious players!
4949
5. If your Minecraft version is *lower than 1.21.70*, enable
5050
`Beta APIs` experiment.
5151
6. Load up your world!
52-
7. Type `/give @s vyt:debug_stick`, or check the Creative menu.
52+
7. Type `/give @s vyt:debug_stick`, or find it in the Creative menu.
5353
8. That's it!
5454

5555
## 📂 Where To Download?
@@ -66,20 +66,7 @@ harder to ensure you're selecting the right version.
6666
MCPEDL). Other sites may host *unofficial, outdated, or unsafe copies*
6767
that could contain malware or break your game.
6868

69-
### 📦 On My Website (recommended)
70-
71-
[Linkvertise → My Website (recommended)][lnk-website-dl]
72-
73-
This is the **easiest way**. Just find your Minecraft version and click
74-
the download link. How this works?
75-
76-
1. Find your Minecraft version and download.
77-
78-
That's all!
79-
80-
### 📦 On CurseForge
81-
82-
[Linkvertise → CurseForge][lnk-curseforge-dl]
69+
### 📦 On [CurseForge][curseforge-dl] (primary)
8370

8471
If you're on mobile, switch to "Desktop Mode" so the download button
8572
appears. Then:
@@ -89,9 +76,7 @@ appears. Then:
8976
3. Pick the matching add-on release
9077
4. Click "Download" (the middle button, not the one on the far right)
9178

92-
### 📦 On GitHub
93-
94-
[Linkvertise → GitHub][lnk-github-dl]
79+
### 📦 On [GitHub][github-dl] (mirror)
9580

9681
Each release lists the Minecraft versions it was tested with, like:
9782

@@ -102,6 +87,16 @@ If your Minecraft version is listed, that's the one you want. Then:
10287
1. Open the "Assets" section
10388
2. Download either the `.zip` or `.mcpack` file
10489

90+
### 📦 On [My Website][website-dl] (alternative)
91+
92+
If CurseForge didn't work and GitHub feels a bit clunky, you can use this
93+
simpler alternative:
94+
95+
1. Find your Minecraft version
96+
2. Click the link beside it
97+
98+
The download links go directly to GitHub. No ads or redirects.
99+
105100
## 🧱 Version Compatibility
106101

107102
This add-on supports Minecraft Bedrock **1.20.0 and above**.
@@ -126,6 +121,14 @@ Licensed under the MIT License.
126121

127122
[img-blk-viewer]: https://raw.github.com/vytdev/debug-stick/master/doc/img1.jpeg
128123

124+
[curseforge-dl]: https://www.curseforge.com/minecraft-bedrock/addons/debug-stick/files
125+
[github-dl]: https://github.com/vytdev/debug-stick/releases
126+
[website-dl]: https://vytdev.github.io/download-debug-stick
127+
128+
<!--
129+
Should've used these earlier...
130+
129131
[lnk-website-dl]: https://direct-link.net/1373084/EMeQm1IBE4wK
130132
[lnk-curseforge-dl]: https://link-hub.net/1373084/Ac5n1vWxuSms
131133
[lnk-github-dl]: https://direct-link.net/1373084/hhcQIngXp7Fc
134+
-->

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44

55
# Debug Stick
66

7-
This add-on is a port of the infamous Debug Stick item, that was
8-
exclusive from Minecraft: Java Edition.
7+
This add-on is a port of the infamous Debug Stick item that was
8+
exclusive to Minecraft: Java Edition.
99

1010
[**MCPEDL**][mcpedl] &middot; [**CurseForge**][curseforge]
1111

@@ -26,7 +26,7 @@ to choose what you wanna change. Sneak and tap to get detailed info.
2626
- **Long-press** to choose what you wanna change (e.g., direction of the
2727
block, type of wood, etc.)
2828
- **Sneak + tap** to show detailed info about a block (more on that below!)
29-
- **Actionbar msgs** help you figure out what you're changing!
29+
- **Actionbar messages** help you figure out what you're changing!
3030

3131
## 🔍 Block Viewer (Bonus Feature!)
3232

@@ -43,7 +43,7 @@ kinds of info you may need:
4343
- **Property states** (`pillar_axis`, `waterlogged`, etc.)
4444
- **Tags** (`#wood`, `#log`, etc.)
4545

46-
Very useful to mapmakers, redstoners, or just curious players!
46+
Very useful for mapmakers, redstoners, or just curious players!
4747

4848
> [!NOTE]
4949
> This feature requires Minecraft Bedrock 1.20.60 or higher
@@ -58,7 +58,7 @@ Very useful to mapmakers, redstoners, or just curious players!
5858
5. If your Minecraft version is *lower than 1.21.70*, enable
5959
`Beta APIs` experiment.
6060
6. Load up your world!
61-
7. Type `/give @s vyt:debug_stick`, or check the Creative menu.
61+
7. Type `/give @s vyt:debug_stick`, or find it in the Creative menu.
6262
8. That's it!
6363

6464
## 🧱 Version Compatibility

0 commit comments

Comments
 (0)