Improve install documentation #639
Conversation
|
A preview for this pull request is available at https://cdn.rawgit.com/Spongy/SpongeDocs-PRs/480c2d8/. Here are some links to the pages that were modified:
Since the preview frequently changes, please link to this comment, not to the direct url to the preview. |
|
Mh, while you are at this: I wrote this a while ago because people kept trying to match forge and sponge exactly https://gist.github.com/phit/d097a5a4e7172e6c1e4a7616596bc7ce (for the example in |
| 32-bit vs. 64-bit | ||
| ~~~~~~~~~~~~~~~~~ | ||
|
|
||
| If your computer supports it, you should use 64-bit versions of Java whenever possible. The Java installers from the | ||
| linked website should detect whether your computer is ready for 64-bit. | ||
| `this website <https://java.com/en/download/>`__ should detect whether your computer is ready for 64-bit. |
There was a problem hiding this comment.
probably wiser to use https://java.com/en/download/manual.jsp
There was a problem hiding this comment.
Not sure about that, there is the selection, but it does not really help you with selecting 32 or 64 bit.
There was a problem hiding this comment.
Some browsers can handle the auto-detection, and some (eg. Pale Moon) cannot. The manual downloads page is a good place to make sure you get a 64-bit version, but you can also have multiple versions of Java installed so it's no guarantee that it'll be the one used by software. The Java control panel will give you the info in Windows, but I'm not sure about Mac or Linux systems.
|
yeah, feel free to proofread and improve on that, I just wanted to make it clearer that you don't always have to use the exact version and avoid people asking when SpongeForge will get updated to Forge XXXX |
| problem. However, SpongeForge needs to access, among other things, internal parts of Forge, which most mods | ||
| shouldn’t be touching, let alone modifying as Sponge does. Since Forge is free to change their internal code | ||
| whenever they want to, its normal guarantee of backwards-compatibility doesn’t apply to SpongeForge. Feel free to | ||
| use more recent versions of Forge, than the one used for SpongeForge, but we can't always garantee compatibility. |
| | ``MCVersion`` | The Minecraft version. Only clients compatible with this version can connect. | | ||
| +----------------------+-----------------------------------------------------------------------------------------------+ | ||
| | ``ForgeBuildId`` | The build number of Forge this file is built for. Preferably your server should run this exact| | ||
| | | version of Forge. Which is the last part of Forge's version string. | |
There was a problem hiding this comment.
This should be one sentence, and made a bit clearer. ie. Preferably your server should run this exact version of Forge (which can be identified in the last part of Forge's version string).
|
|
||
| .. warning:: | ||
|
|
||
| When investigating crash issues, you can freely use a newer versions of Forge than listed on the SpongeForge Jar. |
There was a problem hiding this comment.
Some plural problems here. The "a" is not needed in this sentence. However, the next sentence should refer to a singular matching version, and I'd refer to "a version mismatch" (there may not be one).
|
|
@Inscrutable In #592 (comment) you mentioned an alternative minecraft download page for a version without Java embedded. Are you referring to that page: https://minecraft.net/en-us/download/alternative ? |
|
Mention that sponge only work with java 8 not 9 |
|
I did that here or do you want it elsewhere as well? |
|
Ready for review. |
| @@ -30,10 +46,11 @@ SpongeVanilla only works as a dedicated server. | |||
|
|
|||
| .. warning:: | |||
|
|
|||
| Don't double-click the ``.jar`` file! | |||
| Don't double-click the ``.jar`` file! As it will start the server without a window to control it. | |||
There was a problem hiding this comment.
This should be one sentence.
| 32-bit vs. 64-bit | ||
| ~~~~~~~~~~~~~~~~~ | ||
|
|
||
| If your computer supports it, you should use 64-bit versions of Java whenever possible. The Java installers from the | ||
| linked website should detect whether your computer is ready for 64-bit. | ||
| `this website <https://java.com/en/download/>`__ should detect whether your computer is ready for 64-bit. |
There was a problem hiding this comment.
Some browsers can handle the auto-detection, and some (eg. Pale Moon) cannot. The manual downloads page is a good place to make sure you get a 64-bit version, but you can also have multiple versions of Java installed so it's no guarantee that it'll be the one used by software. The Java control panel will give you the info in Windows, but I'm not sure about Mac or Linux systems.
Inscrutable
removed
the
needs review
Fixes #592