You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Feb 19, 2019. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+13-4Lines changed: 13 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,9 @@
1
1
# 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.
@@ -16,9 +20,14 @@ API designed to make Clients have Universal Support
16
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.
17
21
18
22
## Concept
19
-
* Clients will be stored in a "Clients" folder inside of ".minecraft"
20
-
* To launch a client, you run the "ClientAPI Launcher" and choose the desired Client
21
-
* Minecraft will automatically open with the Client running
23
+
24
+
* Clients will install into `.minecraft/versions`
25
+
* An installer could be used to configure stacking on top of other tweakers (e.g. Forge)
26
+
* If an installer is used, it could also add a profile to the launcher
27
+
* The client will inherit from a vanilla minecraft version
28
+
* This means the client doesn't need to include actual minecraft code
29
+
* The client will list ClientAPI as a maven dependancy
30
+
* The minecraft launcher will automatically download the ClientAPI lib to the `.minecraft/libraries` folder
22
31
23
32
## Usage
24
33
Refer to the [Example](https://github.com/ZeroMemes/ClientAPI-Example) to view how clients using the ClientAPI are structured.
0 commit comments