This repository has been archived on 2025-03-02. You can view files and clone it, but cannot push or open issues or pull requests.
GalacticFactory-Legacy/README.md

138 lines
4.7 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# GalacticFactory
## Installation
Currently, there are only two supported methods of installing the modpack, as it has not been released on Modrinth yet.
<details>
<summary>
<h3> Installing with Prism Launcher or ATLauncher </h3>
</summary>
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.
Alternatively, you can use this link in your launcher instead of downloading the zip file manually.
```markdown
# For Prism Launcher
https://coastalcommits.com/GalacticFactory/GalacticFactory/releases/download/Pre-Release/GalacticFactory%20-%20Prism%20Launcher.zip
# For ATLauncher
https://coastalcommits.com/GalacticFactory/GalacticFactory/releases/download/Pre-Release/GalacticFactory%20-%20ATLauncher.zip
```
<details>
<summary>
View image
</summary>
![image](https://seafsh.cc/u/GnZb9Z.png)
</details>
</details>
<details>
<summary>
<h3> Installing with unsup </h3>
<h4> (Other Launchers/Servers) </h4>
</summary>
[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://coastalcommits.com/GalacticFactory/GalacticFactory/releases/download/Pre-Release/unsup_setup.ps1).
If you're on Linux or MacOS, use [this link](coastalcommits.com/GalacticFactory/GalacticFactory/releases/download/Pre-Release/unsup_setup.sh).
After that, follow the instructions below for your platform:
<details>
<summary>
<h4> Servers </h4>
</summary>
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:
<details>
<summary>
✨ Post-install tips and tricks
</summary>
### Pre-loading chunks (Servers)
I highly recommend pre-loading your chunks so that you can prevent lag when players generate new ones. Chunky is included in AdrenaFactory as of 1.1.2, 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**.
You **must** install [Chunky](https://modrinth.com/project/chunky) to do this.
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
```
</details>
</details>
<details>
<summary>
<h4> Modrinth App </h4>
</summary>
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.
</details>
<details>
<summary>
<h4> Other Launchers </h4>
</summary>
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! -->