Rewrite Setup #16
Open
Rewrite Setup #16
Conversation
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
mworzala
reviewed
Jul 24, 2024
|
|
||
| ## Setting up shading | ||
|
|
||
| For Gradle users, we will use [the "Shadow" plugin](https://imperceptiblethoughts.com/shadow/introduction/) to include Minestom in the JAR file. |
There was a problem hiding this comment.
This should be part of the gradle tabs
|
|
||
| For Gradle users, we will use [the "Shadow" plugin](https://imperceptiblethoughts.com/shadow/introduction/) to include Minestom in the JAR file. | ||
|
|
||
| For Maven users, you will need [the "Shade" plugin](https://maven.apache.org/plugins/maven-shade-plugin/). If you use Maven and would like to contribute an example |
There was a problem hiding this comment.
This should be part of the maven tab
| For Maven users, you will need [the "Shade" plugin](https://maven.apache.org/plugins/maven-shade-plugin/). If you use Maven and would like to contribute an example | ||
| it would be appreciated :) | ||
|
|
||
| ::: warning |
There was a problem hiding this comment.
This should be part of the gradle tabs
| it would be appreciated :) | ||
|
|
||
| ::: warning | ||
| As of the time writing this, the original shadow plugin from johnrengelman has not been updated for Java 21 support, so we'll use a fork in this example. |
There was a problem hiding this comment.
Please link GradleUp/shadow#908 for now
|
|
||
| Finally, to create a runnable JAR, set your main class to be run. | ||
|
|
||
| With all of this done, all we need to do is run the `shadowJar` task to create a working uber (fat) jar! (The jar will be put in `/build/libs/` by default) |
| attributes["Main-Class"] = "org.example.Main" | ||
| } | ||
| } | ||
| ``` |
There was a problem hiding this comment.
Should have a maven tab here, even if it only asks someone to PR a correct pom file
|
|
||
| Here is a correct example: | ||
| Here is an example of a server without an instance: |
There was a problem hiding this comment.
It seems unnecessary to have two separate sections for a wrong one and then a correct one. Can prob just be merged together.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Depends on #15
This PR updates the Setup part of the wiki.
I renamed the section to "Getting Started", and reordered and rewrote certain parts.