diff --git a/docs/.gitbook/assets/discord-support.png b/docs/.gitbook/assets/discord-support.png new file mode 100644 index 0000000..a945437 Binary files /dev/null and b/docs/.gitbook/assets/discord-support.png differ diff --git a/docs/README.md b/docs/README.md index 6a37905..9f33459 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,18 +1,28 @@ # 🌎 OptimumFuse +
Logo + +*** + [![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) +
+ *** -### For Fabric📜 and NeoForge🦊 +## For Fabric📜 and NeoForge🦊 -An open-source modpack that improves the game's performance and visuals, inspired by OptiFine, while staying true to the vanilla Minecraft experience. +An open-source modpack that improves the game's performance and visuals, inspired by OptiFine, while staying true to the +vanilla Minecraft experience. -All optimizations in the modpack are based on [**ExceptionallyOptimized**](https://modrinth.com/modpack/exceptionallyoptimized). +All optimizations in the modpack are based on [**ExceptionallyOptimized +**](https://modrinth.com/modpack/exceptionallyoptimized). -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. +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. *** @@ -45,7 +55,7 @@ This project uses **semantic versioning**. `X`.`Y`.`Z`-``+``.`` -**``:** _(For untested/breaking changes/not ready for use versions)_\ +**``:** _(For untested/breaking changes/not ready for use versions)_ **Values:** - **`alpha`** - **`beta`** @@ -54,40 +64,61 @@ This project uses **semantic versioning**. *** -### 🎲Mods Used +## 🎲Mods Used You can find all the mods included in this modpack under the `Dependencies` section, on the **Modrinth Versions** page. -### 📱Awesome Features: +## 📱Awesome Features: + +
-#### 🍀BetterGrass +

🌆AwesomeShaders

-![](https://cdn.modrinth.com/data/nQYjpo27/images/31bd83bbec4ebc32b93c5df44bef5a3120712350.png) + -####💡DynamicLights +*** + +⛏️FancyTooltips + + + +*** -![](https://cdn.modrinth.com/data/nQYjpo27/images/f7e8edcd60a9da9697b97f19c053f3c9bf9fa052.jpeg) +✨CoolEffects -#### 📐CEM + -![](https://cdn.modrinth.com/data/nQYjpo27/images/604cd4f40248d33568297057be3e2e55fc30cb5c.png) +*** + +🔎3DParticles + + + +*** + +🏃‍♂️BetterPlayerAnimations + + + +*** -#### 🔎C-Zoom +🍀OptiFineParity -![](https://cdn.modrinth.com/data/nQYjpo27/images/dc47cebce74e47a79cc83208d66cab28198e4b8e.png) +
+ -#### 🖇️ConnectedTextures +

-![](https://cdn.modrinth.com/data/nQYjpo27/images/491f56c2fa8361fd7e44f022411cd98fbb38d226.png) +
-**and much more...!** +### **and much more...!** *** -### 📈Automated Publishing +## 📈Automated Publishing -All releases are published using **Kir-Antipov**'s [**GitHub Action**](https://github.com/marketplace/actions/mc-publish). The _workflow file_ can be found here [**here**](../.github/workflows/publish_release.yml). +All releases are published using **Kir-Antipov**'s [**GitHub Action**](https://github.com/marketplace/actions/mc-publish). The _workflow file_ can be found [**here**](../.github/workflows/publish_release.yml). ### 📜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 27d9262..f3e7b9c 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -7,3 +7,10 @@ * [🔄️ Updating](post-installation/updating.md) * [💡 Adding Mods](post-installation/adding-mods.md) +* [❌ Disabling Features](post-installation/disabling-features.md) +* [🆘 Help Me](post-installation/help-me.md) + +## Contributing + +* [💬 Participating in the Community](contributing/participating.md) +* [📘 Improve the Documentation](contributing/improving-docs.md) diff --git a/docs/contributing/improving-docs.md b/docs/contributing/improving-docs.md new file mode 100644 index 0000000..98ed918 --- /dev/null +++ b/docs/contributing/improving-docs.md @@ -0,0 +1,4 @@ +# 📘 Improve the Documentation + +Help us improve the documentation! On every page of this documentation, there is an `👾Edit on GitHub` option. You can +create a **Pull Request**, there. diff --git a/docs/contributing/participating.md b/docs/contributing/participating.md new file mode 100644 index 0000000..ae14389 --- /dev/null +++ b/docs/contributing/participating.md @@ -0,0 +1,25 @@ +# 💬 Participating in the Community + +The most important thing, that you can do to help us, is to participate in the community, helping other people and make +the community grow! + +### You can: + +## Suggest New Mods + +You can suggest the addition or removal of any mod +here: [➡️Mod Request | OptimumFuse](https://github.com/UltimatChamp/optimum-fuse/issues/new?assignees=&labels=%F0%9F%93%B1mod+request&projects=&template=mod-request.yml) + +## Report an unknown bug + +If you've found an unknown bug, please report it +here: [➡️Bug Report | OptimumFuse](https://github.com/UltimatChamp/optimum-fuse/issues/new?assignees=&labels=%F0%9F%AA%B2bug&projects=&template=bug-report.yml) + +## Suggest a Feature + +You can suggest enabling an in-game feature, or a feature from an existing mod, +here: [➡️Feature Request | OptimumFuse](https://github.com/UltimatChamp/optimum-fuse/issues/new?assignees=&labels=&projects=&template=zmeta.md) + +## On Discord + +Alternatively, you can do all the stuff mentioned above, on our [Discord server](https://discord.gg/kfKjjhv3pn). diff --git a/docs/getting-started.md b/docs/getting-started.md index 7343a5a..f0d4589 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -21,7 +21,7 @@ Go through the installation process, including adding your Minecraft account! - Click on the **Browse** button. -![](.gitbook/assets/modrinth-download.png) +![](.gitbook/assets/modrinth-search.png) - Search _"OptimumFuse"_. diff --git a/docs/post-installation/adding-mods.md b/docs/post-installation/adding-mods.md index 7755977..186146d 100644 --- a/docs/post-installation/adding-mods.md +++ b/docs/post-installation/adding-mods.md @@ -36,13 +36,13 @@ Do not click on the `❌ Unpair` button. This will prevent you from updating you - Click on `Review and confirm`. - A window will appear, click `Ok`. -The same steps can repeated for adding resource-packs and shaders. +The same steps can be repeated for adding resource-packs and shaders. {% endtab %} {% tab title="ATLauncher" %} -- You can add mods by clicking on the `Add mods` button, below your **OptimumFuse** instance. +- You can add mods by clicking on the `Add Mods` button, below your **OptimumFuse** instance. - Here, you can add all your desired mods, shaders, and resource-packs! {% endtab %} diff --git a/docs/post-installation/disabling-features.md b/docs/post-installation/disabling-features.md new file mode 100644 index 0000000..864eae2 --- /dev/null +++ b/docs/post-installation/disabling-features.md @@ -0,0 +1,49 @@ +# ❌ Disabling Features + +> Don't like any feature? + +`➡️` Click on your launcher and follow the instructions below. + +{% tabs %} + +{% tab title="Modrinth App" %} + +- Click on your modpack card, at the home-screen. +- Click on `⚙️ Options`. +- Scroll all the way down and click on `🔒 Unlock`. + +{% hint style="danger" %} +Do not click on the `❌ Unpair` button. This will prevent you from updating your modpack. +{% endhint %} + +- Navigate back to the `⬜ Contents` section. +- Now, you can disable any mods, shaders, and resource-packs, by clicking on the `Toggle` button. + +{% endtab %} + +{% tab title="Prism Launcher" %} + +- Select your modpack card. +- Click on the `Edit` button, on the sidebar. +- A new window will open. Select `Mods` on the tab list. +- Find the mod you need to disable, and uncheck the checkbox. + +The same steps can be repeated for resource-packs and shaders. + +{% endtab %} + +{% tab title="ATLauncher" %} + +- Click on the `Edit Mods` button, below your **OptimumFuse** instance. +- Check any mod, shader or resource-pack you want to disable. +- Click on the `Disable Selected` button. + +{% endtab %} + +{% tab title="Other Launchers" %} + +As always, refer to your launcher's documentation. + +{% endtab %} + +{% endtabs %} diff --git a/docs/post-installation/help-me.md b/docs/post-installation/help-me.md new file mode 100644 index 0000000..42fc5b9 --- /dev/null +++ b/docs/post-installation/help-me.md @@ -0,0 +1,15 @@ +# 🆘 Help Me + +> Some unexpected happened? + +`➡️` You can ask for help, here! + +## On Discord + +You can join our [Discord server](https://discord.gg/kfKjjhv3pn) and always ask for help here. + +![](../.gitbook/assets/discord-support.png) + +## On GitHub + +You can open an issue [here](https://github.com/UltimatChamp/optimum-fuse/issues/new/choose).