Skip to content
This repository was archived by the owner on Feb 19, 2019. It is now read-only.

Commit 7818f87

Browse files
authored
Merge pull request #10 from ZeroMemes/readme-pr10
Expand the README summary
2 parents 07f0ba4 + eee6c41 commit 7818f87

1 file changed

Lines changed: 6 additions & 1 deletion

File tree

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# ClientAPI
2-
API designed to make Clients have Universal Support
2+
ClientAPI is a modding API just like Forge, Sponge and Liteloader, it is designed to provide a shared base for large client-rewrite style mods.
3+
4+
Like other modding APIs it is a tweaker and has the potential to be stacked with other tweakers, so long as they do not both overwrite the same methods.
5+
6+
Unlike most other modding APIs it is designed to be used by a single "client" mod. It is this "client" that is installed, not the ClientAPI, so the "client" mod has full control over all modifications to the vanilla code, unless of course the installation is stacked on top of other modding APIs.
37

48
[![Dependency Status](https://www.versioneye.com/user/projects/588a834fbe496c0037c74b21/badge.svg?style=flat-square)](https://www.versioneye.com/user/projects/588a834fbe496c0037c74b21)
59
[![License](https://img.shields.io/github/license/ZeroMemes/ClientAPI.svg?style=flat-square)](https://github.com/ZeroMemes/ClientAPI/blob/master/LICENSE)
@@ -16,6 +20,7 @@ API designed to make Clients have Universal Support
1620
To use the Client API, you must download [Development Kit](https://github.com/ZeroMemes/ClientAPI-CDK). Instructions on how to set it up will be posted in the README.
1721

1822
## Concept
23+
1924
* Clients will install into `.minecraft/versions`
2025
* An installer could be used to configure stacking on top of other tweakers (e.g. Forge)
2126
* If an installer is used, it could also add a profile to the launcher

0 commit comments

Comments
 (0)