From e3e9be884a078798a0a524e0728f8de39f76a65e Mon Sep 17 00:00:00 2001 From: Francis Date: Wed, 18 Sep 2024 08:22:33 +0100 Subject: [PATCH] Multiple clean-ups Changes: - Remove old `userguide/docs/faq.md.orig` - Remove extranous `.` at end of sentence in `userguide/docs/faq.mdx` - Attempt to improve wording of first section in `userguide/docs/java.mdx` - De-pluralise `applications` in `userguide/docs/java.mdx` - Add initial section on install headless server to `userguide/docs/installer.mdx` --- userguide/docs/faq.md.orig | 12 ------------ userguide/docs/faq.mdx | 2 +- userguide/docs/installer.mdx | 21 ++++++++++++++++++++- userguide/docs/java.mdx | 6 +++--- 4 files changed, 24 insertions(+), 17 deletions(-) delete mode 100644 userguide/docs/faq.md.orig diff --git a/userguide/docs/faq.md.orig b/userguide/docs/faq.md.orig deleted file mode 100644 index 1747ccb8..00000000 --- a/userguide/docs/faq.md.orig +++ /dev/null @@ -1,12 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Common Pitfalls - -This section aims to provide answers to frequently asked questions as well as solutions to common pitfalls when running modded Minecraft. - - - -[NeoForge Discord]: https://discord.neoforged.net/ -[JarFix]: https://johann.loefflmann.net/downloads/jarfix.exe \ No newline at end of file diff --git a/userguide/docs/faq.mdx b/userguide/docs/faq.mdx index 824e496b..9ff38bba 100644 --- a/userguide/docs/faq.mdx +++ b/userguide/docs/faq.mdx @@ -12,7 +12,7 @@ This section aims to answer some common questions as well as covering some pitfa File associations for executing Java applications are sometimes missing or otherwise misconfigured. -For example, running the installer may momentarily flash up a black window, present the `Open with ...` dialog box, or it might open in a file archiving program such as WinRAR or 7-Zip.. +For example, running the installer may momentarily flash up a black window, present the `Open with ...` dialog box, or it might open in a file archiving program such as WinRAR or 7-Zip. To fix this, download and run (double-click) [JarFix], a program designed to fix broken or missing file associations. diff --git a/userguide/docs/installer.mdx b/userguide/docs/installer.mdx index 9c6799b8..9b6565a2 100644 --- a/userguide/docs/installer.mdx +++ b/userguide/docs/installer.mdx @@ -12,5 +12,24 @@ With Java installed, you should be able to just double-click the installer's `.j If double-clicking does not work, or your OS presents you with an error when doing so, see the section [Troubleshooting the NeoForge Installer] of the [FAQ]. +## Installing NeoForge on a Server + +You might want to install NeoForge on a "headless" server which does not have a GUI and therefore no means of double-clicking to run the installer. + +Usually this will mean that you need to use remote-access software such as [OpenSSH] to open a terminal and install NeoForge via the command line. + +Once you have opened a connection to the server you want to install on, the process is similar to that in the [] section of the [FAQ] with one extra `--installServer`. + +For example, to install a NeoForge server, version `21.1.51`, run the following command: + +``` +java -jar neoforge-21.1.51-installer.jar --installServer +``` + +This command will install the NeoForge server to the current working directory by default. + +If this is not what you want, specify the path you want to install to after the `--installServer`, e.g. by replacing the last `--installServer` with `--installServer /path/to/install/to`. + [Troubleshooting the NeoForge Installer]: ./faq.mdx#troubleshooting-the-installer -[FAQ]: ./faq.mdx \ No newline at end of file +[FAQ]: ./faq.mdx +[OpenSSH]: https://www.openssh.com/ \ No newline at end of file diff --git a/userguide/docs/java.mdx b/userguide/docs/java.mdx index 15c558fc..ee843682 100644 --- a/userguide/docs/java.mdx +++ b/userguide/docs/java.mdx @@ -7,9 +7,9 @@ import TabItem from '@theme/TabItem'; # Checking for and Installing Java -This section provides instructions on how to check whether you already have Java installed and how where to obtain a copy when it is not already installed. +This section provides instructions on how to check your computer for an existing Java installation. -If you are sure that you do not already have Java installed, proceed the final section entitled [Installing Java] below. +If you are sure that you do not already have Java installed, you can skip to the [Installing Java] section of this article below. ## Checking for Existing Java Installation @@ -17,7 +17,7 @@ To find out if you already have Java, you will need to locate and run the termin ### Location Terminal Application -The name of the applications to use differs based on the OS that is running: +The name of the application to use differs based on the OS that is running: