Skip to content

Commit

Permalink
docs: add documentation for modrinth app 0.9+
Browse files Browse the repository at this point in the history
* optimize images
* some formatting
  • Loading branch information
UltimatChamp committed Dec 30, 2024
1 parent c1e927b commit 0ef9eb6
Show file tree
Hide file tree
Showing 23 changed files with 156 additions and 77 deletions.
40 changes: 20 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,19 @@ modrinth:
---
# Optimum<font color="#ff6600">Fuse</font>

<center><img alt="Logo" width="100px" src="https://cdn.modrinth.com/data/nQYjpo27/9c5b4b56b78def489eacc7cd7a9222511f75addf.png">
<center>

<img alt="Logo" width="100px" src="https://cdn.modrinth.com/data/nQYjpo27/9c5b4b56b78def489eacc7cd7a9222511f75addf.png">

<hr />
***

[![Wiki](https://img.shields.io/badge/OF-Wiki-%2300AF5C?style=for-the-badge&logo=gitbook&logoColor=%23fff&color=blue)](https://moddedmc.org/en/project/optimum-fuse/docs)
[![Discord](https://img.shields.io/badge/Discord-Server-%2300AF5C?style=for-the-badge&logo=discord&logoColor=%23fff&color=%235865F2)](https://discord.gg/kfKjjhv3pn)
[![Modrinth](https://img.shields.io/badge/On-Modrinth-%2300AF5C?style=for-the-badge&logo=modrinth)](https://modrinth.com/modpack/optimum-fuse)

</center>

<hr />
***

## For Fabric📜 and Neoforge🦊

Expand All @@ -26,11 +28,11 @@ All optimizations in the modpack are based on [**Exceptionally Optimized**](http

If you find a bug or want to suggest any feature, you can issue a [**🐞Bug Report | 💡Suggestion**](https://github.com/UltimatChamp/optimum-fuse/issues/new/choose). Alternatively, we have a [**Discord**](https://discord.gg/kfKjjhv3pn) server.

<hr />
***

<details id="versioning">
<summary>🧪Versioning</summary>

This project uses **semantic versioning**.

**Format:** <center>`X`.`Y`.`Z`+`<loader>`.`<mc-version>`</center>
Expand All @@ -48,7 +50,7 @@ This project uses **semantic versioning**.
1. **`<loader>`:** **Values:** `fabric` or `neo`.
2. **`<mc-version>`:** **Examples:** `1.16.5`, `1.19.2`, `1.20.1` and so on...

<hr />
***

**Pre-release Versions' Format:** <center>`X`.`Y`.`Z`-`<pre-release>`+`<loader>`.`<mc-version>`</center>

Expand All @@ -59,7 +61,7 @@ ii) **`beta`**

</details>

<hr />
***

## 🎲Mods Used

Expand All @@ -69,43 +71,41 @@ You can find all the mods included in this modpack under the `Dependencies` sect

<center>

<h3>🌆Awesome<font color="magenta">Shaders</font><br><br>
### 🌆Awesome<font color="magenta">Shaders</font><br><br>

<img src="https://cdn.modrinth.com/data/nQYjpo27/images/56bf6d61e12491db23ba0d92a46a714737eda279.png" width="625">

<hr />
***

⛏️Fancy<font color="cyan">Tooltips</font>
### ⛏️Fancy<font color="cyan">Tooltips</font>

<img src="https://cdn.modrinth.com/data/nQYjpo27/images/73034f16705ac7fe26464869ff6c62d88cdff247.png" width="625">

<hr />
***

✨Cool<font color="lime">Effects</font>
### ✨Cool<font color="lime">Effects</font>

<img src="https://cdn.modrinth.com/data/nQYjpo27/images/24306974e406d7d3b9834f056fc91e667646649f.png" width="625">

<hr />
***

🔎3D<font color="yellow">Particles</font>
### 🔎3D<font color="yellow">Particles</font>

<img src="https://cdn.modrinth.com/data/nQYjpo27/images/31b91a5862d8f2d9021995c69123085bb3dc9c01.png" width="625">

<hr />
***

🏃‍♂️Better<font color="magenta">PlayerAnimations</font>
### 🏃‍♂️Better<font color="magenta">PlayerAnimations</font>

<img src="https://cdn.modrinth.com/data/9pR04wDX/images/a16f117721965f80de2afc0f109473bb561f42da.png" width="625">

<hr />
***

🍀OptiFine<font color="green">Parity</font>
### 🍀OptiFine<font color="green">Parity</font>

<img src="https://cdn.modrinth.com/data/nQYjpo27/images/491f56c2fa8361fd7e44f022411cd98fbb38d226.png" width="333"> <img src="https://cdn.modrinth.com/data/nQYjpo27/images/604cd4f40248d33568297057be3e2e55fc30cb5c.png" width="361"><br>
<img src="https://cdn.modrinth.com/data/nQYjpo27/images/dc47cebce74e47a79cc83208d66cab28198e4b8e.png" width="249"> <img src="https://cdn.modrinth.com/data/nQYjpo27/images/ddff06137975c547f990f93d117e4dca87aa0199.png" width="446">

</h3>

</center>

### **and much more...!**
Expand Down
Binary file modified docs/.assets/item/optimum-fuse/modrinth_card.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.assets/item/optimum-fuse/modrinth_download.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.assets/item/optimum-fuse/modrinth_install.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.assets/item/optimum-fuse/modrinth_play.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.assets/item/optimum-fuse/modrinth_search.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.assets/item/optimum-fuse/modrinth_variants.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.
Binary file modified docs/.assets/item/optimum-fuse/prism_add.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.assets/item/optimum-fuse/prism_play.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.assets/item/optimum-fuse/prism_search.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/_meta.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"getting_started.mdx": "Getting Started",
"info": "Info",
"post_installation": "Post Installation",
"info": "Info",
"contributing": "Contributing"
}
104 changes: 81 additions & 23 deletions docs/getting_started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,77 @@ title: Getting Started
hide_meta: true
---

Click on your favorite launcher and follow the instructions below. If you're not
sure, you can try **Modrinth App** or **Prism Launcher**.
Click on your favorite launcher and follow the instructions below. If you're not sure, you can try **Modrinth App** or **Prism Launcher**.

<hr />
***

<details open="open">
<summary>**Modrinth App _(new)_**</summary>

<summary>**Modrinth App**</summary>
## Installing the Launcher

[![](https://img.shields.io/badge/Install%20Here-Modrinth%20App-%2300AF5C?style=for-the-badge)](https://modrinth.com/app)

<ModAsset
width="100%"
title="Modrinth Download"
location="optimum-fuse:modrinth_download"
/>

## Setup

Go through the installation process, including adding your Minecraft account!

## Installing OptimumFuse

- Click on the `Discover content` button.

<ModAsset
width="100%"
title="Modrinth Search"
location="optimum-fuse:new_modrinth_search"
/>

- Search _"OptimumFuse"_, and click on `Install`.

<ModAsset
width="100%"
title="Modrinth Install"
location="optimum-fuse:new_modrinth_install"
/>

- You can also choose a specific variant of the modpack. The modpack, currently, offers two variants: `Fabric` | `NeoForge`.

<ModAsset
width="100%"
title="Modrinth Variants"
location="optimum-fuse:new_modrinth_variants"
/>

## Run Minecraft

- Navigate back to `Home` and click on the modpack card.

<ModAsset
width="50%"
title="Modrinth Card"
location="optimum-fuse:new_modrinth_card"
/>

- Click `Play`.

<ModAsset
width="100%"
title="Modrinth Play"
location="optimum-fuse:new_modrinth_play"
/>

</details>

***

<details>
<summary>**Modrinth App _(old)_**</summary>

## Installing the Launcher

Expand All @@ -28,24 +91,23 @@ Go through the installation process, including adding your Minecraft account!

## Installing OptimumFuse

- Click on the **Browse** button.
- Click on the `Browse` button.

<ModAsset
width="100%"
title="Modrinth Search"
location="optimum-fuse:modrinth_search"
/>

- Search _"OptimumFuse"_.
- Search _"OptimumFuse"_, and click on `Install`.

<ModAsset
width="100%"
title="Modrinth Install"
location="optimum-fuse:modrinth_install"
/>

- You can also choose a specific variant of the modpack. The modpack, currently,
offers two variants: **Fabric** | **NeoForge**.
- You can also choose a specific variant of the modpack. The modpack, currently, offers two variants: `Fabric` | `NeoForge`.

<ModAsset
width="100%"
Expand All @@ -55,15 +117,15 @@ Go through the installation process, including adding your Minecraft account!

## Run Minecraft

- Navigate back to **Home** and click on the modpack card.
- Navigate back to `Home` and click on the modpack card.

<ModAsset
width="50%"
title="Modrinth Card"
location="optimum-fuse:modrinth_card"
/>

- Click **Play**.
- Click `Play`.

<ModAsset
width="50%"
Expand All @@ -73,10 +135,9 @@ Go through the installation process, including adding your Minecraft account!

</details>

<hr />
***

<details>

<summary>**Prism Launcher**</summary>

## Installing the Launcher
Expand All @@ -89,25 +150,25 @@ Go through the installation process, including adding your Minecraft account!

## Installing OptimumFuse

- Click on the **Add Instance** button.
- Click on the `Add Instance` button.

<ModAsset
width="100%"
title="Prism Add"
location="optimum-fuse:prism_add"
/>

- A new window will pop-up. Select the **Modrinth** tab, and search for _"OptimumFuse"_.
- A new window will pop-up. Select the `Modrinth` tab, and search for _"OptimumFuse"_.

<ModAsset
width="100%"
title="Prism Search"
location="optimum-fuse:prism_search"
/>

- Click on the modpack card, and click on **Ok**.
- Click on the modpack card, and click on `Ok`.

- Click the **Launch** button to start the game.
- Click the `Launch` button to start the game.

<ModAsset
width="100%"
Expand All @@ -117,10 +178,9 @@ Go through the installation process, including adding your Minecraft account!

</details>

<hr />
***

<details>

<summary>**ATLauncher**</summary>

_Here are some useful links:_
Expand All @@ -130,26 +190,24 @@ _Here are some useful links:_

</details>

<hr />
***

<details>

<summary>**Minecraft Launcher**</summary>

**Minecraft Launcher** is not supported.

</details>

<hr />
***

<details>

<summary>**Other Launchers**</summary>

Refer to your launcher's documentation.

</details>

<hr />
***

Now you're ready to enjoy your new, enhanced Minecraft experience!
2 changes: 1 addition & 1 deletion docs/info/changed_options.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ hide_meta: true
| `joinedFirstServer` | false | true | Disable annoying reminder. |
| `soundCategory_master` | 1.0 | 0.4 | Lowers down the volume. |

<hr />
***

### Mod Options

Expand Down
4 changes: 2 additions & 2 deletions docs/info/hidden_features.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,9 @@ Deleted worlds are stored in the **Recycle Bin**.

***

### Dark Mode
### Light Mode

You can turn on **Dark Mode** from the **Resource Packs** menu.
You can turn on **Light Mode**, by disabling `GUI SimpleStylized`, from the **Resource Packs** menu.

***

Expand Down
Loading

0 comments on commit 0ef9eb6

Please sign in to comment.