Skip to content

Commit

Permalink
Multiple clean-ups
Browse files Browse the repository at this point in the history
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`
  • Loading branch information
antiphysika committed Sep 18, 2024
1 parent d8f2e56 commit e3e9be8
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 17 deletions.
12 changes: 0 additions & 12 deletions userguide/docs/faq.md.orig

This file was deleted.

2 changes: 1 addition & 1 deletion userguide/docs/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
21 changes: 20 additions & 1 deletion userguide/docs/installer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
[FAQ]: ./faq.mdx
[OpenSSH]: https://www.openssh.com/
6 changes: 3 additions & 3 deletions userguide/docs/java.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,17 @@ 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

To find out if you already have Java, you will need to locate and run the terminal application that is provided by your OS.

### 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:

<Tabs defaultValue="windows">
<TabItem value="windows" label="Windows">
Expand Down

1 comment on commit e3e9be8

@neoforged-pages-deployments
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deploying with Cloudflare Pages

Name Result
Last commit: e3e9be884a078798a0a524e0728f8de39f76a65e
Status: ✅ Deploy successful!
Preview URL: https://d6629b07.neoforged-docs-previews.pages.dev
PR Preview URL: https://pr-166.neoforged-docs-previews.pages.dev

Please sign in to comment.