Skip to content

Commit b7cafae

Browse files
authored
Revise README for Interactive Block Prompt mod
Updated README to enhance clarity and add details about current icons and tags.
1 parent 32f1730 commit b7cafae

1 file changed

Lines changed: 20 additions & 19 deletions

File tree

README.md

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,26 @@
1+
<img src="https://s41.ax1x.com/2026/03/04/pe9rOKJ.png" width="50%" alt="title">
12

2-
Installation information
3-
=======
3+
---
4+
**Interactive Block Prompt** is a QoL mod designed for map and modpack creators. It adds more functionality to the crosshair, introducing several icon indicators on its right side. These icons appear when the player looks at specific blocks, offering a more intuitive way to guide player interaction.
45

5-
This template repository can be directly cloned to get you started with a new
6-
mod. Simply create a new repository cloned from this one, by following the
7-
instructions provided by [GitHub](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template).
6+
The mod itself does not add new content, only including a few block prompts as examples. **Creators can customize it freely by modifying tags via Datapacks or mods like KubeJS, allowing them to configure which icon is displayed for each block as they wish.**
87

9-
Once you have your clone, simply open the repository in the IDE of your choice. The usual recommendation for an IDE is either IntelliJ IDEA or Eclipse.
8+
### Current Icons and Corresponding Tags:
9+
* 🔍 Search - `ibp:search`
10+
* 👆 Click - `ibp:click`
11+
* 📖 Book - `ibp:book`
12+
* ❓ Point of Interest - `ibp:interest`
13+
* ❗ Notice - `ibp:notice`
14+
* 🔧 Wrench - `ibp:wrench`
15+
* ⏺️ Button - `ibp:button`
16+
* 🕹️ Toggle - `ibp:toggle`
1017

11-
If at any point you are missing libraries in your IDE, or you've run into problems you can
12-
run `gradlew --refresh-dependencies` to refresh the local cache. `gradlew clean` to reset everything
13-
{this does not affect your code} and then start the process again.
18+
---
19+
![icon](https://s41.ax1x.com/2026/03/04/pe9rjbR.png)
20+
---
1421

15-
Mapping Names:
16-
============
17-
By default, the MDK is configured to use the official mapping names from Mojang for methods and fields
18-
in the Minecraft codebase. These names are covered by a specific license. All modders should be aware of this
19-
license. For the latest license text, refer to the mapping file itself, or the reference copy here:
20-
https://github.com/NeoForged/NeoForm/blob/main/Mojang.md
22+
Special thanks to **TimyaSifer** for drawing the adorable icons!
2123

22-
Additional Resources:
23-
==========
24-
Community Documentation: https://docs.neoforged.net/
25-
NeoForged Discord: https://discord.neoforged.net/
24+
The mod is continuously being updated, with plans to support more Minecraft versions and add more features in the future.
25+
26+
_*You can be free to use this mod in your modpacks, and you can even distribute it directly without needing to redirect back to this link._

0 commit comments

Comments
 (0)