You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+90-73Lines changed: 90 additions & 73 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,10 +5,10 @@
5
5
## Description
6
6
This is a simple and small mod that adds some simple decorative blocks such as cabinets (which are fancier types of item frames) as well as some vanilla block variations.
7
7
<br>
8
-
It specializes in procedurally generating variants of the same block so that you can always find the look you were searching for.
8
+
It specialises in procedurally generating variants of the same block so that you can always find the look you were searching for.
9
9
10
10
### Download
11
-
The only official downloads are from [**Modrinth**](https://modrinth.com/mod/humility-afm/versions) and [Github](https://github.com/MikiP98/HumilityAFM)
11
+
The only official downloads are from [**Modrinth**](https://modrinth.com/mod/humility-afm/versions) and [GitHub](https://github.com/MikiP98/HumilityAFM)
12
12
I can't ensure any other downloads are safe and don't include viruses
13
13
PLS download the mod from Modrinth if you can
14
14
@@ -84,64 +84,66 @@ Lighten up your builds with unobtrusive light source
84
84
85
85
## Roadmap:
86
86
87
-
### Done in the development version:
88
-
89
-
-~~Fix long block breaking caused by mining tag failure when not all features are enabled~~
90
-
-~~Add Standing Candlestick variants~~
91
-
-~~Add floor and ceiling variants of the cabinets~~
92
-
-~~Convert all the Python code to Java Fabric Datagen~~
93
-
-~~Restructure the code a bit *(e.g. dedicated registry files)*~~
94
-
-~~Add `Fully resourcepack compatible!` to the `Features` section in the readme~~
95
-
-~~Compress candlesticks into 4 items for each metal type~~
96
-
-~~Move VoxelShapes from switches to maps or variables~~
97
-
-~~Fix Light Strips loosing their Block Entity~~
98
-
-~~Fix Light Strip brightening breaking on corner pieces~~
99
-
-~~Fix Light Strip voxel shape~~
100
-
-~~Fix candlestick waterlog ability~~
101
-
-~~Improve Cabinet rendering~~
102
-
-~~Improve config logic~~
103
-
-~~Fix Cabinet open and close models not matching and cabinet inside texture stretch~~
104
-
-~~De-separate the particle texture from the block texture in cabinets and others~~
105
-
-~~Make Redstone Jack o'Lanterns to turn off when powered~~
106
-
-~~Make Soul Jack o'Lanterns special in some way (for now particles)~~
-~~Rename LEDs to light strips, consider enabling them by default?~~
116
-
-~~Make coloured Jack o'Lanterns~~
117
-
-~~Finish coloured torches and jack o'Lanterns textures~~
118
-
-~~Fix built-in cabinet resourcepacks~~
87
+
### Done:
88
+
89
+
- Add special built-in mod support for:
90
+
- BetterNether
91
+
- BetterEnd
92
+
- Biomes o' Plenty
93
+
- Fix nether wood block variants burning
94
+
- Move duplicated code to Interfaces (candlesticks)
95
+
- Reworked the whole block generation system
96
+
- Add an optional datapack with alternate, non crafting-table colliding, wooden mosaic recipes
97
+
- This datapack will be disabled by default on MC versions from 1.20.1 (included) to 1.21.4 (excluded)
98
+
- From 1.21.4 onwards, the datapack will be enabled by default because of `polymorph` mod's absence
119
99
120
100
### High priority:
121
101
122
-
- Rethink the README structure
123
102
- Redo the window capture screenshots or at least crop the window app bar
124
-
- Fix Cabinet breaking animation being invisible:
103
+
- Fix Cabinet breaking animation being invisible
125
104
- Make sure all other breaking animations are also visible
126
-
127
-
128
-
### Medium priority:
129
-
130
105
- Finish built-in jack o'Lantern rp compat resourcepack
131
106
- Finish built-in coloured torches rp compat resourcepack
132
-
- Improve the speciality of Soul Jack o'Lantern :/
133
107
- Add 'Shimmer' and 'Bliss' support for all the blocks from coloured feature set:
134
108
- Coloured Torches
135
109
- Coloured Jack o'Lanterns
136
110
- Light Strips
111
+
- Add Illuminated Cabinet Brightening to the config
112
+
- Add PBR data to:
113
+
- Cabinet front texture:
114
+
- LabPBR specular (pixels only)
115
+
- Optional resourcepacks for:
116
+
- LabPBR specular (full texture)
117
+
- Jack o'Lanterns textures:
118
+
- vanilla emission (coloured face only)
119
+
- LabPBR emission (coloured face only)
120
+
- Optional resourcepacks for:
121
+
- vanilla emission (full texture)
122
+
- LabPBR emission (full texture)
123
+
- Redo coloured torch textures using the Jack o'Lantern palette system
124
+
- Reduce the number of coloured torches and jack o'Lanterns
125
+
- Think of a system that can replace the current 3 blocks per colour with different light output levels
126
+
- Improve the built-in mod support for:
127
+
- BetterNether
128
+
- BetterEnd
129
+
- Biomes o' Plenty
130
+
- Add stone variants from the above mods, and fix the missing wood variants
131
+
- Add special built-in mod support for:
132
+
- DivineRPG
133
+
- Couple other mods with custom wood types
134
+
- Move duplicated code to Interfaces (cabinet block entity renderers)
135
+
136
+
### Medium priority:
137
+
138
+
- Improve the speciality of Soul Jack o'Lantern :/
139
+
- Make them work as bookshelves for enchanting?
140
+
- Make them boost monster spawners?
141
+
- Make them scare away Endermen or other mobs?
137
142
- Add Fancy carpets
138
143
- Add hanging pots
139
144
- Add hanging candlesticks
140
145
- Add more candlestick variants:
141
146
- small, medium, large, etc.
142
-
- Re-add Better Nether built-in support
143
-
- Add Better End built-in support
144
-
- Add Biomes o' Plenty built-in support
145
147
- Add correct map colours to generated blocks:
146
148
- Cabinets and Illuminated Cabinets
147
149
- Candlesticks
@@ -153,27 +155,14 @@ Lighten up your builds with unobtrusive light source
153
155
- Forced Corner Stairs
154
156
- Rethink cabinet opening, item insertion and removal, and such
155
157
- Add the ability to rotate items displayed in the cabinets
156
-
- Fix nether wood block variants burning
157
-
- Add Illuminated Cabinet Brightening to the config
158
-
- Port to newer MC versions:
159
-
- 1.21.4 *(need to wait for 'polymorph')*
160
158
- Expand Light Stips:
161
159
- Vertical mount
162
160
- Fit multiple Light Strips in 1 block
163
161
- Make coloured flame particles for coloured torches
164
-
- Add PBR data to:
165
-
- Cabinet front texture:
166
-
- LabPBR specular (pixels only)
167
-
- Optional resourcepacks for:
168
-
- LabPBR specular (full texture)
169
-
- Jack o'Lanterns textures:
170
-
- vanilla emission (coloured face only)
171
-
- LabPBR emission (coloured face only)
172
-
- Optional resourcepacks for:
173
-
- vanilla emission (full texture)
174
-
- LabPBR emission (full texture)
175
-
- Redo coloured torch textures using Jack o'Lantern palette system
176
-
162
+
- Improve the sounds by varying the pitch and volume slightly
163
+
- Optimise the model datagen
164
+
- Convert the config from JSON to TOML
165
+
- Consider making Polymorph an optional dependency, now with the alternative wooden mosaic recipie datapack it is no longer needed, that said people might still be confused if they didn't have either enabled/installed
177
166
178
167
### Low/unknown priority:
179
168
@@ -182,8 +171,6 @@ Lighten up your builds with unobtrusive light source
182
171
- Add carpet covered stairs?
183
172
- Server feature sync?
184
173
- If done through a datapack, the blocks can be enabled by default on the client?
185
-
- Port to newer MC versions:
186
-
- 1.21.5? *(need to wait for 'polymorph')*
187
174
- Backport to older MC versions?:
188
175
- 1.19.2?
189
176
- 1.18.2?
@@ -193,14 +180,10 @@ Lighten up your builds with unobtrusive light source
193
180
- 1.7.10?
194
181
- 1.0?
195
182
- Add crafting table on a stick?:
196
-
- If the right-clicked block has a recipie that requires only itself and output only 1 other block, it will replace the right-clicked block with the output block from that recipe
183
+
- If the right-clicked block has a recipe that requires only itself and outputs only one other block, it will replace the right-clicked block with the output block from that recipe
197
184
- Add variant choosing block?:
198
185
- A GUI block that will show all the variants that can be crafted in the crafting table following the *crafting table on a stick* logic, and it will allow you to choose the variant you want to craft
199
-
- Should be really useful for candlesticks if they would get a lot of variants
200
-
- Make Light Strips and Candlesticks into integrated datapacks?:
201
-
- Because of new tag system, the vanilla tool tags should no longer break, so at most this will fix the console spam with disabled features
202
-
- Make BetterNether and BetterEnd support into integrated datapacks?
203
-
- Because of new tag system, the vanilla tool tags should no longer break, so at most this will fix the console spam with disabled features
186
+
- It Should be really useful for candlesticks if they get a lot of variants
204
187
- Consider doing a HumilityLib library mod for config or such?
- Add thin <sup>*(Blibiocraft style)*</sup> and short cabinets?
@@ -215,9 +198,9 @@ Lighten up your builds with unobtrusive light source
215
198
**A:** Depends, I'm interested in supporting multiple MC versions, but can't support all of them.
216
199
If you want support for specific MC version pls create an [issue on GitHub](https://github.com/MikiP98/HumilityAFM/issues)
217
200
218
-
**Q:** Can you port to mod to forge?
201
+
**Q:** Can you port to mod to forge?
219
202
**A:** I wanted this to be a forge mod, but I just could get even the empty template to work and I gave up.
220
-
I'm not planing on porting the mod myself, but if you are interested in porting it yourself, you can, pls let me know of such projects on Github :)
203
+
I'm not planing on porting the mod myself, but if you are interested in porting it yourself, you can, pls let me know of such projects on GitHub :)
221
204
You can also use the mod [Kilt](https://github.com/KiltMC/Kilt) to run forge mods on fabric
222
205
223
206
**Q:** Why don’t I see *Light Strips* / *Coloured Torches* / *Coloured Jack o'Lanterns* in my game?
@@ -226,8 +209,8 @@ You can also use the mod [Kilt](https://github.com/KiltMC/Kilt) to run forge mod
226
209
**Q:** Why don’t my *Light Strips* / *Coloured Torches* / *Coloured Jack o'Lanterns* emit coloured light?
227
210
**A:** For coloured lighting you need a separate compatible mod or shader. For now this includes [**Bliss** shader](https://github.com/MikiP98/Bliss-Shader) and [**Shimmer** mod](https://modrinth.com/mod/shimmer!)
228
211
If the light sources still don't emmit coloured light:
229
-
When using Shimmer mod, there is probably some mod incompatibility. Try disabling the 'NVIDIUM' mod if present and it should start working again, if 'NVIDIUM' is not the causem try asking in Shimmer DC server for help
230
-
When using Bliss shader, make sure to load it via [Iris](https://modrinth.com/mod/iris) or [Oculus](https://modrinth.com/mod/oculus) and __***not***__ using **Optifine**! Then make sure floodfill option is enabled in the shader settings
212
+
When using **Shimmer** mod, there is probably some mod incompatibility. Try disabling the 'NVIDIUM' mod if present and it should start working again, if 'NVIDIUM' is not the cause try asking in Shimmer DC server for help
213
+
When using **Bliss** shader, make sure to load it via [Iris](https://modrinth.com/mod/iris) or [Oculus](https://modrinth.com/mod/oculus) and __***not***__ using **Optifine**! Then make sure floodfill option is enabled in the shader settings
231
214
232
215
**Q:** Why is the inside of Cabinets transparent?
233
216
**A:** Sodium <0.6.0 has issues with rendering transparency. You can try replacing it with Embeddium or installing other mods, like NVIDIUM, may help fix the problem. If that doesn't help, you can disable partial Cabinet transparency in the configuration (you will still be able to see the items inside)
@@ -238,4 +221,38 @@ You can also use the mod [Kilt](https://github.com/KiltMC/Kilt) to run forge mod
-[**Biomes o' Plenty**](https://modrinth.com/mod/biomes-o-plenty)
245
+
-*Dependencies of the above mods*
246
+
3. Run command `./gradlew runDatagen` or `gradlew runDatagen` in the terminal
247
+
- When the command fails, enable `datagenMode` in the config file under `./build/datagen/config/humility-afm.json`
248
+
4. Move the content *(the inside of the folder)* of `src/main/generated/data/humility-afm/recipies/datapack` to `src/main/resources/resourcepacks/alternate_wooden_mosaics_recipes/data/humility-afm/recipies/`
249
+
5. Move the content *(the inside of the folder)* of `src/main/generated/data/humility-afm/advancements/recipes/misc/datapack` to `src/main/resources/resourcepacks/alternate_wooden_mosaics_recipes/data/humility-afm/advancements/recipes/misc/`
250
+
6. Run command `./gradlew build` or `gradlew build` in the terminal
251
+
7. The compiled mod jar should be located in `./build/libs/` folder
252
+
253
+
[//]: #(TODO: Create a script to automate the above steps, or at least step 4)
254
+
255
+
<br>
256
+
257
+
241
258
*Checkout my [other mods](https://modrinth.com/user/Miki-Liki) :)*
0 commit comments