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

Commit 5dffbe4

Browse files
authored
Update README.md
Add maven info
1 parent 1ecdabf commit 5dffbe4

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

+30
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,33 @@ Join us on Discord: https://discord.gg/pRGH45W
88
See https://minecraft.curseforge.com/projects/mystcraft for downloads
99

1010
Thanks! :)
11+
12+
### Getting the API
13+
#### Maven Repo
14+
```
15+
repositories {
16+
maven {
17+
name "xcompwiz"
18+
url "http://maven.xcompwiz.com"
19+
}
20+
}
21+
dependencies {
22+
compile "com.xcompwiz.mystcraft:mystcraft:0.13.5.01:dev"
23+
}
24+
```
25+
26+
#### Manual Download
27+
You can manually obtain an API jar from the Mystcraft CurseForge page: https://minecraft.curseforge.com/projects/mystcraft
28+
29+
Once equipped with your API version of choice (the most recent one, right?), you can put it in the "jars" folder at the same level as your gradle scripts. You may need to create this folder.
30+
You can then either import the jar manually into your workspace or rerun the gradle command to build your workspace of choice:
31+
ex: gradlew.bat eclipse
32+
33+
### Getting Started
34+
Mystcraft uses a very robust but rather complex method of maintaining its API versions. This allows it to support older versions of the API alongside new versions, but there is a small cost of complexity.
35+
It is recommended you look at the APIInstanceProvider class. It should be well documented in its usage. Using the static instance of this class you are ready to get into Mystcraft's API properly.
36+
37+
### Available API Interfaces
38+
>It is also possible to get a list of interfaces and their available versions supported from the APIInstanceprovider
39+
40+
TODO:

0 commit comments

Comments
 (0)