reorganized the installation guides
Some checks failed
Build Documentation / Build Documentation (push) Failing after 6s
Build Exported Instance Files / Build Prism Launcher Export (push) Successful in 3s
Build Exported Instance Files / Build ATLauncher Export (push) Successful in 3s

This commit is contained in:
SeaswimmerTheFsh 2024-02-05 19:15:05 -05:00
parent 54e02658df
commit a5f5bef5cd
Signed by: cswimr
GPG key ID: B8953EC01E5C4063
8 changed files with 43 additions and 99 deletions

View file

@ -1,98 +0,0 @@
# 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.
![image](https://seafsh.cc/u/GnZb9Z.png)
## 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.)
![image](https://media.seaswimmer.cc/2zKsUOw/direct.png)
- Click `OK`. You're done! -->

View file

@ -0,0 +1 @@
# Installing the Modpack

View file

@ -0,0 +1,10 @@
## Installing the Modpack 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.
![image](https://seafsh.cc/u/GnZb9Z.png)

View file

@ -0,0 +1,15 @@
# Installing the Modpack on 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.md).

View file

@ -0,0 +1,11 @@
# Installing the Modpack with unsup
[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](https://www.coastalcommits.com/GalacticFactory/GalacticFactory/releases/download/Pre-Release/unsup_setup.sh).
After that, follow the instructions below for your platform:
- [Modrinth App](./modrinth.md)
- [Servers](./servers/servers.md)

View file

@ -12,7 +12,12 @@ 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
- Installing the Modpack: installing-the-modpack/installing-the-modpack.md
- Prism Launcher: installing-the-modpack/prism-launcher.md
- Unsup: installing-the-modpack/unsup/unsup.md
- Modrinth App: installing-the-modpack/unsup/modrinth-app.md
- Servers: installing-the-modpack/unsup/servers/servers.md
- Post-Install Tips and Tricks: installing-the-modpack/unsup/servers/post-install-tips-and-tricks.md
- Common Issues: common-issues.md
plugins: