Skip to content

Commit

Permalink
Add note about Java 16.
Browse files Browse the repository at this point in the history
  • Loading branch information
dscalzi committed Jul 1, 2021
1 parent c873d63 commit 57c376e
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 53 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@ Generate a distribution.json for Helios. Documentation on this format can be fou
## Requirements

* Node.js 14
* Java 8+ (https://adoptopenjdk.net/)
* Java 16+ (https://adoptopenjdk.net/)
* This is required to run the forge installer, process [XZ](https://tukaani.org/xz/format.html) files, and run bytecode analysis on mod files.
* Java 8 may not work for Forge 1.17+. Older versions do work with Java 16 (for nebula's purposes). This will be updated when Forge 1.17 is released.


### Notes
Expand All @@ -22,15 +23,18 @@ Generate a distribution.json for Helios. Documentation on this format can be fou

Example
```properties
JAVA_EXECUTABLE=C:\Program Files\AdoptOpenJDK\jdk-8.0.292.10-hotspot\bin\java.exe
JAVA_EXECUTABLE=C:\Program Files\AdoptOpenJDK\jdk-16.0.1.9-hotspot\bin\java.exe
ROOT=D:\TestRoot2
BASE_URL=http://localhost:8080/
HELIOS_DATA_FOLDER=C:\Users\user\AppData\Roaming\Helios Launcher
```

It's recommended to use Java 16 as the executable. Minecraft 1.17 requires Java 16+, so the assumption is that the Forge installer for 1.17 will require Java 16.
Java 8 may not work for 1.17+. This will be updated when we know definitively.

## Usage

Nebula is not complete. The following usage is tentative.
Nebula is still being developed. Usage may change, but it has remained stable for some time now.

#### TL;DR (Too Long; Didn't Read) Usage

Expand Down
91 changes: 45 additions & 46 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,17 +33,17 @@
"@types/node": "^14.17.4",
"@types/triple-beam": "^1.3.2",
"@types/yargs": "^17.0.0",
"@typescript-eslint/eslint-plugin": "^4.28.0",
"@typescript-eslint/parser": "^4.28.0",
"@typescript-eslint/eslint-plugin": "^4.28.1",
"@typescript-eslint/parser": "^4.28.1",
"eslint": "^7.29.0",
"rimraf": "^3.0.2",
"typescript": "^4.3.4"
"typescript": "^4.3.5"
},
"dependencies": {
"dotenv": "^10.0.0",
"fs-extra": "^10.0.0",
"got": "^11.8.2",
"helios-distribution-types": "^1.0.0-rc.1",
"helios-distribution-types": "^1.0.0-rc.2",
"luxon": "^1.27.0",
"minimatch": "^3.0.4",
"node-stream-zip": "^1.13.6",
Expand Down

0 comments on commit 57c376e

Please sign in to comment.