Skip to content

Commit 541f373

Browse files
Jamalam360Jamalam360
committed
updates
1 parent 5054e35 commit 541f373

File tree

6 files changed

+16
-139
lines changed

6 files changed

+16
-139
lines changed

‎docs/jamlib/config-api.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,14 @@ is easy.
3838
public class Config {
3939
public boolean requireHoe = false; // (1)
4040
public int rollTimes = 3; // (2)
41+
public List<Integer> listOfInts = new ArrayList<>(List.of(1, 2, 3)); // (3)
4142
}
4243
```
4344

4445
1. Config fields should be `public`, not `static`, and not `final`.
4546
2. The default value for this field is `3`. This will be used when making a new
4647
config or when this field is added to an old config.
48+
3. Lists are supported, but make sure that the default value is mutable - an `ArrayList` is a safe bet.
4749

4850
```java title="Your Mod Initializer"
4951
public class YourModInit { // (1)

‎docs/jamlib/getting-started.md‎

Lines changed: 12 additions & 119 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
![Supported on Quilt](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/cozy/supported/quilt_vector.svg)
2-
![Supported on Fabric](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/cozy/supported/fabric_vector.svg)
3-
![Supported on Forge](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/cozy/supported/forge_vector.svg)
4-
[![Available on Modrinth](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/cozy/available/modrinth_vector.svg)](https://modrinth.com/mod/jamlib)
5-
[![Available on CurseForge](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/cozy/available/curseforge_vector.svg)](https://www.curseforge.com/minecraft/mc-mods/jamlib)
6-
[![Available on GitHub](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/cozy/available/github_vector.svg)](https://github.com/JamCoreModding/jamlib)
7-
81
JamLib is a set of cross-platform APIs developed with Architectury that we use for all of our mods.
92

103
You are also free to use JamLib in your projects, hence we have created this documentation on it.
@@ -58,7 +51,7 @@ You are also free to use JamLib in your projects, hence we have created this doc
5851
}
5952
```
6053

61-
``` groovy title="forge/build.gradle"
54+
``` groovy title="neoforge/build.gradle"
6255
dependencies {
6356
// rest of dependencies block...
6457

@@ -68,14 +61,6 @@ You are also free to use JamLib in your projects, hence we have created this doc
6861
}
6962
```
7063

71-
``` groovy title="quilt/build.gradle"
72-
dependencies {
73-
// rest of dependencies block...
74-
75-
modImplementation "io.github.jamalam360:jamlib-quilt:${jamlib_version}"
76-
}
77-
```
78-
7964
=== "Using Version Catalogues"
8065

8166
``` toml title="Version Catalogue"
@@ -88,8 +73,7 @@ You are also free to use JamLib in your projects, hence we have created this doc
8873
# rest of libraries...
8974
jamlib-common = { module = "io.github.jamalam360:jamlib", version.ref = "jamlib" }
9075
jamlib-fabric = { module = "io.github.jamalam360:jamlib-fabric", version.ref = "jamlib" }
91-
jamlib-quilt = { module = "io.github.jamalam360:jamlib-quilt", version.ref = "jamlib" }
92-
jamlib-forge = { module = "io.github.jamalam360:jamlib-forge", version.ref = "jamlib" }
76+
jamlib-neoforge = { module = "io.github.jamalam360:jamlib-neoforge", version.ref = "jamlib" }
9377
```
9478

9579
``` groovy title="build.gradle"
@@ -125,24 +109,16 @@ You are also free to use JamLib in your projects, hence we have created this doc
125109
}
126110
```
127111

128-
``` groovy title="forge/build.gradle"
112+
``` groovy title="neoforge/build.gradle"
129113
dependencies {
130114
// rest of dependencies block...
131115

132-
modImplementation libs.jamlib.forge
133-
// Dependency of JamLib. Forge requires that we specify this
116+
modImplementation libs.jamlib.neoforge
117+
// Dependency of JamLib. NF requires that we specify this
134118
forgeRuntimeLibrary "blue.endless:jankson:1.2.3"
135119
}
136120
```
137121

138-
``` groovy title="quilt/build.gradle"
139-
dependencies {
140-
// rest of dependencies block...
141-
142-
modImplementation libs.jamlib.quilt
143-
}
144-
```
145-
146122
=== "Fabric"
147123

148124
=== "Using Gradle Properties"
@@ -208,72 +184,7 @@ You are also free to use JamLib in your projects, hence we have created this doc
208184
}
209185
```
210186

211-
=== "Quilt"
212-
213-
=== "Using Gradle Properties"
214-
215-
``` toml title="gradle.properties"
216-
# rest of properties file ...
217-
# find this at https://github.com/JamCoreModding/jamlib/releases
218-
jamlib_version=1.0.1
219-
```
220-
221-
``` groovy title="build.gradle"
222-
repositories {
223-
// rest of repositories block...
224-
225-
maven {
226-
name = "Jamalam's Maven"
227-
url = "https://maven.jamalam.tech/releases"
228-
229-
content {
230-
includeGroup "io.github.jamalam360"
231-
}
232-
}
233-
}
234-
235-
dependencies {
236-
// rest of dependencies block...
237-
238-
modImplementation "io.github.jamalam360:jamlib-quilt:${jamlib_version}"
239-
}
240-
```
241-
242-
=== "Using Version Catalogues"
243-
244-
``` toml title="Version Catalogue"
245-
[versions]
246-
# rest of versions...
247-
# find this at https://github.com/JamCoreModding/jamlib/releases
248-
jamlib = "1.0.1"
249-
250-
[libraries]
251-
# rest of libraries...
252-
jamlib = { module = "io.github.jamalam360:jamlib-quilt", version.ref = "jamlib" }
253-
```
254-
255-
``` groovy title="build.gradle"
256-
repositories {
257-
// rest of repositories block...
258-
259-
maven {
260-
name = "Jamalam's Maven"
261-
url = "https://maven.jamalam.tech/releases"
262-
263-
content {
264-
includeGroup "io.github.jamalam360"
265-
}
266-
}
267-
}
268-
269-
dependencies {
270-
// rest of dependencies block...
271-
272-
modImplementation libs.jamlib
273-
}
274-
```
275-
276-
=== "Forge"
187+
=== "NeoForge"
277188

278189
=== "Using Gradle Properties"
279190

@@ -300,8 +211,8 @@ You are also free to use JamLib in your projects, hence we have created this doc
300211
dependencies {
301212
// rest of dependencies block...
302213

303-
implementation fg.deobf("io.github.jamalam360:jamlib-forge:${jamlib_version}")
304-
// Dependency of JamLib. Forge requires that we specify this
214+
implementation fg.deobf("io.github.jamalam360:jamlib-neoforge:${jamlib_version}")
215+
// Dependency of JamLib. NF requires that we specify this
305216
forgeRuntimeLibrary "blue.endless:jankson:1.2.3"
306217
}
307218
```
@@ -316,7 +227,7 @@ You are also free to use JamLib in your projects, hence we have created this doc
316227

317228
[libraries]
318229
# rest of libraries...
319-
jamlib = { module = "io.github.jamalam360:jamlib-forge", version.ref = "jamlib" }
230+
jamlib = { module = "io.github.jamalam360:jamlib-neoforge", version.ref = "jamlib" }
320231
```
321232

322233
``` groovy title="build.gradle"
@@ -337,7 +248,7 @@ You are also free to use JamLib in your projects, hence we have created this doc
337248
// rest of dependencies block...
338249

339250
implementation fg.deobf(libs.jamlib)
340-
// Dependency of JamLib. Forge requires that we specify this
251+
// Dependency of JamLib. NF requires that we specify this
341252
forgeRuntimeLibrary "blue.endless:jankson:1.2.3"
342253
}
343254
```
@@ -356,27 +267,9 @@ Once JamLib is successfully in your development environment, you can add a depen
356267
}
357268
```
358269

359-
=== "Quilt"
360-
361-
``` json title="quilt.mod.json"
362-
{
363-
// rest of JSON
364-
"quilt_loader": {
365-
// rest of quilt_loader
366-
"depends": [
367-
// rest of depends
368-
{
369-
"id": "jamlib",
370-
"version": ">=1.0.0"
371-
}
372-
]
373-
}
374-
}
375-
```
376-
377-
=== "Forge"
270+
=== "NeoForge"
378271

379-
``` toml title="META-INF/mods.toml"
272+
``` toml title="META-INF/neoforge.mods.toml"
380273
[[dependencies.YOUR_MOD_ID]]
381274
modId = "jamlib"
382275
mandatory = true

‎docs/template-mod/getting-started.md‎

Lines changed: 0 additions & 16 deletions
This file was deleted.

‎docs/totally-balanced-bone-drops/configuration.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ If you are a player, you can configure TBBD via the configuration file. The conf
1818

1919
## For Developers, or Advanced Players
2020

21-
TBBD operates on a blacklist system. If a `LivingEntity` is not in the blacklist, it will drop a bone. The blacklist is in the form of an entity tag, located at `data/tb-bone-drops/tags/entity_types/blacklist.json`. You can use this to blacklist entities from dropping bones.
21+
TBBD operates on a blacklist system. If a `LivingEntity` is not in the blacklist, it will drop a bone. The blacklist is in the form of an entity tag, located at `data/tb-bone-drops/tags/entity_type/blacklist.json`. You can use this to blacklist entities from dropping bones.
2222

2323
### Default Entries
2424

‎docs/utility-belt/configuration.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,5 @@ Available options are documented in comments or tooltips.
1313
Utility Belt contains an item tag, `utility_belt:allowed_in_utility_belt`. The
1414
utility belt accepts several items by Java class (namely `TieredItem`, `Brush`, etc.), as well as those in
1515
this tag. If you want to add an item to the utility belt, add it to this tag
16-
(`/data/utility_belt/tags/items/allowed_in_utility_belt.json`).
16+
(`/data/utility_belt/tags/item/allowed_in_utility_belt.json`).
1717

‎mkdocs.yml‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,6 @@ nav:
2424
- Utility Belt:
2525
- Introduction to Utility Belt: utility-belt/about.md
2626
- Configuring Utility Belt: utility-belt/configuration.md
27-
- Template Mod:
28-
- Getting Started: template-mod/getting-started.md
2927

3028
theme:
3129
name: material

0 commit comments

Comments
 (0)