osuWorks/osu-api-Java-Client

An open source Java client for the public api of the game osu!

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.osuWorks:osu-api-Java-Client:'
	}
	dependencies {
		implementation("com.github.osuWorks:osu-api-Java-Client:")
	}
	<dependency>
	    <groupId>com.github.osuWorks</groupId>
	    <artifactId>osu-api-Java-Client</artifactId>
	    <version></version>
	</dependency>

                            
    libraryDependencies += "com.github.osuWorks" % "osu-api-Java-Client" % ""
        
        

                            
    :dependencies [[com.github.osuWorks/osu-api-Java-Client ""]]

Readme

osu!api Wrapper for Java

Build Status

This is an open source Java API wrapper for the osu!api, the public API of the game osu!.

Compatible osu!api version: 1.0

Installation

This project uses Apache Maven for build automation and dependency management. Unfortunately this project is not available in any repository so it is needed to install it locally. A functioning maven installation is required.

  1. Clone the repository: git clone https://github.com/osuWorks/osu-api-Java-Client.git
  2. Switching into the repository directory: cd osu-api-Java-Client
  3. Trigger maven goals: mvn clean install -Dmaven.test.skip=true

After a successful build you can use the components:

for API common utils (models, serializers, ...):

<dependency>
    <groupId>de.maxikg</groupId>
    <artifactId>osu-apiwrapper-common</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

for the API client:

<dependency>
    <groupId>de.maxikg</groupId>
    <artifactId>osu-apiwrapper-client</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

Usage

Coming soon.

If you are a Java developer you can browse the repository to get familiar with the osu!api Java Client.

License

See LICENSE.md.

Contribution

See CONTRIBUTE.md.

Links