This repository has been archived by the owner on May 27, 2023. It is now read-only.
Version 0.2.0 proposal #11
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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(); | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
|
|
||
| allprojects { | ||
| repositories { | ||
| mavenCentral() | ||
| maven { url = uri("https://jitpack.io") } | ||
| } | ||
|
|
||
| group = "net.crystalgames" | ||
| version = "0.2.0" | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This stuff should be uncommented.