Home

Welcome to the SimplixStorage wiki!

This is the official wiki to learn everything about this powerful library. The Wiki is designed to make it as easy as possible for you to learn how to use SimplixStorage to improve the way you store data.

Table of contents:

• Setting up (covered here)

Learn basic stuff:

• FileTypes (Which filetypes are supported. When to use which one?)
  
• Usage (Generic usage for all filetypes.)
  

More advanced stuff:

• Serializable's (How to register serilizables)
  
• Time-Saver (Read 5 minutes to save hours of time & tons of boilerplate code.)
  
• Performance-Saver (Maximum performance for your application!)
  
• Internal Explanation(Learning always helps;) )
  

Setting up:

You can check out the latest builds here:

1. Place this in your repository-section:

<!-- JitPack-Repo -->
<repository>
  <id>jitpack.io</id>
  <url>https://jitpack.io</url>
</repository>

2. Place this in your dependency-section:

Version: Find the latest version of SimplixStorage here

Maven:

<dependency>
  <groupId>com.github.simplix-softworks</groupId>
  <artifactId>simplixstorage</artifactId>
  <version>VERSION <!-- Replace me with the current version --></version>
</dependency>

Gradle:

dependencies {
    compile 'com.github.simplix-softworks:simplixstorage:VERSION'/* Replace me with the current version */
}

3. Important! Use a shade plugin to make sure that the library is shaded into your final .jar file when your plugin is compiled. The relocation is optional but heavily recommended. (Just change 'yourpackage.yourname' to the needed values)

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-shade-plugin</artifactId>
  <version>3.1.0</version>
  <executions>
    <execution>
    <phase>package</phase>
    <goals>
      <goal>shade</goal>
    </goals>
    </execution>
  </executions>
  <configuration>
    <createDependencyReducedPom>false</createDependencyReducedPom>
    <relocations>
      <relocation>
        <pattern>de.leonhard.storage</pattern>
        <shadedPattern>yourpackage.yourname.storage</shadedPattern>
      </relocation>
    </relocations>
  </configuration>
</plugin>