another installation guide overhaul
This commit is contained in:
parent
487c16459d
commit
1fa76dde6a
8 changed files with 61 additions and 32 deletions
17
docs/installing-the-modpack/modrinth.md
Normal file
17
docs/installing-the-modpack/modrinth.md
Normal file
|
@ -0,0 +1,17 @@
|
||||||
|
# Modrinth App
|
||||||
|
|
||||||
|
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).
|
||||||
|
|
||||||
|
Now, 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.
|
19
docs/installing-the-modpack/servers/index.md
Normal file
19
docs/installing-the-modpack/servers/index.md
Normal file
|
@ -0,0 +1,19 @@
|
||||||
|
# Installing the Modpack on Servers
|
||||||
|
|
||||||
|
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).
|
||||||
|
|
||||||
|
Then, 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).
|
|
@ -0,0 +1,21 @@
|
||||||
|
# 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
|
||||||
|
```
|
|
@ -1,11 +0,0 @@
|
||||||
# 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)
|
|
|
@ -1,15 +0,0 @@
|
||||||
# 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).
|
|
10
mkdocs.yml
10
mkdocs.yml
|
@ -15,12 +15,10 @@ nav:
|
||||||
- Installing the Modpack:
|
- Installing the Modpack:
|
||||||
- installing-the-modpack/index.md
|
- installing-the-modpack/index.md
|
||||||
- Prism Launcher: installing-the-modpack/prism-launcher.md
|
- Prism Launcher: installing-the-modpack/prism-launcher.md
|
||||||
- Unsup:
|
- Modrinth App: installing-the-modpack/modrinth.md
|
||||||
- installing-the-modpack/unsup/index.md
|
- Servers:
|
||||||
- Modrinth App: installing-the-modpack/unsup/modrinth-app.md
|
- installing-the-modpack/servers/index.md
|
||||||
- Servers:
|
- Post-Install Tips and Tricks: installing-the-modpack/servers/post-install-tips-and-tricks.md
|
||||||
- installing-the-modpack/unsup/servers/index.md
|
|
||||||
- Post-Install Tips and Tricks: installing-the-modpack/unsup/servers/post-install-tips-and-tricks.md
|
|
||||||
- Common Issues: common-issues.md
|
- Common Issues: common-issues.md
|
||||||
|
|
||||||
plugins:
|
plugins:
|
||||||
|
|
Reference in a new issue