added the old documentation to the wiki
16
docs/common-issues.md
Normal file
|
@ -0,0 +1,16 @@
|
|||
# Common Issues
|
||||
|
||||
/// admonition | Outdated
|
||||
type: danger
|
||||
This page is outdated!
|
||||
///
|
||||
|
||||
This page contains a list of commonly reported issues that I cannot fix.
|
||||
|
||||
## ComputerCraft Monitors are extremely dark
|
||||
|
||||
This is caused by Embeddium (Sodium). I have no way to fix this without removing Embeddium, the only workaround I'm aware of is using a shader.
|
||||
If you're on a lower end system, look for a shader identified as "Potato" in Resourcify. I recommend [MakeUp UltraFast](https://modrinth.com/shader/makeup-ultra-fast-shaders). You can get a lot of performance out of this shader if you turn off all of the effects in its settings menu.
|
||||
If MakeUp UltraFast is too difficult to run on your system, you can try [VanillaAA](https://modrinth.com/shader/vanillaa).
|
||||
|
||||

|
BIN
docs/img/common-issues-1.png
Normal file
After Width: | Height: | Size: 1.2 MiB |
BIN
docs/img/installing-a-launcher/1.png
Normal file
After Width: | Height: | Size: 184 KiB |
BIN
docs/img/installing-a-launcher/2.png
Normal file
After Width: | Height: | Size: 20 KiB |
BIN
docs/img/installing-a-launcher/3.png
Normal file
After Width: | Height: | Size: 10 KiB |
BIN
docs/img/installing-a-launcher/4.png
Normal file
After Width: | Height: | Size: 16 KiB |
BIN
docs/img/installing-a-launcher/5.png
Normal file
After Width: | Height: | Size: 162 KiB |
BIN
docs/img/installing-a-launcher/6.png
Normal file
After Width: | Height: | Size: 180 KiB |
|
@ -1 +1,3 @@
|
|||
# Hello
|
||||
# GalacticFactory
|
||||
|
||||
Welcome to the GalacticFactory documentation! Currently, this only contains basic installation guides, but in the future I hope to expand it to cover more topics.
|
||||
|
|
46
docs/installing-a-launcher.md
Normal file
|
@ -0,0 +1,46 @@
|
|||
# Installing a Launcher
|
||||
|
||||
As you may or may not know, [GalacticFactory](https://invite.galacticfactory.cc) does not provide support for individuals using the vanilla launcher.
|
||||
|
||||
Instead, we recommend people use a third party launcher, such as Prism Launcher or ATLauncher.
|
||||
|
||||
This page will guide you through the process of installing these launchers.
|
||||
|
||||
### Installing Java
|
||||
Go to [this link](https://java.galacticfactory.cc) and run the installer it downloads.
|
||||
|
||||
_If you are not on Windows you can find a compatible version [here](https://adoptium.net/temurin/releases/), just make sure you're using JDK 17._
|
||||
|
||||
## Launcher Choice
|
||||
You can decide which of the following launchers you want to use based on personal preference. None of these launchers are necessarily objectively better than another launcher.
|
||||
|
||||
### Installing Prism Launcher
|
||||
|
||||
Go to the [Prism Launcher Website](https://prismlauncher.org/download/) and press the "Installer (.exe)" button.
|
||||

|
||||
|
||||
Run the executable file you just downloaded, then make your way through the installer. Once the installer is done, run Prism Launcher.
|
||||
|
||||
Log into your Microsoft account in the top right.
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
You're done!
|
||||
|
||||
### Installing ATLauncher
|
||||
|
||||
Go to the [ATLauncher Website](https://atlauncher.com/downloads) and click "Setup" under the Windows category.
|
||||

|
||||
|
||||
Run the executable file you just downloaded, then make your way through the installer. Once the installer is done, run ATLauncher.
|
||||
|
||||
Once you're in ATLauncher, go to the Accounts tab.
|
||||

|
||||
|
||||
Click the "Login with Microsoft" button and follow the instructions it gives you.
|
||||
|
||||
You're done!
|
98
docs/installing-the-modpack.md
Normal file
|
@ -0,0 +1,98 @@
|
|||
# Installing the Modpack
|
||||
|
||||
## Installing with Prism Launcher or ATLauncher
|
||||
|
||||
/// admonition | Outdated
|
||||
type: danger
|
||||
These installation instructions are incorrect! Please join the [Discord server](https://invite.galacticfactory.cc/) for assistance.
|
||||
///
|
||||
|
||||
Go to the [Releases](https://coastalcommits.com/GalacticFactory/GalacticFactory/releases) page of this repository and download `GalacticFactory - Prism Launcher.zip` or `GalacticFactory - ATLauncher.zip`, depending on your launcher.
|
||||
|
||||

|
||||
|
||||
|
||||
## Installing with unsup (Other Launchers/Servers)
|
||||
|
||||
[unsup](https://github.com/packwiz/packwiz-installer) is a useful tool that lets you automatically install and update a modpack through the [Packwiz](https://packwiz.infra.link/) `pack.toml` file of that pack.
|
||||
|
||||
First, you need to download the `unsup_setup` script compatible with your system.
|
||||
If you're on Windows, use [this link](https://www.coastalcommits.com/GalacticFactory/GalacticFactory/releases/download/Pre-Release/unsup_setup.ps1).
|
||||
If you're on Linux or MacOS, use [this link](www.coastalcommits.com/GalacticFactory/GalacticFactory/releases/download/Pre-Release/unsup_setup.sh).
|
||||
After that, follow the instructions below for your platform:
|
||||
|
||||
### Servers
|
||||
|
||||
First, move the `unsup_setup` script to your server's root folder (the folder that has your server .jar) and run it, then add the following to your `unix_args.txt` file.
|
||||
|
||||
```bash
|
||||
-javaagent:unsup.jar
|
||||
```
|
||||
|
||||
You'll also want to add the following line to your `unsup.ini` file, under `preset=minecraft`.
|
||||
|
||||
```bash
|
||||
no_gui=true
|
||||
```
|
||||
|
||||
After this, I recommend following the post-install guide:
|
||||
|
||||
#### Post-install tips and tricks
|
||||
|
||||
I highly recommend pre-loading your chunks so that you can prevent lag when players generate new ones. Chunky is included in GalacticFactory as of 0.2.0, here are a few basic commands to pre-load with the mod. **Keep in mind that pre-loading can take quite a long time, and you should probably do it when people aren't online**.
|
||||
|
||||
Choose the world, replacing `minecraft:overworld` with the corresponding world:
|
||||
|
||||
```markdown
|
||||
chunky world minecraft:overworld
|
||||
```
|
||||
|
||||
Choose the radius to pre-load, replacing 2500 with how much you want to do:
|
||||
|
||||
```markdown
|
||||
chunky radius 2500
|
||||
```
|
||||
|
||||
After choosing the world and the radius, start pre-loading:
|
||||
|
||||
```markdown
|
||||
chunky start
|
||||
```
|
||||
|
||||
### Modrinth App
|
||||
|
||||
Create a new 1.20.1 Forge instance, and go to your settings page.
|
||||
|
||||
Then, move the `unsup_setup` file to your instance's `.minecraft` folder and run it. You can click the `Folder` button to open your instance's folder.
|
||||
|
||||
Scroll down in your settings page until you find the `Java` category. Click the `Override global java arguments` button, then put the following argument into your `Java arguments` field.
|
||||
|
||||
```bash
|
||||
-javaagent:unsup.jar
|
||||
```
|
||||
|
||||
Launch the game, and the modpack will automatically download itself and update on launch.
|
||||
|
||||
### Other Launchers
|
||||
|
||||
If your launcher supports custom JVM arguments, move the `unsup_setup` file into your instance's `.minecraft` folder and run it, then add the following argument to your JVM arguments.
|
||||
|
||||
```bash
|
||||
-javaagent:unsup.jar
|
||||
```
|
||||
|
||||
If it doesn't, please contact us in our [Discord server](https://invite.galacticfactory.cc/).
|
||||
We do not support the vanilla Minecraft Launcher. If you're looking for a launcher to use, I'd recommend [Prism Launcher](https://prismlauncher.org/).
|
||||
</details>
|
||||
</details>
|
||||
|
||||
<!-- ### Modifying Optional Content
|
||||
|
||||
This modpack includes some mods and resource packs that are optional. You can turn these on or off in the Unsup Installation GUI.
|
||||
|
||||
- Delete the `.unsup-state.json`file in your `.minecraft`/instance directory.
|
||||
- Make sure you have hidden files set to show up in File Explorer.
|
||||
- Start the game.
|
||||
- Click on the mods you'd like to install. Hovering over a mod's name will show its description. (Image shown is of Packwiz, not Unsup.)
|
||||

|
||||
- Click `OK`. You're done! -->
|
|
@ -11,6 +11,9 @@ site_description: Documentation for the GalacticFactory modpack.
|
|||
|
||||
nav:
|
||||
- Home: index.md
|
||||
- Installing a Launcher: installing-a-launcher.md
|
||||
- Installing the Modpack: installing-the-modpack.md
|
||||
- Common Issues: common-issues.md
|
||||
|
||||
plugins:
|
||||
- git-authors
|
||||
|
|