diff --git a/docs/installing-the-modpack/modrinth.md b/docs/installing-the-modpack/modrinth.md new file mode 100644 index 0000000..9a89647 --- /dev/null +++ b/docs/installing-the-modpack/modrinth.md @@ -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. diff --git a/docs/installing-the-modpack/servers/index.md b/docs/installing-the-modpack/servers/index.md new file mode 100644 index 0000000..e39d66c --- /dev/null +++ b/docs/installing-the-modpack/servers/index.md @@ -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). diff --git a/docs/installing-the-modpack/servers/post-install-tips-and-tricks.md b/docs/installing-the-modpack/servers/post-install-tips-and-tricks.md new file mode 100644 index 0000000..89d6206 --- /dev/null +++ b/docs/installing-the-modpack/servers/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 +``` diff --git a/docs/installing-the-modpack/unsup/index.md b/docs/installing-the-modpack/unsup/index.md deleted file mode 100644 index bec451f..0000000 --- a/docs/installing-the-modpack/unsup/index.md +++ /dev/null @@ -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) diff --git a/docs/installing-the-modpack/unsup/modrinth.md b/docs/installing-the-modpack/unsup/modrinth.md deleted file mode 100644 index e69de29..0000000 diff --git a/docs/installing-the-modpack/unsup/servers/index.md b/docs/installing-the-modpack/unsup/servers/index.md deleted file mode 100644 index 6ec7818..0000000 --- a/docs/installing-the-modpack/unsup/servers/index.md +++ /dev/null @@ -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). diff --git a/docs/installing-the-modpack/unsup/servers/post-install-tips-and-tricks.md b/docs/installing-the-modpack/unsup/servers/post-install-tips-and-tricks.md deleted file mode 100644 index e69de29..0000000 diff --git a/mkdocs.yml b/mkdocs.yml index 44d41ba..f8cce48 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -15,12 +15,10 @@ nav: - Installing the Modpack: - installing-the-modpack/index.md - Prism Launcher: installing-the-modpack/prism-launcher.md - - Unsup: - - installing-the-modpack/unsup/index.md - - Modrinth App: installing-the-modpack/unsup/modrinth-app.md - - Servers: - - installing-the-modpack/unsup/servers/index.md - - Post-Install Tips and Tricks: installing-the-modpack/unsup/servers/post-install-tips-and-tricks.md + - Modrinth App: installing-the-modpack/modrinth.md + - Servers: + - installing-the-modpack/servers/index.md + - Post-Install Tips and Tricks: installing-the-modpack/servers/post-install-tips-and-tricks.md - Common Issues: common-issues.md plugins: