addonscript-spec/docs/concepts/instance.md

16 lines
951 B
Markdown
Raw Normal View History

2022-09-03 21:23:53 +02:00
# Instance addons
Instance addons represent instances of Minecraft itself, while non-instance addons
have to be installed into an existing instance of Minecraft. An instance addon MUST have
2022-09-03 21:23:53 +02:00
a launch configuration for each side for which it is available. This means, that an instance
addon MUST have exactly one [file](../schema/file.md) or [relation](../schema/relation.md)
for each side, which has the `launch` [flag](flags.md) flag. A file MUST NOT have this flag
on both sides, since the file type is different for each side, while a relation MAY have
2022-09-03 21:23:53 +02:00
it on both sides, as long as the related addon is itself an instance addon for both sides.
## Instance addons as relations
If an instance addon is a relation of another instance addon, each side of that
2022-09-12 14:54:05 +02:00
relation MUST have at least one of the [flags](flags.md) `included`, `launch`, `env`
or `incompatible`. Non-instance addons MAY have instance addons as relations without
2022-09-03 21:23:53 +02:00
this restrictions.