Version 0.2.0 proposal

.github/README.md

@@ -0,0 +1,84 @@
+# Scaffolding
+
+Scaffolding is a library for Minestom that allows you to load and place schematics.
+> This library is very early in development and has too many bugs to count. For your own safety, you should not use it in a production environment.
+
+> Also expect the API to change quite a bit in the future as this project works towards a 1.0.0 release.
+
+## Getting Started
+
+### Repository
+
+As with Minestom, Scaffolding uses JitPack to distribute releases.
+
+#### Gradle (Kotlin)
+Add JitPack as a repository to your ```build.gradle.kts``` file.
+```kotlin
+repositories {
+    maven(url = "https://jitpack.io")
+}
+```
+
+#### Gradle (Groovy)
+Add JitPack as a repository to your ```build.gradle``` file.
+```groovy
+repositories {
+    maven { url 'https://jitpack.io' }
+}
+```
+
+#### Maven
+Add JitPack as a repository to your ```pom.xml``` file.
+```xml
+<repositories>
+    <repository>
+        <id>jitpack</id>
+        <url>https://jitpack.io</url>
+    </repository>
+</repositories>
+```
+
+### Dependency
+
+Keep an eye out for new releases on [Jitpack](https://jitpack.io/#CrystalGamesMc/scaffolding).
+
+#### Gradle (Kotlin)
+Add Scaffolding as a dependency in your ```build.gradle.kts``` file.
+```kts
+dependencies {
+    implementation("com.github.CrystalGamesMc:scaffolding:Tag")
+}
+```
+
+#### Gradle (Groovy)
+Add Scaffolding as a dependency in your ```build.gradle``` file.
+```groovy
+dependencies {
+    implementation 'com.github.CrystalGamesMc:scaffolding:Tag'
+}
+```
+
+#### Maven
+Add Scaffolding as a dependency in your ```pom.xml``` file.
+```xml
+<dependencies>
+    <dependency>
+        <groupId>com.github.CrystalGamesMc</groupId>
+        <artifactId>scaffolding</artifactId>
+        <version>Tag</version>
+    </dependency>
+</dependencies>
+```
+
+## Usage
+Read
+```java
+File file = new File("schematics/your_schematic.schematic");
+Schematic schematic = Scaffolding.fromFileSync(file);
+```
+
+Build
+```java
+Schematic schematic = ...;
+schematic.build(instance, new Pos(0, 64, 0)).join();
+```

.gitignore

@@ -1,6 +1,6 @@
 
-# Created by https://www.toptal.com/developers/gitignore/api/maven,intellij+all,java
-# Edit at https://www.toptal.com/developers/gitignore?templates=maven,intellij+all,java
+# Created by https://www.toptal.com/developers/gitignore/api/intellij+all,gradle,java
+# Edit at https://www.toptal.com/developers/gitignore?templates=intellij+all,gradle,java
 
 ### Intellij+all ###
 # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
@@ -66,6 +66,9 @@ atlassian-ide-plugin.xml
 # Cursive Clojure plugin
 .idea/replstate.xml
 
+# SonarLint plugin
+.idea/sonarlint/
+
 # Crashlytics plugin (for Android Studio and IntelliJ)
 com_crashlytics_export_strings.xml
 crashlytics.properties
@@ -79,20 +82,13 @@ fabric.properties
 .idea/caches/build_file_checksums.ser
 
 ### Intellij+all Patch ###
-# Ignores the whole .idea folder and all .iml files
-# See https://github.com/joeblau/gitignore.io/issues/186 and https://github.com/joeblau/gitignore.io/issues/360
-
-.idea/
-
-# Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-249601023
+# Ignore everything but code style settings and run configurations
+# that are supposed to be shared within teams.
 
-*.iml
-modules.xml
-.idea/misc.xml
-*.ipr
+.idea/*
 
-# Sonarlint plugin
-.idea/sonarlint
+!.idea/codeStyles
+!.idea/runConfigurations
 
 ### Java ###
 # Compiled class file
@@ -118,32 +114,36 @@ modules.xml
 
 # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
 hs_err_pid*
+replay_pid*
+
+### Gradle ###
+.gradle
+**/build/
+!src/**/build/
 
-### Maven ###
-target/
-pom.xml.tag
-pom.xml.releaseBackup
-pom.xml.versionsBackup
-pom.xml.next
-release.properties
-dependency-reduced-pom.xml
-buildNumber.properties
-.mvn/timing.properties
-# https://github.com/takari/maven-wrapper#usage-without-binary-jar
-.mvn/wrapper/maven-wrapper.jar
-
-### Maven Patch ###
-# Eclipse m2e generated files
+# Ignore Gradle GUI config
+gradle-app.setting
+
+# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored)
+!gradle-wrapper.jar
+
+# Avoid ignore Gradle wrappper properties
+!gradle-wrapper.properties
+
+# Cache of project
+.gradletasknamecache
+
+# Eclipse Gradle plugin generated files
 # Eclipse Core
 .project
 # JDT-specific (Eclipse Java Development Tools)
 .classpath
 
+# End of https://www.toptal.com/developers/gitignore/api/intellij+all,gradle,java
+
 ### Minestom ###
 extensions/
 
 ### Scaffolding ###
 *.schematic
-*.schem
-
-# End of https://www.toptal.com/developers/gitignore/api/maven,intellij+all,java
+*.schem

build.gradle.kts

@@ -0,0 +1,10 @@
+
+allprojects {
+    repositories {
+        mavenCentral()
+        maven { url = uri("https://jitpack.io") }
+    }
+
+    group = "net.crystalgames"
+    version = "0.2.0"
+}