java-17 and above now works, update readme #5287
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 |
|---|---|---|
|
|
@@ -114,7 +114,7 @@ For more information about playing, like hot keys or server hosting, see the [de | |
|
|
||
| ### Alternative Installation Methods | ||
|
|
||
| If you already have a Java Development Kit (JDK) installed, you may use a direct download release as an alternative to using the [launcher](https://github.com/MovingBlocks/TerasologyLauncher/releases). Java version 17 or higher is required. | ||
|
|
||
| ßDirect download stable builds are uploaded to [our release section here on GitHub](https://github.com/MovingBlocks/Terasology/releases) while the cutting-edge develop version can be downloaded direct [here from our Jenkins](https://jenkins.terasology.io/job/Terasology/job/Omega/job/develop/lastSuccessfulBuild/artifact/distros/omega/build/distributions/TerasologyOmega.zip). | ||
|
|
||
|
|
@@ -127,7 +127,6 @@ Development is possible on all common platforms (Windows, Linux, MacOS) as long | |
|
|
||
| Technical Requirements: | ||
| - Java SE Development Kit (JDK) 17. The CI will verify against this baseline version. | ||
| - Git to clone the repo and commit changes. | ||
|
|
||
| Non-Technical Requirements: | ||
|
|
@@ -136,8 +135,14 @@ Non-Technical Requirements: | |
|
|
||
| ### Workspace Setup | ||
|
|
||
| To be able to run **Terasology** from source, you'll need to setup your workspace. For a quick setup execute the following: | ||
| ``` | ||
| ./groovyw module init iota | ||
| ./gradlew game | ||
|
|
||
| ``` | ||
|
|
||
| For more info, follow the [Contributor Quick Start Guide](https://terasology.org/Terasology/#/Contributor-Quick-Start). | ||
|
Comment on lines
+138
to
+145
There was a problem hiding this comment. Please revert this as it duplicates instructions from the contributor quick start which makes things harder to maintain without adding much benefit. |
||
| This guide is designed for [IntelliJ IDEA](https://www.jetbrains.com/idea/) (you can use the free community edition), but alternative setups are possible. | ||
|
|
||
| > :warning: _Note, that a Terasology workspace is a **multi-repo workspace**._ | ||
|
|
@@ -147,7 +152,7 @@ While your workspace itself is a clone of [MovingBlocks/Terasology](https://gith | |
| Accordingly, if you want to contribute to modules, you'll need to navigate into the respective subdirectory and work with Git from in there. | ||
| Any Git commands executed in your workspace root will target [MovingBlocks/Terasology](https://github.com/MovingBlocks/Terasology). | ||
|
|
||
| See as well our wiki entry on [Understanding Terasology's Git Setup](https://terasology.org/Terasology/#/Developing-Modules?id=understanding-terasology39s-git-setup). | ||
|
There was a problem hiding this comment. Not sure what's wrong with the original here? |
||
|
|
||
|
|
||
| ### Contributing | ||
|
|
||
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.
I am unable to be certain that all future versions of Java will always work. Since it is true that the game does not appear to be unusable on later versions anymore, I think we could remove the explicit requirement for exactly Java 17 for running the game. I would still prefer a strong recommendation though, since we need a common baseline to test with. If an unusual problem occurs the first thing we are likely to ask is to test with Java 17.
@jdrueckert, @skaldarnar, @Cervator Any thoughts?
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.
to run, it really works, reliable, up to java-23, personally, i do not even have java-17 installed any more since 2 years. we even have tests :) if java-24 does not work, i guess we can correct the readme or fix. if something strange happens it is no issue to ask to try with java-17. what you think?
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.
I'm with @BenjaminAmos here, future Java versions beyond 23 may not work and we don't have the resources to attain certainty that it still works every time a new java version hits.
We can however welcome users to try with newer versions at their own discretion and mention up to which version we tested things at least to a degree: