Skip to content

Commit 0afa09e

Browse files
committed
Merge remote-tracking branch 'origin/1.21.1' into 1.21.1
2 parents 447ff2f + 1af92a9 commit 0afa09e

1 file changed

Lines changed: 71 additions & 0 deletions

File tree

MOD_DESCRIPTION.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
![CurseForge Downloads](https://img.shields.io/curseforge/dt/1241061?style=for-the-badge&logo=curseforge&color=ff784d)
2+
![Modrinth Downloads](https://img.shields.io/modrinth/dt/toolsjs?style=for-the-badge&logo=modrinth&color=17b85a)
3+
4+
5+
# ToolsJS
6+
A [KubeJS](https://kubejs.com) addon for creating tools! Any type of tools! Includes all tools and features of [CucumberJS](https://git.bluemethyst.dev/CucumberJS), PaxelJS and lots of new ones!
7+
8+
## Dependencies
9+
[Kotlin for Forge](https://modrinth.com/mod/kotlin-for-forge)
10+
11+
[KubeJS](https://modrinth.com/mod/kubejs/)
12+
13+
[Ex Deorum](https://modrinth.com/mod/ex-deorum/) (Optional, if you plan to use tools from that mod)
14+
15+
## Usage
16+
```js
17+
StartupEvents.registry("item", (event) => {
18+
event.create("test_hammer", "exdeorum:hammer").tag("exdeorum:hammers");
19+
event.create("test_crook", "exdeorum:crook").tag("exdeorum:crooks");
20+
event.create("test_mesh", "exdeorum:mesh");
21+
event.create("test_wateringcan", "exdeorum:watering_can").capacity(3000);
22+
event.create("test_brush", "brush");
23+
event.create("test_shield", "shield");
24+
event.create("test_paxel", "paxel");
25+
event.create("test_bow", "bow");
26+
event.create("test_crossbow", "crossbow");
27+
event.create("fishing_rod", "fishing_rod");
28+
});
29+
```
30+
You can also use built in textures to help create your tools quickly. This one will make the paxel head a different colour.
31+
View the built-in textures [here](https://github.com/Bluemethyst/ToolsJS/tree/1.21.1/src/main/resources/assets/toolsjs/textures/item)
32+
```js
33+
StartupEvents.registry("item", (event) => {
34+
event
35+
.create("test_paxel", "paxel")
36+
.texture("layer0", "toolsjs:item/paxel_handle")
37+
.texture("layer1", "toolsjs:item/paxel")
38+
.color(1, 0x74c7ec);
39+
});
40+
```
41+
![img.png](https://github.com/Bluemethyst/ToolsJS/blob/1.21.1/.github/assets/custom_paxel.png?raw=true)
42+
43+
An example of horse armor with the diamond item texture and armor texture.
44+
```js
45+
StartupEvents.registry("item", (event) => {
46+
event
47+
.create("test_horse_armor", "horse_armor")
48+
.material("diamond")
49+
.armorTexture(
50+
"minecraft:textures/entity/horse/armor/horse_armor_diamond"
51+
)
52+
.texture("minecraft:item/diamond_horse_armor");
53+
});
54+
55+
```
56+
57+
Here is an example of a custom crossbow with a custom texture.
58+
You need to name the item you are creating the same as the texture and model file names as shown below.
59+
There are also no built-in texture and model files for this reason, and you will have to copy your own from the vanilla versions.
60+
You can find them easily at [mcasset.cloud](https://mcasset.cloud/).
61+
```js
62+
StartupEvents.registry("item", (event) => {
63+
event.create("crossbow", "crossbow");
64+
});
65+
```
66+
![img.png](https://github.com/Bluemethyst/ToolsJS/blob/1.21.1/.github/assets/crossbow_models.png?raw=true)![img_1.png](https://github.com/Bluemethyst/ToolsJS/blob/1.21.1/.github/assets/crossbow_textures.png?raw=true)
67+
68+
## Credits
69+
All paxel code and tagging code from [Cucumber Library by BlakeBr0 under MIT license](https://github.com/BlakeBr0/Cucumber)
70+
71+
All built in textures provided by [FooterManDev](https://github.com/FooterManDev)

0 commit comments

Comments
 (0)