From 3893cd026e4ed3ceca0a0846e537e681174f3bff Mon Sep 17 00:00:00 2001 From: eaglercraft Date: Sun, 16 Jun 2024 17:40:57 -0700 Subject: [PATCH] Add README.md to workspace --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100755 README.md diff --git a/README.md b/README.md new file mode 100755 index 0000000..2cc29d0 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +### Java 17 is recommended for compiling to TeaVM + +### Java 8 or greater is required for the desktop runtime + +**Most Java IDEs will allow you to import this repository as a gradle project for compiling it to JavaScript.** + +Java must be added to your PATH! + +**To compile the web client:** +1. Run `CompileEPK` +2. Run `CompileJS` (or the `generateJavaScript` gradle task in your IDE) +3. Check the "javascript" folder + +**To compile an offline download:** +1. Run `CompileEPK` +2. Run `CompileJS` (or the `generateJavaScript` gradle task in your IDE) +3. Run `MakeOfflineDownload` +4. Check the "javascript" folder + +**To use the desktop runtime:** +1. Import the Eclipse project in "desktopRuntime/eclipseProject" into your IDE +2. Open one of the .java files from the source folders (workaround for a bug) +3. Run/Debug the client with the included "eaglercraftDebugRuntime" configuration + +**See the main 1.8 repository's README for more info** + +The source codes of EaglercraftXBungee and EaglercraftXVelocity are not included here. \ No newline at end of file