addonscript/addonscript-spec
addonscript/addonscript-spec
1
1
Fork 2
Code Issues 3 Pull requests 1 Projects Releases 3 Wiki Activity
addonscript-spec/docs/concepts/flags.md
Timo Ley afd8a4b37b
All checks were successful
continuous-integration/drone/pr Build is passing
Details
env builder API now parts of repositories
2022-09-26 10:17:50 +02:00

5.2 KiB
Raw Blame History

Flags

Flags are side-specific information about a manifest, file or relation. There are two types of flags: manifest flags and relational flags. Manifest flags provide information about an addon manifest, including for which side it is available and for which side it is an instance addon. Relational flags provide information about how a file or relation is related to the addon.

Manifest flags

  • required This flag specifies, that the addon of the manifest is required on the side which has this flag set, meaning, that if the other side has this addon installed, this side also required this addon to be compatible. If the other side has the incompatible flag set, this flags behaves exactly like the optional flag, but required is the prefered flag in this case.
  • optional This flag specifies, that the addon of the manifest is optional on the side which has the flag set, meaning, that this addon is not required on this side to be compatible, even if the other side has this addon installed.
  • incompatible This flag specifies, that the manifest is not compatible with the side which has this flag set. If a side has this flag, this side will completly be ignored for the manifest.
  • instance This flag specifies, that this is a manifest of an instance addon.
  • env This flag is only valid for instance addons. It specifies, that the environment builder API will be used to get the launch files for this addon. An addon with this flag MUST have a repository for it's canonical namespace.

Relational flags

  • required This flag specifies, that the related addon or file is required for the addon. If the addon gets installed, than any relation or file, which has this flag set, also has to be installed.
  • optional This flag specifies, that the related addon or file is optional for this addon. If the addon gets installed, the user SHOULD be able to choose, whether he wants to install the relation or file with this flag, or not.
  • included This flag is only valid for relations. It specifies, that the related addon is included in this one. This also means, that if some addon requires the related addon, it can also be installed with this addon instead. Relations with this flag MUST have an exact version specified, a version range, which includes multiple versions is not allowed. If this flag is used together with required or optional, the files of the related addon will be installed like if the relation wouldn't have this flag, relations of the related addon will however be ignored since AddonScript assumes, that they are already covered by this addon.
  • incompatible This flag specifies for a relation, that the related addon is incompatible to this one, which means, that they can't be installed together in the same instance. For a file this flag specifies, that the file can't be installed on the side which has this flag set.
  • launch This flag is only valid for instance addons. For a relation this flag specifies, that the launch configuration will be delegated to the related addon. The related addon MUST also be an instance addon on that side. For a file this flag specifies, that the file will be the launch file of this addon. On the client side the launch file MUST be a client JSON file which contains the client launch configuration. On the server side the launch file MUST be an executable jar file, which will be executed to start the server. This jar file will implicitly be installed by being moved to the root of the server directory. This flag always also implies any effect of required.
  • env This flag is only valid for relations of instance addons. It MUST only be used for instance addons, that either have the env manifest flag or are delegating the launch configuration to such an addon. This flag speficies, that the related addon will be requested to be part of the launch environment. For the addon, for which the launch environment will be build, it is used together with the required or optional flag to specify, which addons are required for the launch environment, which are optional and which versions of them are valid. An addon, that is delegating the launch configuration to one, which has the env manifest flag, uses this flag to tell AddonScript, which version of the addons will be requested for the environment by setting an exact version for the relation. It also tells AddonScript, which optional env addons will be part of the environment. If an addon with the env manifest flag gets manually installed, meaning not as a dependency, the user SHOULD be asked, which optional env addons and which version of each env addon will be requested.