Skip to content

Commit a019e0a

Browse files
authored
fix: update hytale artifact setup instructions for potential error handling (#250)
1 parent 630ef2b commit a019e0a

1 file changed

Lines changed: 29 additions & 3 deletions

File tree

content/docs/en/guides/plugin/setting-up-env.mdx

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,9 @@ We recommend IntelliJ IDEA Community Edition for Hytale modding.
5252

5353
### 3. Maven
5454

55-
1. Visit the official website: https://maven.apache.org/download.cgi
55+
1. Visit the official website: https://maven.apache.org/download.cgi
5656
2. Download this file: `apache-maven-3.9.12-bin.zip` (Binary zip archive)
57-
3. Unzip it
57+
3. Unzip it
5858
4. Add the `apache-maven-3.9.12/bin/` folder to your PATH
5959

6060
You can now try the command `mvn -version` to verify Maven is installed correctly. Make sure to do this in a fresh new terminal instead of one you had opened from before!
@@ -104,6 +104,32 @@ mvn install:install-file -Dfile=[ROUTE TO HytaleServer.jar] -DgroupId=com.hypixe
104104

105105
Replace `[ROUTE TO HytaleServer.jar]` with the actual path to the `HytaleServer.jar` file on your system.
106106

107+
<Callout type="warning">
108+
If you are using Powershell you may stumble accross the following error:
109+
```
110+
[INFO] --------------------------------[ jar ]---------------------------------
111+
[INFO] ------------------------------------------------------------------------
112+
[INFO] BUILD FAILURE
113+
[INFO] ------------------------------------------------------------------------
114+
[INFO] Total time: 0.192 s
115+
[INFO] Finished at: ***************
116+
[INFO] ------------------------------------------------------------------------
117+
[ERROR] Unknown lifecycle phase ".hypixel.hytale". You must specify a valid lifecycle phase or a goal in the format <plugin-prefix>:<goal> or <plugin-group-id>:<plugin-artifact-id>[:<plugin-version>]:<goal>. Available lifecycle phases are: pre-clean, clean, post-clean, validate, initialize, generate-sources, process-sources, generate-resources, process-resources, compile, process-classes, generate-test-sources, process-test-sources, generate-test-resources, process-test-resources, test-compile, process-test-classes, test, prepare-package, package, pre-integration-test, integration-test, post-integration-test, verify, install, deploy, pre-site, site, post-site, site-deploy. -> [Help 1]
118+
[ERROR]
119+
[ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
120+
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
121+
[ERROR]
122+
[ERROR] For more information about the errors and possible solutions, please read the following articles:
123+
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/LifecyclePhaseNotFoundException
124+
```
125+
126+
This has something to do with how powershell struggles with the parameters when they are not wrapped inside strings. To solve this issue just wrap every parameter with `"`.
127+
128+
```bash
129+
mvn install:install-file -Dfile="[ROUTE TO HytaleServer.jar]" -DgroupId="com.hypixel.hytale" -DartifactId="HytaleServer-parent" -Dversion="1.0-SNAPSHOT" -Dpackaging="jar"
130+
```
131+
</Callout>
132+
107133
## Next Steps
108134

109135
Now that you have your development environment set up with the plugin template:
@@ -116,4 +142,4 @@ Learn how to:
116142
- [Create Commands](./creating-commands)
117143
- [Create Events](./creating-events)
118144

119-
and more! Explore the documentation to learn about all available features and best practices.
145+
and more! Explore the documentation to learn about all available features and best practices.

0 commit comments

Comments
 (0)