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

Commit c9f76bf

Browse files
authored
Update README.md
1 parent 0c63f99 commit c9f76bf

1 file changed

Lines changed: 5 additions & 8 deletions

File tree

README.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# ClientAPI
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.
2+
ClientAPI is a modding API/Framework just like Forge, Sponge and Liteloader, it is designed to provide a shared base for large client-rewrite style mods.
33

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.
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 entirely overwrite the same methods.
55

66
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.
77

@@ -12,21 +12,18 @@ Unlike most other modding APIs it is designed to be used by a single "client" mo
1212
## Credits
1313
| Name | Contribution |
1414
|---------------------|----------------------|
15-
| Halalaboos | CFont |
16-
| MatthewH & MarcoMC | CapesAPI Integration |
1715
| Nerxit | Tab GUI System |
1816

1917
## Development Kit
20-
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.
18+
To use the Client API, you must download [Development Kit](https://github.com/ZeroMemes/ClientAPI-CDK). Instructions on how to set it up are posted in the README.
2119

2220
## Concept
23-
24-
* Clients will install into `.minecraft/versions`
21+
* Clients will install into `.minecraft/versions` and `.minecraft/libraries` if they are published to a maven repo
2522
* An installer could be used to configure stacking on top of other tweakers (e.g. Forge)
2623
* If an installer is used, it could also add a profile to the launcher
2724
* The client will inherit from a vanilla minecraft version
2825
* This means the client doesn't need to include actual minecraft code
29-
* The client will list ClientAPI as a maven dependancy
26+
* The client will list ClientAPI as a maven dependency
3027
* The minecraft launcher will automatically download the ClientAPI lib to the `.minecraft/libraries` folder
3128

3229
## Usage

0 commit comments

Comments
 (0)