diff --git a/docs/.gitbook/assets/291192276-a27c3525-558b-47f6-afc8-4a94f9c08be9.png b/docs/.gitbook/assets/291192276-a27c3525-558b-47f6-afc8-4a94f9c08be9.png deleted file mode 100644 index eabda3a..0000000 Binary files a/docs/.gitbook/assets/291192276-a27c3525-558b-47f6-afc8-4a94f9c08be9.png and /dev/null differ diff --git a/docs/.gitbook/assets/image (3).png b/docs/.gitbook/assets/image (3).png deleted file mode 100644 index 8cf7ab5..0000000 Binary files a/docs/.gitbook/assets/image (3).png and /dev/null differ diff --git a/docs/.gitbook/assets/image (4).png b/docs/.gitbook/assets/image (4).png deleted file mode 100644 index 8cf7ab5..0000000 Binary files a/docs/.gitbook/assets/image (4).png and /dev/null differ diff --git a/docs/.gitbook/assets/image.png b/docs/.gitbook/assets/image.png deleted file mode 100644 index 2fd0d24..0000000 Binary files a/docs/.gitbook/assets/image.png and /dev/null differ diff --git a/docs/.gitbook/assets/modrinth-card.png b/docs/.gitbook/assets/modrinth-card.png new file mode 100644 index 0000000..39e4ce2 Binary files /dev/null and b/docs/.gitbook/assets/modrinth-card.png differ diff --git a/docs/.gitbook/assets/image (1).png b/docs/.gitbook/assets/modrinth-download.png similarity index 100% rename from docs/.gitbook/assets/image (1).png rename to docs/.gitbook/assets/modrinth-download.png diff --git a/docs/.gitbook/assets/modrinth-install.png b/docs/.gitbook/assets/modrinth-install.png new file mode 100644 index 0000000..b0e7a0b Binary files /dev/null and b/docs/.gitbook/assets/modrinth-install.png differ diff --git a/docs/.gitbook/assets/modrinth-play.png b/docs/.gitbook/assets/modrinth-play.png new file mode 100644 index 0000000..8981937 Binary files /dev/null and b/docs/.gitbook/assets/modrinth-play.png differ diff --git a/docs/.gitbook/assets/image (2).png b/docs/.gitbook/assets/modrinth-search.png similarity index 100% rename from docs/.gitbook/assets/image (2).png rename to docs/.gitbook/assets/modrinth-search.png diff --git a/docs/.gitbook/assets/modrinth-variants.png b/docs/.gitbook/assets/modrinth-variants.png new file mode 100644 index 0000000..c5f4f28 Binary files /dev/null and b/docs/.gitbook/assets/modrinth-variants.png differ diff --git a/docs/.gitbook/assets/image (5).png b/docs/.gitbook/assets/prism-add.png similarity index 100% rename from docs/.gitbook/assets/image (5).png rename to docs/.gitbook/assets/prism-add.png diff --git a/docs/.gitbook/assets/prism-play.png b/docs/.gitbook/assets/prism-play.png new file mode 100644 index 0000000..796d511 Binary files /dev/null and b/docs/.gitbook/assets/prism-play.png differ diff --git a/docs/.gitbook/assets/prism-search.png b/docs/.gitbook/assets/prism-search.png new file mode 100644 index 0000000..a9fae2d Binary files /dev/null and b/docs/.gitbook/assets/prism-search.png differ diff --git a/docs/README.md b/docs/README.md index d1be1e5..ea52945 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,8 @@ # 🌎 OptimumFuse -[![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) [![CurseForge](https://img.shields.io/badge/On-CurseForge-%23f16436?style=for-the-badge\&logo=curseforge)](https://www.curseforge.com/minecraft/modpacks/optimum-fuse) +[![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) +[![CurseForge](https://img.shields.io/badge/On-CurseForge-%23f16436?style=for-the-badge\&logo=curseforge)](https://www.curseforge.com/minecraft/modpacks/optimum-fuse) *** @@ -24,16 +26,17 @@ This project uses **semantic versioning**. `X`.`Y`.`Z`+``.`` -**Definitions:** (a) _Project Version_ +**Definitions:** +(a) _Project Version_ -1. **`X`:** MAJOR version _(Not likely to change; for a long time!)_ -2. **`Y`:** MINOR version _(Will change frequently; For new MC versions/Big updates)_ -3. **`Y`:** PATCH version _(Will change very frequently; Small changes/Mod updates/...)_ +- **`X`:** MAJOR version _(Not likely to change; for a long time!)_ +- **`Y`:** MINOR version _(Will change frequently; For new MC versions/Big updates)_ +- **`Y`:** PATCH version _(Will change very frequently; Small changes/Mod updates/...)_ (b) _Build Metadata_ -1. **``:** **Values:** `fabric` or `neo`. -2. **``:** **Examples:** `1.16.5`, `1.19.2`, `1.20.1` and so on... +- **``:** **Values:** `fabric` or `neo`. +- **``:** **Examples:** `1.16.5`, `1.19.2`, `1.20.1` and so on... *** @@ -42,9 +45,9 @@ This project uses **semantic versioning**. `X`.`Y`.`Z`-``+``.`` **``:** _(For untested/breaking changes/not ready for use versions)_\ -**Values:**\ -i) **`alpha`**\ -ii) **`beta`** +**Values:** +- **`alpha`** +- **`beta`** @@ -56,16 +59,24 @@ You can find all the mods included in this modpack under the `Dependencies` sect ### 📱Awesome Features: -#### 🍀BetterGrass ![](https://cdn.modrinth.com/data/nQYjpo27/images/31bd83bbec4ebc32b93c5df44bef5a3120712350.png) 💡DynamicLights ![](https://cdn.modrinth.com/data/nQYjpo27/images/f7e8edcd60a9da9697b97f19c053f3c9bf9fa052.jpeg) +#### 🍀BetterGrass -#### 📐CEM ![](https://cdn.modrinth.com/data/nQYjpo27/images/604cd4f40248d33568297057be3e2e55fc30cb5c.png) +![](https://cdn.modrinth.com/data/nQYjpo27/images/31bd83bbec4ebc32b93c5df44bef5a3120712350.png) + +####💡DynamicLights + +![](https://cdn.modrinth.com/data/nQYjpo27/images/f7e8edcd60a9da9697b97f19c053f3c9bf9fa052.jpeg) + +#### 📐CEM + +![](https://cdn.modrinth.com/data/nQYjpo27/images/604cd4f40248d33568297057be3e2e55fc30cb5c.png) + +#### 🔎C-Zoom -\ -🔎C-Zoom\ ![](https://cdn.modrinth.com/data/nQYjpo27/images/dc47cebce74e47a79cc83208d66cab28198e4b8e.png) -\ -🖇️ConnectedTextures\ +#### 🖇️ConnectedTextures + ![](https://cdn.modrinth.com/data/nQYjpo27/images/491f56c2fa8361fd7e44f022411cd98fbb38d226.png) **and much more...!** @@ -78,4 +89,4 @@ All releases are published using **Kir-Antipov**'s [**GitHub Action**](https://g ### 📜License -#### Check the complete license here: [**Apache License 2.0**](https://raw.githubusercontent.com/UltimatChamp/optimum-fuse/main/LICENSE)! +Check the complete license here: [**Apache License 2.0**](https://raw.githubusercontent.com/UltimatChamp/optimum-fuse/main/LICENSE)! diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index ff224e3..011ace9 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -1,7 +1,7 @@ # Table of contents * [🌎 OptimumFuse](README.md) -* [Getting Started](getting-started.md) +* [▶️ Getting Started](getting-started.md) ## Overview diff --git a/docs/getting-started.md b/docs/getting-started.md index bd6331c..d728218 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -1,14 +1,17 @@ -# Getting Started +# ▶️ Getting Started -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**. {% tabs %} + {% tab title="Modrinth App" %} + ### Installing the Launcher -[![Install Here: Modrinth Theseus](https://img.shields.io/badge/Install%20Here-Modrinth%20Theseus-%2300AF5C?style=for-the-badge\&logo=modrinth\&link=https%3A%2F%2Fmodrinth.com%2Fapp)](https://modrinth.com/app) +[![](https://img.shields.io/badge/Install%20Here-Modrinth%20App-%2300AF5C?style=for-the-badge&logo=modrinth)](https://modrinth.com/app) -
+![](.gitbook/assets/modrinth-download.png) ### Setup @@ -16,40 +19,81 @@ Go through the installation process, including adding your Minecraft account! ### Installing OptimumFuse -* Click on the **Browse** button. +- Click on the **Browse** button. - ![](<.gitbook/assets/image (2).png>) +![](.gitbook/assets/modrinth-download.png) -* Search _"OptimumFuse"_. +- Search _"OptimumFuse"_. - ![Broken Image](https://github.com/UltimatChamp/optimum-fuse/assets/140878474/507e45a6-631a-4851-9dd0-3e831f62f6d5) +![](.gitbook/assets/modrinth-install.png) -You can also choose a specific variant of the modpack. The modpack offers four variants: **Fabric** | **NeoForge**.![image](https://github.com/UltimatChamp/optimum-fuse/assets/140878474/8e56b9a7-fd72-4a82-a4ba-ebcca930be2a) +- You can also choose a specific variant of the modpack. The modpack, currently, + offers two variants: **Fabric** | **NeoForge**. + ![](.gitbook/assets/modrinth-variants.png) ### Run Minecraft -Navigate back to **Home** and click on the modpack card.\ -![image](https://github.com/UltimatChamp/optimum-fuse/assets/140878474/5f1f36df-74b9-4a12-8aec-cb3e23d33ce2) - -Click **Play**.\ -![image](https://github.com/UltimatChamp/optimum-fuse/assets/140878474/d98b6b39-e82b-4f97-9d8f-4302dbf86ebb) - -Now you're ready to enjoy the ultimate, optimized Minecraft experience! +- Navigate back to **Home** and click on the modpack card. + ![](.gitbook/assets/modrinth-card.png) +- Click **Play**. ![](.gitbook/assets/modrinth-play.png) {% endtab %} {% tab title="Prism Launcher" %} + ### Installing the Launcher -
+[![](https://img.shields.io/badge/Install%20Here-Prism%20Launcher-%23d74059?style=for-the-badge)](https://prismlauncher.org/download/windows) + +### Setup + +Go through the installation process, including adding your Minecraft account! + +### Installing OptimumFuse + +- Click on the **Add Instance** button. ![](.gitbook/assets/prism-add.png) +- A new window will pop-up. Select the **Modrinth** tab, and search + **OptimumFuse**. ![](.gitbook/assets/prism-search.png) +- Click on the modpack card, and click on **Ok**. + +- Click the **Launch** button to start the game. + ![](.gitbook/assets/prism-play.png) -
{% endtab %} -{% endtabs %} +{% tab title="ATLauncher" %} + +_Here are some useful links:_ + +- **How + to Play Modpacks with the ATLauncher - Apex Hosting** +{% endtab %} + +{% tab title="CurseForge App" %} + +_Here are some useful links:_ + +- **Installing + Minecraft modpacks from the CurseForge App - CurseForge Support** + +{% endtab %} + +{% tab title="Minecraft Launcher" %} + +**Minecraft Launcher** is not supported. + +{% endtab %} + +{% tab title="Other Launchers" %} + +Refer to your launcher's documentation. + +{% endtab %} + +{% endtabs %} -### +Now you're ready to enjoy your new, enhanced Minecraft experience!