Skip to content

Commit

Permalink
docs: add contributing and some more stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
UltimatChamp committed Nov 28, 2024
1 parent fd26124 commit 05c7a93
Show file tree
Hide file tree
Showing 9 changed files with 155 additions and 24 deletions.
Binary file added docs/.gitbook/assets/discord-support.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
73 changes: 52 additions & 21 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,28 @@
# 🌎 OptimumFuse

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

***

[![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)

</center>

***

### 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.

***

Expand Down Expand Up @@ -45,7 +55,7 @@ This project uses **semantic versioning**.

`X`.`Y`.`Z`-`<pre-release>`+`<loader>`.`<mc-version>`

**`<pre-release>`:** _(For untested/breaking changes/not ready for use versions)_\
**`<pre-release>`:** _(For untested/breaking changes/not ready for use versions)_
**Values:**
- **`alpha`**
- **`beta`**
Expand All @@ -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:

<center>

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

![](https://cdn.modrinth.com/data/nQYjpo27/images/31bd83bbec4ebc32b93c5df44bef5a3120712350.png)
<img src="https://cdn.modrinth.com/data/nQYjpo27/images/56bf6d61e12491db23ba0d92a46a714737eda279.png" width="625">

####💡DynamicLights
***

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

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

***

![](https://cdn.modrinth.com/data/nQYjpo27/images/f7e8edcd60a9da9697b97f19c053f3c9bf9fa052.jpeg)
✨Cool<font color="lime">Effects</font>

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

![](https://cdn.modrinth.com/data/nQYjpo27/images/604cd4f40248d33568297057be3e2e55fc30cb5c.png)
***

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

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

***

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

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

***

#### 🔎C-Zoom
🍀OptiFine<font color="green">Parity</font>

![](https://cdn.modrinth.com/data/nQYjpo27/images/dc47cebce74e47a79cc83208d66cab28198e4b8e.png)
<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">

#### 🖇️ConnectedTextures
</h3>

![](https://cdn.modrinth.com/data/nQYjpo27/images/491f56c2fa8361fd7e44f022411cd98fbb38d226.png)
</center>

**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)!
7 changes: 7 additions & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
4 changes: 4 additions & 0 deletions docs/contributing/improving-docs.md
Original file line number Diff line number Diff line change
@@ -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.
25 changes: 25 additions & 0 deletions docs/contributing/participating.md
Original file line number Diff line number Diff line change
@@ -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).
2 changes: 1 addition & 1 deletion docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"_.

Expand Down
4 changes: 2 additions & 2 deletions docs/post-installation/adding-mods.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}
Expand Down
49 changes: 49 additions & 0 deletions docs/post-installation/disabling-features.md
Original file line number Diff line number Diff line change
@@ -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 %}
15 changes: 15 additions & 0 deletions docs/post-installation/help-me.md
Original file line number Diff line number Diff line change
@@ -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).

0 comments on commit 05c7a93

Please sign in to comment.