playerlib

PlayerLib is a simple data structure that allows for the definition of various different types of player objects for various different use cases. These data structures also allow for change notifications so you can react to changes in your player at runtime.

Example

An example can be found at https://github.com/JeffreyRiggle/playerlib-example

Getting Started

Prerequisites

Java 11 SDK should be installed on your local machine. Maven should be installed on your local machine.

Installing

You can install this using maven with the following maven configuration

In your .m2

<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
                      http://maven.apache.org/xsd/settings-1.0.0.xsd">

  <activeProfiles>
    <activeProfile>github</activeProfile>
  </activeProfiles>

  <profiles>
    <profile>
      <id>github</id>
      <repositories>
        <repository>
          <id>central</id>
          <url>https://repo1.maven.org/maven2</url>
          <releases><enabled>true</enabled></releases>
          <snapshots><enabled>true</enabled></snapshots>
        </repository>
        <repository>
            <id>github</id>
            <name>Jeffrey Riggle Apache Maven Packages</name>
            <url>https://maven.pkg.github.com/JeffreyRiggle/playerlib</url>
          </repository>
      </repositories>
    </profile>
  </profiles>

  <servers>
    <server>
      <id>github</id>
      <username>USERNAME</username>
      <password>TOKEN</password>
    </server>
  </servers>
</settings>

In your pom file

<dependency>
  <groupId>com.ilusr.PlayerLib</groupId>
  <artifactId>playerlib</artifactId>
  <version>2.0.7</version>
</dependency>

For more information on github packages see the documentation.

Building

In order to build this simply run mvn build on the root folder.

Testing

In order to test this simply run mvn test on the root folder.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.