Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add guides on using Fabric with Third Party Launchers #160

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions .vitepress/sidebars/players.ts
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,42 @@ export default [
},
],
},
{
text: "players.thirdParty",
link: "/players/third-party",
/*
"Using Fabric with Modrinth App"
"Using Fabric with CurseForge App"
"Using Fabric with Prism Launcher"
"Using Fabric with ATLauncher"
"Using Fabric with GDLauncher Carbon"
"Using Fabric with FTB App"
*/
items: [
{
text: "players.thirdParty.modrinth",
link: "/players/third-party/modrinth",
},
{
text: "players.thirdParty.curseforge",
link: "/players/third-party/curseforge",
},
{
text: "players.thirdParty.prism",
link: "/players/third-party/prism",
},
{
text: "players.thirdParty.atlauncher",
link: "/players/third-party/atlauncher",
},
{
text: "players.thirdParty.gdlauncher",
link: "/players/third-party/gdlauncher",
},
{
text: "players.thirdParty.ftb",
link: "/players/third-party/ftb",
},
]
}
] as Fabric.SidebarItem[];
36 changes: 36 additions & 0 deletions players/third-party/atlauncher.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: Fabric with ATLauncher
description: A guide on installing and using Fabric with ATLauncher.
---

# Fabric with ATLauncher {#fabric-with-atlauncher}

::: warning
Fabric does not endorse any third-party tools listed within this section, and we do not provide support for them. If you encounter any issues with these tools, please report them to the respective tool's developers.
:::

ATLauncher is a modpack launcher that supports Fabric mods and modpacks. This page will guide you through the process of installing Fabric and adding Fabric mods and modpacks with ATLauncher.

## Installing Fabric {#installing-fabric}

First, you will need to enter the `Create Pack` panel. You should be presented with a list of Minecraft versions, and the option to choose a mod loader.

Select the Minecraft version you want to install Fabric for, and then choose `Fabric` in the list of mod loaders, usually, ATLauncher selects the latest version of Fabric Loader for you automatically:

![ATLauncher Create Pack Window](/assets/players/third-party/atlauncher-create-pack.png)

::: warning
Don't forget to login with your Microsoft Account on the `Accounts` panel, or ATLauncher will not allow you to create any instances.

You will need to select your account from the list of accounts when you've added it.
:::

Once you've selected your Minecraft version and Fabric Loader version, click `Create Instance`. ATLauncher will download and install Fabric Loader for you and create a profile for it.

## Installing Fabric Mods {#installing-fabric-mods}

To add Fabric mods to your instance, you will need to click on the `Instances` tab and select the instance you want to add mods to. Click on the `Add Mods` button to open the search panel.

![Mod Search Panel](/assets/players/third-party/atlauncher-mod-search.png)

Alternatively, you can access this panel by clicking on `Edit Mods` on the instance you want to add mods to and then clicking on the `Add Mods` button.
32 changes: 32 additions & 0 deletions players/third-party/ftb.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: Fabric with FTB App
description: A guide on installing and using Fabric with the FTB App.
---

# Fabric with FTB App {#fabric-with-ftb-app}

::: warning
Fabric does not endorse any third-party tools listed within this section, and we do not provide support for them. If you encounter any issues with these tools, please report them to the respective tool's developers.
:::

The FTB App is a modpack launcher that supports Fabric mods and modpacks. This page will guide you through the process of installing Fabric and adding Fabric mods and modpacks with the FTB App.

## Installing Fabric {#installing-fabric}

To install Fabric with the FTB App, you will need to create a new instance and select the Fabric Loader as the mod loader. You can create a new instance by clicking the `+` button in the top left corner of the FTB App window.

![FTB App + Button](/assets/players/third-party/ftb-app-add-instance.png)

Select `Create Instance` from the dropdown menu. This will bring up the `Create Instance` wizard which will guide you through the process of creating a new instance. You should select Fabric as the mod loader when prompted on the `Mod Loader` step.

![FTB Mod Loader Step](/assets/players/third-party/ftb-app-mod-loader.png)

Continue the wizard, the FTB App should begin to download Minecraft and install Fabric Loader for you. Once the installation is complete, you can launch the instance by clicking on it and pressing `Play`.

## Installing Fabric Mods {#installing-fabric-mods}

To install Fabric mods with the FTB App, you will need to **right click** on the instance you want to add mods to, and select `Open Folder` then `Instance Folder`. This will open the instance folder where you can place your Fabric mods.

![FTB App Instance Folder](/assets/players/third-party/ftb-app-instance-folder.png)

If the `mods` folder does not exist, you should create it - The FTB App does not support downloading mods, you will need to manually place the mods in the `mods` folder. Consider reading the [Finding Trustworthy Mods](../finding-mods) guide to ensure you are downloading mods from a trustworthy source.
36 changes: 36 additions & 0 deletions players/third-party/gdlauncher.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: Using Fabric with GDLauncher
description: A guide on using Fabric with GDLauncher.
---

# Using Fabric with GDLauncher {#fabric-with-gdlauncher}

::: warning
Fabric does not endorse any third-party tools listed within this section, and we do not provide support for them. If you encounter any issues with these tools, please report them to the respective tool's developers.

This page is for GDLauncher Carbon, the new version of GDLauncher. If you are using the old version of GDLauncher you should upgrade to GDLauncher Carbon.
:::

GDLauncher is a modpack launcher that supports Fabric mods and modpacks. This page will guide you through the process of installing Fabric and adding Fabric mods and modpacks with GDLauncher.

## Installing Fabric {#installing-fabric}

To install Fabric with GDLauncher, you will need to create a new instance and select the Fabric Loader as the mod loader. You can create a new instance by clicking the `+ Add Instance` button in the top right corner of the GDLauncher window.

![GDLauncher Add Instance Button](/assets/players/third-party/gdlauncher-add-instance.png)

This will bring up a `New Instance` popup where you can select the Minecraft version and mod loader. Select the Minecraft version you want to install Fabric for, and then choose `Fabric` in the list of mod loaders.

![GDLauncher New Instance Popup](/assets/players/third-party/gdlauncher-create-instance.png)

The launcher should begin to download Minecraft and install Fabric Loader for you, this may take a few minutes. Once the installation is complete, you can launch the instance by clicking the `Play` button.

## Installing Fabric Mods {#installing-fabric-mods}

Once the Fabric instance has been created, you can add Fabric mods to it by clicking on the instance and navigating to the `Mods` window. Click the `Add Mod` button to open the mod selection window.

![GDLauncher Mods Tab](/assets/players/third-party/gdlauncher-mods-tab.png)

You can search for Fabric mods by typing the mod name in the search bar, or you can drag and drop the mod JAR file into the window. Once you have added the mods you want, click the `Go to installed mods` button, which is next to the search bar, to view the mods you have added

![GDLauncher Mods Search](/assets/players/third-party/gdlauncher-mods-search.png)
14 changes: 14 additions & 0 deletions players/third-party/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Third-Party Tools
description: A collection of guides on using Fabric with third-party tools such as modpack launchers and server software.
---

# Third-Party Tools {#third-party-tools}

::: warning
Fabric does not endorse any third-party tools listed within this section, and we do not provide support for them. If you encounter any issues with these tools, please report them to the respective tool's developers.
:::

This section of the Fabric Documentation is dedicated to players and server administrators who want to learn how to use Fabric with third-party tools such as modpack launchers and server software.

You should refer to the sidebar for a list of all the guides available.
24 changes: 24 additions & 0 deletions players/third-party/modrinth.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: Fabric with Modrinth App
description: A guide on installing and using Fabric with the Modrinth App.
---

# Fabric with Modrinth App {#fabric-with-modrinth-app}

::: warning
Fabric does not endorse any third-party tools listed within this section, and we do not provide support for them. If you encounter any issues with these tools, please report them to the respective tool's developers.
:::

The Modrinth App supports Fabric mods and modpacks, this page will guide you through the process of installing Fabric and adding Fabric mods and modpacks with the Modrinth App.

## Installing Fabric {#installing-fabric}

Once you've installed the Modrinth App and logged in with your Microsoft account, you can install Fabric by following these steps:

<!-- TODO: This. -->

## Installing Fabric Mods {#installing-fabric-mods}

To install Fabric mods with the Modrinth App, you can follow these steps:

<!-- TODO: This. -->
36 changes: 36 additions & 0 deletions players/third-party/prism.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: Fabric with Prism
description: A guide on installing and using Fabric with Prism Launcher.
---

# Fabric with Prism Launcher {#fabric-with-prism-launcher}

::: warning
Fabric does not endorse any third-party tools listed within this section, and we do not provide support for them. If you encounter any issues with these tools, please report them to the respective tool's developers.
:::

Prism Launcher is a modpack launcher that supports Fabric mods and modpacks. This page will guide you through the process of installing Fabric and adding Fabric mods and modpacks with Prism Launcher.

## Installing Fabric {#installing-fabric}

First, click on the `Add Instance` button at the top of the Prism Launcher window. This should open the `Add Instance` window.

You should select the Minecraft version you want to install Fabric for, and then clicking `Fabric` in the `Mod Loader` list. It's recommended to choose the latest stable version of Fabric Loader, which is indicated with a star:

![Prism Launcher Add Instance Window](/assets/players/third-party/prism-add-instance.png)

Once you've selected your Minecraft version and Fabric Loader version, click `Okay`. The Prism Launcher will download and install Fabric Loader for you and create a profile for it.

## Installing Fabric Mods {#installing-fabric-mods}

You will first need to select your instance from the list of instances in the Prism Launcher window and click `Edit` on the sidebar - this will open the `Console Window` for your instance.

![Edit Button Prism Launcher](/assets/players/third-party/prism-edit-instance-button.png)

In the `Console Window`, click on the `Mods` tab. You can then either click `Add Mod` to add a jar mod file from your computer, or `Download Mods` to download mods from either Modrinth or CurseForge.

::: tip
Using `Download Mods` allows Prism Launcher to notify you when mods have updates, and allow you to automatically update the mods without needing to manually uninstall and reinstall them.
:::

![Mods Tab](/assets/players/third-party/prism-mods-tab.png)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions sidebar_translations.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,13 @@
"players.troubleshooting.uploadingLogs": "Uploading Logs",
"players.troubleshooting.crashReports": "Crash Reports",
"players.updatingFabric": "Updating Fabric",
"players.thirdParty": "Third-Party Tools",
"players.thirdParty.modrinth": "Fabric with Modrinth App",
"players.thirdParty.curseforge": "Fabric with CurseForge App",
"players.thirdParty.prism": "Fabric with Prism Launcher",
"players.thirdParty.atlauncher": "Fabric with ATLauncher",
"players.thirdParty.gdlauncher": "Fabric with GDLauncher",
"players.thirdParty.ftb": "Fabric with FTB App",
"develop.title": "Developer Guides",
"develop.gettingStarted": "Getting Started",
"develop.gettingStarted.introduction": "Introduction to Fabric and Modding",
Expand Down
Loading