addonscript/addonscript-spec
addonscript/addonscript-spec
1
1
Fork 2
Code Issues 3 Pull requests 1 Projects Releases 3 Wiki Activity
This repository contains the AddonScript specification https://addonscript.org
17 commits 4 branches 3 tags 269 KiB
Find a file
LordMZTE 85362caf96 add prettier format script and format
2021-11-14 00:25:43 +01:00
docs add prettier format script and format 2021-11-14 00:25:43 +01:00
.gitignore Initial schema for AS v2 2021-06-23 22:06:21 +02:00
book.toml Add git URL to book.toml 2021-06-29 13:26:58 +02:00
format.sh add prettier format script and format 2021-11-14 00:25:43 +01:00
README.md grammar and format fixes 2021-07-18 12:32:57 +02:00

README.md

AddonScript

This repository contains the AddonScript specification.

What is AddonScript?

AddonScript is a format to distribute Minecraft addons. An addon could be anything, which is installed into the Minecraft game, like a mod, modpack, modloader, texturepack or even a world. AddonScript can be used for example to define how addons are installed, or to specify dependencies for addons. This way, addon creators just have to publish the AddonScript file for their addon and let AddonScript compatible tools (for example launchers) install them.

The values of AddonScript

Open

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 contribute ideas to the AddonScript specification.

Independent

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. This means, that AddonScript is not bound to a specific set of modloaders, instead you can use any modloader.

Universal

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.