refactor!: remove data from Schematic constructors

Author: LooFifteen

.gitignore

@@ -142,4 +142,8 @@ buildNumber.properties
 ### Minestom ###
 extensions/
 
+### Scaffolding ###
+*.schematic
+*.schem
+
 # End of https://www.toptal.com/developers/gitignore/api/maven,intellij+all,java

README.md

@@ -0,0 +1,28 @@
+# 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.
+
+## Usage
+```java
+// Load a schematic from File.
+public void method1() {
+    Schematic schematic = Scaffolding.fromFile(new File("schematics/my_schematic.schematic"));
+}
+
+public void method2() {
+    Schematic schematic = new SpongeSchematic();
+    schematic.read(new FileInputStream(new File("schematics/my_schematic.schematic")));
+}
+```
+```java
+// Place a schematic at a location.
+Instance instance = player.getInstance();
+Pos position = player.getPosition();
+schematic.build(instance, position).thenRun(() -> player.sendMessage("Schematic placed!"));
+```
+```java
+// Write a schematic (SOONtm)
+Region region = new Region(new Pos(0, 0, 0), new Pos(10, 10, 10));
+Schematic schematic = new SpongeSchematic();
+schematic.write(new FileOutputStream("schematics/my_schematic.schematic"), region);
+```

maze.schematic

@@ -24,9 +24,12 @@ public class Scaffolding {
         Pair<String, NBT> pair = reader.readNamed();
         NBTCompound nbtTag = (NBTCompound) pair.getSecond();
 
-        if (nbtTag.contains("Blocks")) return new MCEditSchematic(nbtTag);
-        else if (nbtTag.contains("Palette")) return new SpongeSchematic(nbtTag);
-        else return null;
+        Schematic schematic = null;
+        if (nbtTag.contains("Blocks")) schematic = new MCEditSchematic();
+        else if (nbtTag.contains("Palette")) schematic = new SpongeSchematic();
+
+        if (schematic != null) schematic.read(nbtTag);
+        return schematic;
     }
 
     /**

schematic.schematic

@@ -3,15 +3,26 @@
 import net.crystalgames.scaffolding.region.Region;
 import net.minestom.server.coordinate.Pos;
 import net.minestom.server.instance.Instance;
+import org.jglrxavpok.hephaistos.nbt.CompressedProcesser;
+import org.jglrxavpok.hephaistos.nbt.NBTCompound;
 import org.jglrxavpok.hephaistos.nbt.NBTException;
+import org.jglrxavpok.hephaistos.nbt.NBTReader;
 
 import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
 import java.util.concurrent.CompletableFuture;
 
 public interface Schematic {
 
-    void read() throws NBTException;
-    void write(Region region) throws IOException;
+    default void read(InputStream inputStream) throws IOException, NBTException {
+        NBTReader reader = new NBTReader(inputStream, CompressedProcesser.GZIP);
+        read((NBTCompound) reader.readNamed().getSecond());
+        reader.close();
+        inputStream.close();
+    }
+    void read(NBTCompound nbtTag) throws NBTException;
+    void write(OutputStream outputStream, Region region) throws IOException;
     CompletableFuture<Region> build(Instance instance, Pos position);
 
 }

src/main/java/net/crystalgames/scaffolding/Scaffolding.java

@@ -1,7 +1,7 @@
 package net.crystalgames.scaffolding.schematic.impl;
 
 import net.crystalgames.scaffolding.region.Region;
-import net.crystalgames.scaffolding.schematic.AbstractSchematic;
+import net.crystalgames.scaffolding.schematic.Schematic;
 import net.minestom.server.coordinate.Pos;
 import net.minestom.server.instance.Instance;
 import net.minestom.server.instance.batch.AbsoluteBlockBatch;
@@ -11,15 +11,14 @@
 import org.jglrxavpok.hephaistos.nbt.NBTCompound;
 import org.jglrxavpok.hephaistos.nbt.NBTException;
 
-import java.io.IOException;
-import java.io.InputStream;
+import java.io.OutputStream;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Objects;
 import java.util.concurrent.CompletableFuture;
 
 // https://github.com/EngineHub/WorldEdit/blob/version/5.x/src/main/java/com/sk89q/worldedit/schematic/MCEditSchematicFormat.java
-public class MCEditSchematic extends AbstractSchematic {
+public class MCEditSchematic implements Schematic {
 
     private final List<Region.Block> regionBlocks = new ArrayList<>();
 
@@ -30,26 +29,8 @@ public class MCEditSchematic extends AbstractSchematic {
 
     private boolean read = false;
 
-    /**
-     * Creates an MCEdit schematic from an input stream.
-     * @param inputStream the input stream
-     * @throws IOException if the input stream is invalid
-     * @throws NBTException if the schematic is invalid
-     */
-    public MCEditSchematic(InputStream inputStream) throws IOException, NBTException {
-        super(inputStream);
-    }
-
-    /**
-     * Creates an MCEdit schematic from NBT.
-     * @param nbtTag the NBT tag
-     */
-    public MCEditSchematic(NBTCompound nbtTag) {
-        super(nbtTag);
-    }
-
     @Override
-    public void read() throws NBTException {
+    public void read(NBTCompound nbtTag) throws NBTException {
         if (!nbtTag.containsKey("Blocks")) throw new NBTException("Invalid Schematic: No Blocks");
 
         readSizes(nbtTag);
@@ -113,7 +94,7 @@ public void readBlocks() {
     }
 
     @Override
-    public void write(Region region) {
+    public void write(OutputStream outputStream, Region region) {
         // TODO: Complete
     }
 

src/main/java/net/crystalgames/scaffolding/schematic/AbstractSchematic.java

@@ -1,7 +1,7 @@
 package net.crystalgames.scaffolding.schematic.impl;
 
 import net.crystalgames.scaffolding.region.Region;
-import net.crystalgames.scaffolding.schematic.AbstractSchematic;
+import net.crystalgames.scaffolding.schematic.Schematic;
 import net.minestom.server.coordinate.Pos;
 import net.minestom.server.instance.Instance;
 import net.minestom.server.instance.batch.AbsoluteBlockBatch;
@@ -11,13 +11,12 @@
 import org.jglrxavpok.hephaistos.nbt.NBTCompound;
 import org.jglrxavpok.hephaistos.nbt.NBTException;
 
-import java.io.IOException;
-import java.io.InputStream;
+import java.io.OutputStream;
 import java.util.*;
 import java.util.concurrent.CompletableFuture;
 
 // https://github.com/EngineHub/WorldEdit/blob/303f5a76b2df70d63480f2126c9ef4b228eb3c59/worldedit-core/src/main/java/com/sk89q/worldedit/extent/clipboard/io/SpongeSchematicReader.java#L261-L297
-public class SpongeSchematic extends AbstractSchematic {
+public class SpongeSchematic implements Schematic {
 
     private final List<Region.Block> regionBlocks = new ArrayList<>();
 
@@ -29,26 +28,8 @@ public class SpongeSchematic extends AbstractSchematic {
 
     private boolean read = false;
 
-    /**
-     * Creates a Sponge schematic from an input stream.
-     * @param inputStream the input stream
-     * @throws IOException if the input stream is invalid
-     * @throws NBTException if the schematic is invalid
-     */
-    public SpongeSchematic(InputStream inputStream) throws IOException, NBTException {
-        super(inputStream);
-    }
-
-    /**
-     * Creates a Sponge schematic from NBT.
-     * @param nbtTag the NBT tag
-     */
-    public SpongeSchematic(NBTCompound nbtTag) {
-        super(nbtTag);
-    }
-
     @Override
-    public void read() throws NBTException {
+    public void read(NBTCompound nbtTag) throws NBTException {
         readSizes(nbtTag);
         readBlockPalette(nbtTag);
         readBlocks();
@@ -132,7 +113,7 @@ private void readBlocks() throws NBTException {
     }
 
     @Override
-    public void write(Region region) {
+    public void write(OutputStream outputStream, Region region) {
         // TODO: Complete
     }
 

src/main/java/net/crystalgames/scaffolding/schematic/Schematic.java

@@ -22,8 +22,6 @@ public TestCommand() {
                 Instance instance = player.getInstance();
                 Pos position = player.getPosition();
 
-                schematic.read();
-
                 schematic.build(instance, position).thenRun(() -> player.sendMessage("Done!"));
             } catch (Exception e) {
                 e.printStackTrace();