First draft for user guide PR

docusaurus.config.js

@@ -83,6 +83,22 @@ const config = {
         },
       },
     ],
+    [
+      "@docusaurus/plugin-content-docs",
+      {
+        id: "userguide",
+        path: "userguide",
+        routeBasePath: "userguide",
+        sidebarPath: require.resolve("./sidebarsUserGuide.js"),
+        lastVersion: "current",
+        includeCurrentVersion: true,
+        versions: {
+          current: {
+            label: "0.1",
+          },
+        },
+      },
+    ],
   ],
 
   themeConfig:
@@ -114,6 +130,13 @@ const config = {
             docsPluginId: "neogradle",
             label: "NeoGradle Documentation",
           },
+          {
+            type: "docSidebar",
+            sidebarId: "ugSidebar",
+            position: "left",
+            docsPluginId: "userguide",
+            label: "NeoForge User Guide",
+          },
           {
             type: "docsVersionDropdown",
             position: "right",

sidebarsUserGuide.js

@@ -0,0 +1,33 @@
+/**
+ * Creating a sidebar enables you to:
+ - create an ordered group of docs
+ - render a sidebar for each doc of that group
+ - provide next/previous navigation
+
+ The sidebars can be generated from the filesystem, or explicitly defined here.
+
+ Create as many sidebars as you want.
+ */
+
+// @ts-check
+
+/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
+const sidebars = {
+  // By default, Docusaurus generates a sidebar from the docs folder structure
+  ugSidebar: [{ type: "autogenerated", dirName: "docs" }],
+
+  // But you can create a sidebar manually
+  /*
+  tutorialSidebar: [
+    'intro',
+    'hello',
+    {
+      type: 'category',
+      label: 'Tutorial',
+      items: ['tutorial-basics/create-a-document'],
+    },
+  ],
+   */
+};
+
+module.exports = sidebars;

src/pages/index.mdx

@@ -26,6 +26,14 @@ If you would like to contribute to the docs, read [Contributing to the Docs][con
         linkTitle="Read More"
       />
     </div>
+    <div class="col col--6" style={{padding: '10px'}}>
+      <Card
+        title="NeoForge User Guide"
+        body="Learn how to install NeoForge for both client and server, we well as some of the pitfalls you might experience along the way."
+        link="/userguide/docs/"
+        linkTitle="Read More"
+      />
+    </div>
   </div>
 </div>
 

userguide/docs/faq.md

@@ -0,0 +1,79 @@
+---
+sidebar_position: 4
+---
+
+# Frequently Asked Questions
+
+This section aims to answer some common questions as well as covering some pitfalls you might experience when using the NeoForge installer.
+
+## Troubleshooting the NeoForge Installer
+
+For most users the installer should run without error.
+
+If the installer runs but pops up an error dialog box while executing, see the [NeoForge Installer Log File] section below.
+
+### Troubleshooting the NeoForge Installer on Windows
+
+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.
+
+To fix this, download and run (double-click) [JarFix], a program designed to fix broken or missing file associations.
+
+Once complete, restart your computer and try running the installer again.
+
+### Troubleshooting the NeoForge Installer on Linux
+
+File associations for executing Java applications are often missing completely on Linux distributions.
+
+In order to run the installer you may need to execute it manually in a terminal.
+
+For instance, with an installer for NeoForge version `21.1.54`, running the following in a terminal should bring up its GUI:
+
+```
+$ java -jar neoforge-21.1.54-installer.jar
+```
+
+For pointers on finding a terminal application on Linux, see the [Locating a Terminal Application] section in the [Checking for and Installing Java] article.
+
+### NeoForge Installer Log File
+
+When experiencing issues with the NeoForge installer, you might be asked to provide its log file, which should be created in the same directory the installer itself resides in.
+
+For example, the installer for version `21.1.54` should create a file with the name of `neoforge-21.1.54-installer.jar.log`.
+
+## Troubleshooting NeoForge
+
+You might run into problems when trying to launch Minecraft with NeoForge installed.
+
+This can happen for a number of reasons, including out-dated and/or buggy graphics card (GPU) drivers.
+
+First, check to see whether Minecraft without NeoForge works.  If the game launches successfully and does not crash, read on.
+
+If Minecraft by itself crashes, you will not be able to install NeoForge.
+
+### Updating GPU Drivers
+
+Due to an interaction between NeoForge's early-loading screen and out-dated/buggy GPU drivers, Minecraft may crash.
+
+This can sometimes be fixed by updating the drivers for your GPU.
+
+Linked below are tools for the three most common GPU manufacturers, which can be used to download and install driver updates.
+
+- **Intel**: https://www.intel.com/content/www/us/en/support/detect.html
+- **AMD**: https://www.amd.com/en/support
+- **NVIDIA**: https://www.nvidia.com/download/index.aspx
+
+:::note
+It is possible that your computer may have multiple GPUs.
+
+For example, a laptop might have one integrated into the CPU itself as well as a dedicated (discrete) GPU.
+:::
+
+If you do not know who manufactured your GPU, how many you have, or even which drivers to update, see the [Further Help] section of the main article for a link to the NeoForged project's Discord server, where you can ask for help.
+
+[JarFix]: https://johann.loefflmann.net/downloads/jarfix.exe
+[Locating a Terminal Application]: ./java.mdx#locating-a-terminal-application
+[Checking for and Installing Java]: ./java.mdx
+[NeoForge Installer Log File]: ./faq.md#neoforge-installer-log-file
+[Further Help]: ./index.md#further-help

userguide/docs/index.md

@@ -0,0 +1,27 @@
+---
+sidebar_position: 0
+---
+
+# NeoForge User Guide
+
+## Introduction
+
+Whether you are a regular player, pack developer or server administrator, this guide is intended to help you through the process of preparing your computer to run NeoForge, as well as answer some frequently asked questions.
+
+## Prerequisites
+
+In order to install Neoforge, you will first need to have Java installed on your computer.
+
+If you are unsure whether you already have Java installed, proceed to the [Checking for and Installing Java] section.
+
+Otherwise, continue on to the [Installing NeoForge] section.
+
+## Further Help
+
+This document covers some of the issues you may face as a user of NeoForge, however it is not intended to be exhaustive, and you may run into a problem which is not covered here.
+
+The NeoForged project has a [Discord] server, including a `#user-support` channel, where you can ask questions and seek further support.
+
+[Discord]: https://discord.neoforged.net/
+[Checking for and Installing Java]: ./java.mdx
+[Installing NeoForge]: ./installer

userguide/docs/installer.md

@@ -0,0 +1,39 @@
+---
+sidebar_position: 2
+---
+
+# Installing NeoForge
+
+## Running The Installer
+
+The NeoForge installer is OS-agnostic and is universal in that it can be used to install on both the client and server.
+
+With Java installed, you should be able to just double-click the installer's `.jar` file and proceed from there.
+
+If double-clicking does not bring up the installer's GUI, or doing so presents you with an OS error, 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 via the command line.
+
+With a terminal opened on the server you wish to install on, the installer is reaady to be launched.
+
+For example, to install NeoForge version `21.1.51`, run the following command:
+
+```
+java -jar neoforge-21.1.51-installer.jar --installServer
+```
+
+:::note
+By default, this command will install to the current working directory.
+
+If this is not what you want, specify the path you want to install the server to after the `--installServer` option, e.g. by replacing `--installServer` with `--installServer /path/to/install/to`.
+:::
+
+<!-- Add section on using the nifty ServerStarterJar? -->
+
+[Troubleshooting the NeoForge Installer]: ./faq#troubleshooting-the-installer
+[FAQ]: ./faq
+[OpenSSH]: https://www.openssh.com/

userguide/docs/java.mdx

@@ -0,0 +1,70 @@
+---
+sidebar_position: 1
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# Checking for and Installing Java
+
+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, you can skip to the [Installing Java] section below.
+
+## Checking for Existing Java Installation
+
+To find out if you already have Java you can use the terminal application provided by your OS.
+
+### Locating a Terminal Application
+
+<Tabs defaultValue="windows">
+  <TabItem value="windows" label="Windows">
+    Windows has three options depending on version:
+    - Windows Terminal
+    - PowerShell
+    - Command Prompt (aka `cmd`)
+  </TabItem>
+  <TabItem value="macos" label="macOS">
+    macOS has Terminal which is often found on the Finder dock.
+  </TabItem>
+  <TabItem value="linux" label="Linux">
+    The names for terminal applications vary on Linux but one of the following should be available from your distribution's main menu:
+    - GNOME Terminal (or just Terminal)
+    - Konsole
+  </TabItem>
+</Tabs>
+
+### Testing for Installed Java Version
+
+Once you have located the terminal application for your OS, run the command `java -version`, which should present you with information similar to the following:
+
+```
+openjdk version "21.0.4" 2024-07-16 LTS
+OpenJDK Runtime Environment Temurin-21.0.4+7 (build 21.0.4+7-LTS)
+OpenJDK 64-Bit Server VM Temurin-21.0.4+7 (build 21.0.4+7-LTS, mixed mode, sharing)
+```
+
+## Installing Java
+
+Minecraft itself recommends the [Microsoft Build of OpenJDK] (Microsoft JDK) for running Minecraft.
+
+<!-- With Windows being the common case, should there be a `WinGet` example? -->
+
+If you do not want to use the Microsoft JDK, you can instead donwload an installer for, e.g. Temurin from the Eclipse Foundation, from [Adoptium].
+
+### Which Version of Java to Install
+
+You will need to install a specific version of Java depending on the version of NeoForge you are installing.
+
+The following table lists the versions of Java that are recommended for a particular version of minecraft:
+
+| Minecraft version | Java version |
+|-------------------|--------------|
+| 1.20.2 - 1.20.4   | 17           |
+| 1.20.5 and above  | 21           |
+
+<!-- Above are minumium versions from the MC Wiki; check that these are optimal -->
+
+[Installing Java]: ./java.mdx#installing-java
+[Microsoft Build of OpenJDK]: https://www.microsoft.com/openjdk
+[Adoptium]: https://adoptium.net/temurin/releases/

userguide/docs/launchers.md

@@ -0,0 +1,61 @@
+---
+sidebar_position: 3
+---
+
+# Launchers and Mod Managers
+
+There are two supported ways that you can launch Minecraft with Neoforge.
+
+The first is to use the official, vanilla launcher from Mojang, which the NeoForge installer creates a profile for.
+
+The second option is to use a third-party launcher, some of which are listed below in the [Third-Party Launchers] section.
+
+## Locating the Game Directory
+
+Minecraft stores its files, like your game's saves, as well as crash reports and log files in a so-called game directory.
+
+The location of the game directory will differ depending on which launcher you use to run the game.
+
+The vanilla launcher will create a `.minecraft` directory in your OS user's home directory.  This is the game directory for the vanilla launcher.
+
+<!-- List ot link out to where to find user home directory? -->
+
+:::note
+If you are using another launcher, refer to their documentation on where the game directory is located.
+:::
+
+## Locating Log Files and Crash Reports
+
+Minecraft stores log files and crash reports in the game directory.
+
+You might be asked to provide log files or crash reports when seeking help.
+
+If you do not know where to find them, open your game directory in a file manager application where there should be two directories:
+
+- `logs` This directory contains log files for the game, with the files `latest.log` and `debug.log` being most pertinent.
+- `crash-reports` This directory contains plain-text crash reports, each with timestamped filenames e.g. `crash-2024-08-11_15.54.06-client.txt`.
+
+<!-- Not sure if the above list is the best way to format the info in it... -->
+
+## Third-Party Launchers
+
+There are a number of third-party launchers (also known as mod managers) to choose from, including:
+
+- [CurseForge App]
+- [Modrinth App]
+- [ATLauncher]
+- [Prism Launcher]
+
+These launchers differ from the vanilla launcher in a number of helpful ways.
+
+First of all, the launcher should fully handle installing and updating NeoForge for you.
+
+Second, you will be able to create multiple game profiles (also known as instances), allowing you to easily seperate different versions of the game.
+
+Finally, all of the linked launchers have the ability to manage mods, making installing and updating mods much easier.
+
+[Third-Party Launchers]: ./launchers.md#third-party-launchers
+[CurseForge App]: https://www.curseforge.com/download/app
+[Modrinth App]: https://modrinth.com/app
+[ATLauncher]: https://atlauncher.com/
+[Prism Launcher]: https://prismlauncher.org/