addonscript-spec/README.md

37 lines
1.8 KiB
Markdown
Raw Normal View History

2021-07-02 22:53:50 +02:00
# AddonScript
2022-02-18 13:02:24 +01:00
The official AddonScript specification is available in the master branch of the
[addonscript-spec](https://git.tilera.org/AddonScript/addonscript-spec) repository
and on [docs.addonscript.org](https://docs.addonscript.org/).
2021-07-02 22:53:50 +02:00
## What is AddonScript?
2021-11-14 00:37:29 +01:00
AddonScript is a format to distribute Minecraft addons. An addon could be anything, which is installed
2021-07-18 12:32:57 +02:00
into the Minecraft game, like a mod, modpack, modloader, texturepack or even a world.
2021-11-14 00:37:29 +01:00
AddonScript can be used for example to define how addons are installed, or to specify dependencies
2021-07-18 12:32:57 +02:00
for addons. This way, addon creators just have to publish the AddonScript file for their addon and let
2021-07-02 22:53:50 +02:00
AddonScript compatible tools (for example launchers) install them.
## The values of AddonScript
### Open
2021-07-18 12:32:57 +02:00
AddonScript can be used by everyone. There is no company or economic interest behind AddonScript.
It is intended to be an open standard, which can be implemented by anyone who likes to. Anyone can
2021-07-02 22:53:50 +02:00
contribute ideas to the AddonScript specification.
### Independent
2021-07-18 12:32:57 +02:00
AddonScript depends on nothing, except Minecraft itself (and Java). This means that the specification
does not depend on existing APIs and formats like Curseforge. It also does not reference any specific
modloader like Forge or Fabric, instead they are themselves addons, which can be defined using AddonScript.
2021-11-14 00:37:29 +01:00
This means, that AddonScript is not bound to a specific set of modloaders, instead you can use any
2021-07-18 12:32:57 +02:00
modloader.
2021-07-02 22:53:50 +02:00
### Universal
2021-07-18 12:32:57 +02:00
AddonScript is not bound to any specific use case like just for modpacks or just for mods. Instead it
is considered to be a universal format, which can handle anything, that is installed into
the Minecraft game. AddonScript can handle modloaders, mods, modpacks, texturepacks and even worlds
and maybe other things as well.