Add Readme

This commit is contained in:
Timo Ley 2021-07-02 22:53:50 +02:00
parent 6a3b7d883a
commit 8b97a348c3
3 changed files with 49 additions and 8 deletions

34
README.md Normal file
View file

@ -0,0 +1,34 @@
# 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
to the Minecraft game, like a mod, modpack, modloader, texturepack or even a world could be an addon.
AddonScript can be used for example to define, how addons should be 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 like 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 and it also does not reference any specific
modloader like Forge or Fabric, instead they are itself 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 you want.
### Universal
AddonScript is not bound to any specific use case like just for modpack or just for mods. Instead it
is considered to be a universal format, which could handle anything, that should be installed into
the Minecraft game. AddonScript could handle modloaders, mods, modpacks, texturepacks and even worlds
and maybe other things, we can't think of.

3
docs/README.md Normal file
View file

@ -0,0 +1,3 @@
# AddonScript
{{#include ../README.md:5:}}

View file

@ -1,14 +1,18 @@
# Summary
# AddonScript - [AddonScript](README.md)
# Schema # Schema
- [Addon Object](schema/root.md) - [Addon Object](schema/root.md)
- [AddonScript Object](schema/addonscript.md) - [AddonScript Object](schema/addonscript.md)
- [Version Object](schema/version.md) - [Version Object](schema/version.md)
- [File Object](schema/file.md) - [File Object](schema/file.md)
- [Relation Object](schema/relation.md) - [Relation Object](schema/relation.md)
- [Repository Object](schema/repository.md) - [Repository Object](schema/repository.md)
- [Index Object](schema/index.md) - [Index Object](schema/index.md)
- [Meta Object](schema/meta.md) - [Meta Object](schema/meta.md)
# Concepts
- [Installing](install.md)