Skip to content

saibotk/JMAW

Repository files navigation

Java Mojang Api Wrapper (JMAW)

Simple, easy-to-use API Wrapper for the Mojang API, written in Java.

Goals

  • Simple
  • Type-safe responses for each endpoint / element
  • Custom exception for errors
  • State-less

API Coverage

Implemented:

Not included:

Installation / Download

Jitpack

Gradle

Add the JitPack repository:

allprojects {
	repositories {
		...
		maven { url 'https://jitpack.io' }
	}
}

Add the dependency and replace VERSION with the commit tag / release string or '-SNAPSHOT' for the latest commit:

dependencies {
	implementation 'com.github.saibotk:JMAW:VERSION'
}

Other

Configuration for maven, sbt, etc

Documentation

Can be found in /docs or available through Github pages here: https://saibotk.github.io/JMAW/

Dependecies

  • Retrofit for HTTP requests ( Apache - 2.0 )
  • Gson for json deserialization ( Apache - 2.0 )

Projects using JMAW

I'd be happy if you would let me know when you are using the library in one of your projects.

Contribute

Everybody is welcome to open an issue and / or create a PR to suggest changes.

License

MIT License

Copyright (c) 2019 saibotk

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Notice

Also respect the licenses found in individual files.