update readme with notice

This commit is contained in:
FalsePattern committed 2024-11-14 21:22:10 +01:00
1 parent 09d7677541
commit 3a4194a3ff
1 file changed
+6 -2
+6 -2
View File
@@ -101,9 +101,9 @@ If you find any crashes or incompatibilities, don't hesitate to open an issue.
## Depending On Metadata Increase In Another Mod
**NOTE:** This API is available as of version <!--TODO--> of EndlessIDs.
**NOTE:** This API is available as of version TODO of EndlessIDs.
EndlessIDs implements the common ID Extender API added in NotEnoughIDs Unofficial. See:
EndlessIDs implements the common ID Extender API introduced in NotEnoughIDs Unofficial. See:
https://github.com/GTNewHorizons/NotEnoughIds/pull/17
The description below is an excerpt of NEID-U's readme concerning this API:
@@ -135,6 +135,10 @@ if (Loader.isModLoaded("idextender")){
}
```
Note that these values CAN be identical to the vanilla values if the ID Extension mod implementing it has a config to
toggle itself, existence of the IDExtender class does not guarantee a fixed increase, and you should check that the
returned value is large enough for your needs.
If for some reason, you need to know what parent mod is providing the `idextender` mod, you can do the following, which will give you
back the Mod ID of the actual mod that has provided `idextender`. For example, `endlessids`: