Created Java Management (markdown)

Daniel Scalzi 2018-08-20 02:03:23 -04:00
parent c3ad072c88
commit 6f851372fe

35
Java-Management.md Normal file

@ -0,0 +1,35 @@
<p align="center"><img src="https://github.com/WesterosCraftCode/ElectronLauncher/blob/master/app/assets/images/WesterosSealCircle.png?raw=true" width="150px" height="150px" alt="westeroscraft"></p>
<h1 align="center">Java Management</h1>
<p align="center">Customize your java executable, allocate more ram, or experiment with JVM args.</p>
<p align="center"><img src="https://i.imgur.com/lKIApi9.png" alt="Java Settings"></p>
<p align="center"><em>Java Management Tab. Accessible in the settings menu.</em></p>
---
The launcher was designed to handle Java setup for you. If you're an advanced user or would like to simply tinker with the default settings, you may do so on the Java Management Tab.
## Java Management Tab
### Change Minimum or Maximum RAM
Allocating RAM is easy! Just move the sliders to your desired value. You can set the value to the nearest half a gigabyte.
Notes
* If you have 6 GB of RAM or greater, the minimum amount you can allocate will be 3 GB. If you have less than 6 GB, the minimum will be 2 GB. WesterosCraft required **at least** 3 GB of RAM to run smoothly, however you may be able to get by with just 2 GB.
* The maximum amount of RAM you can allocate is determined by the following forumula: (total ram) - (1G for OS) - (1G per each 4G ram). If you have 16 GB available, we'll only let you allocate 11 GB. **As a rule of thumb, try not to allocate more than half of your available memory.**
* The slider will change color based on how much RAM you allocate.
* Green: Less than 1/4 of your total available RAM.
* Yellow: Greater than 1/4 of your total available RAM.
* Red: Greater than 1/2 of your total available RAM.
* **We recommend setting the miminum and maximum to the same value.** Having the JVM expand and contract the heap while chasing the 'free to used ratio' that it targets can be expensive and generate and cause random lag spikes.
### Change the Java Executable
The launcher automatically discovers valid installations of Java on your computer. If you do not have a valid installation, the launcher will prevent the game from launching (otherwise it would crash and burn). A valid installation is **Java 8 x64 greater than update 52**.
**Why is Java 10+ not supported?**
Forge and LaunchWrapper [only support Java 8](https://github.com/Mojang/LegacyLauncher/pull/11).