Skip to content

Commit 742ef2c

Browse files
committed
rewrite(about/ad): add contributing
1 parent ac9a38e commit 742ef2c

File tree

7 files changed

+141
-120
lines changed

7 files changed

+141
-120
lines changed

about/contribute/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
hidden: true
3+
icon: heart
4+
---
5+
6+
# Contribute

about/contribute/fork.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
hidden: true
3+
icon: code-fork
4+
---
5+
6+
# Fork
7+
8+
{% hint style="info" %}
9+
Read more about [FO's license](https://github.com/Fabulously-Optimized/fabulously-optimized/blob/main/LICENSE.md).
10+
{% endhint %}
11+
12+
YOU are allowed to fork/remix Fabulously Optimized as long as YOU adhere to the license. In particular, YOU may not use the "Fabulously Optimized" or "FO" names nor logo to represent YOUR fork.
13+
14+
YOU may mention that YOU forked FO. YOU can use the following badges (created by [Devin](https://intergrav.github.io/devins-badges-docs)) for forks:
15+
16+
{% tabs %}
17+
{% tab title="Preview" %}
18+
[![Built on Fabulously Optimized](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/built-with/fabulously-optimized_64h.png)](https://download.fo/)
19+
20+
[![Built on Fabulously Optimized](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/built-with/fabulously-optimized_46h.png)](https://download.fo)
21+
{% endtab %}
22+
23+
{% tab title="Markdown" %}
24+
```md
25+
[![Built on Fabulously Optimized](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/built-with/fabulously-optimized_64h.png)](https://download.fo/)
26+
```
27+
28+
```md
29+
[![Built on Fabulously Optimized](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/built-with/fabulously-optimized_46h.png)](https://download.fo)
30+
```
31+
{% endtab %}
32+
33+
{% tab title="HTML" %}
34+
```html
35+
<!-- Resizable with `height` -->
36+
<a href="https://download.fo/">
37+
<img alt="Built on Fabulously Optimized" height="64" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/built-with/fabulously-optimized_vector.svg">
38+
</a>
39+
```
40+
41+
```html
42+
<!-- Resizable with `height` -->
43+
<a href="https://download.fo/">
44+
<img alt="Built on Fabulously Optimized" height="46" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/built-with/fabulously-optimized_vector.svg">
45+
</a>
46+
```
47+
{% endtab %}
48+
{% endtabs %}

about/contribute/translate.md

Lines changed: 20 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,12 @@ icon: language
55

66
# Translate
77

8-
In accordance to the [Accessibility principle](../README.md#accessibility), one of FO's objectives is making it accessible to everyone, regardless of their language. This is why we support and welcome translations of FO and of its mods.
9-
10-
The following parts of FO are translatable:
11-
12-
* [Mods](../../info/mods/) (not managed by FO)
13-
* [Resource Packs](../../info/resource-packs/)
14-
* [Installer](../../how-to/install/vanilla.md)
15-
* [Website](https://download.fo/)
8+
In accordance to the [Accessibility principle](../#accessibility), one of FO's objectives is making it accessible to everyone, regardless of their language. This is why we support and welcome translations of FO and of its mods.
169

1710
## Mods
1811

1912
1. Check out the [list of mods in FO](../../info/mods/). The most important mods are:
20-
* [Sodium](#sodium)
13+
* [Sodium](translate.md#sodium)
2114
* [Sodium Extra](https://crowdin.com/project/sodium-extra)
2215
* [Mod Menu](https://crowdin.com/project/mod-menu)
2316
* [Fabric API and Installer](https://crowdin.com/project/fabricmc)
@@ -39,17 +32,17 @@ The following parts of FO are translatable:
3932
10. Paste the content you copied in _step 6_
4033
11. Start translating the values inside of the quotes, on the right side of the colon. For example:
4134

42-
```json
43-
"cool-mod.config.title": "Cool Mod Options",
44-
```
35+
```json
36+
"cool-mod.config.title": "Cool Mod Options",
37+
```
4538

46-
Translate `Cool Mod Options` only!
39+
Translate `Cool Mod Options` only!
4740
12. Commit the file
48-
13. Create a pull request.
41+
13. Create a pull request
4942
14. You're now done, you just have to wait:
50-
* The author must accept your translations
51-
* The mod must be updated to include your contribution
52-
* FO must be updated to include the new version of the mod
43+
* The author must accept your translations
44+
* The mod must be updated to include your contribution
45+
* FO must be updated to include the new version of the mod
5346

5447
### Sodium
5548

@@ -67,7 +60,7 @@ FO's translations are licensed under [CC0](https://choosealicense.com/licenses/c
6760

6861
{% tabs %}
6962
{% tab title="Translator" %}
70-
1. Join the [FO project on Crowdin](https://crowdin.com/project/fabulously-optimized) <!-- TODO: https://download.fo/crowdin ? -->
63+
1. Join the [FO project on Crowdin](https://download.fo/crowdin)
7164
2. Translate the files you prefer. Files are sorted according to the priority
7265
3. Vote for existing suggestions with the **Plus** and **Minus** buttons
7366
4. Discuss or ask for information in the comments
@@ -83,14 +76,14 @@ FO's translations are licensed under [CC0](https://choosealicense.com/licenses/c
8376
The resource pack must be tested because there are specific length requirements:
8477

8578
* Translations must be fully visible in a maximized Full HD 1920×1080 window, with the default font, or with the Unicode font if required. You can emulate such a window in-game:
86-
1. Open **Options...**
87-
2. Open **Video Settings...***
88-
3. Set **Fullscreen Resolution** to **1920x1080@60 (24 bit)** (The number after `@` may vary)
89-
4. Check the **Fullscreen** checkbox
90-
5. Click on **Apply**
91-
6. If you're experiencing issues, press **`Shift`** + **`P`** to reset to default settings
92-
7. Click on **Done**
93-
* The [online translations tester](https://fabulously-optimized.github.io/Mod-Menu-Helper-Size-Checker) <!-- TODO: https://download.fo/size-checker ? --> may help, but does not replace in-game testing
79+
1. Open **Options...**
80+
2. Open **Video Settings...**
81+
3. Set **Fullscreen Resolution** to **1920x1080@60 (24 bit)** (The number after `@` may vary)
82+
4. Check the **Fullscreen** checkbox
83+
5. Click on **Apply**
84+
6. If you're experiencing issues, press **`Shift`** + **`P`** to reset to default settings
85+
7. Click on **Done**
86+
* The [online translations tester](https://download.fo/size-checker) may help, but does not replace in-game testing
9487
* Feel free to rephrase sentences if you see fit
9588
* In the options row, list as many of them as you can fit
9689
* Do NOT change the strings' format! Keep paragraph signs `§`, the tools `⚒️` and arrows `🔀` emoji, and newlines `\n` intact
@@ -132,7 +125,7 @@ Do NOT change the strings' format! If the original says `[Hello World!][1]`, you
132125
Translation testing is recommended for proofreaders:
133126

134127
1. Approve all translations on Crowdin. You may have to wait for some time
135-
2. Find the latest ["New Crowdin updates" pull request on GitHub](https://github.com/Fabulously-Optimized/fabulously-web/pulls?q=is:pr+is:open+New+Crowdin+updates)
128+
2. Find the latest ["New Crowdin updates" pull request on GitHub](https://github.com/Fabulously-Optimized/website/pulls?q=is:pr+is:open+New+Crowdin+updates)
136129
3. Find a comment by the user `vercel`
137130
4. Click on **Visit Preview** in that comment
138131
5. Navigate the website and make sure translations are correct

about/fabric.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,6 @@ FO uses Fabric, instead of NeoForge, for the following reasons:
2020
* **Fast loading**: roughly the same as vanilla Minecraft
2121
* **Small size**: no huge libraries, just the [Fabric Loader](https://fabricmc.net/use) and the [Fabric API](https://curseforge.com/minecraft/mc-mods/fabric-api)
2222

23-
{% hint style="info" %}
23+
{% hint style="success" %}
2424
If you're coming from NeoForge, you can find a community-maintained [list of Fabric mods corresponding to NeoForge mods](https://gist.github.com/TrueCP6/4853f15015b210fd3b1e210e9e485f83).
2525
{% endhint %}

about/optifine.md

Lines changed: 22 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -22,27 +22,23 @@ The [mods included in FO](../info/mods/) are inspired by but not limited to the
2222

2323
## Video Options
2424

25-
{% hint style="info" %}
26-
Click on each status to get more information.
27-
{% endhint %}
28-
29-
| Option | Status | Provider | Notes |
30-
| --------------------- | :-----: | ------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
31-
| Animation toggles | ✔️[^1] | [Sodium Extra](https://curseforge.com/minecraft/mc-mods/sodium-extra) | |
32-
| Anti-Aliasing | ✔️[^2] | [Iris](https://curseforge.com/minecraft/mc-mods/irisshaders) | [Tutorial](../info/mods/shaders.md) |
33-
| Custom capes | ✔️[^3] | [Capes](https://curseforge.com/minecraft/mc-mods/capes) | [Tutorial](../info/mods/capes.md) |
34-
| Detail toggles | ✔️[^4] | [Sodium Extra](https://curseforge.com/minecraft/mc-mods/sodium-extra) | |
35-
| Dynamic Lights | ✔️[^5] | [LambDynamicLights](https://curseforge.com/minecraft/mc-mods/lambdynamiclights) | |
36-
| HD Screenshots | ✔️[^6] | [Fabrishot](https://curseforge.com/minecraft/mc-mods/fabrishot) | |
37-
| Miscellaneous toggles | ✔️[^7] | [Sodium Extra](https://curseforge.com/minecraft/mc-mods/sodium-extra) | |
38-
| Particle toggles | ✔️[^8] | [Sodium Extra](https://curseforge.com/minecraft/mc-mods/sodium-extra) | |
39-
| Performance | ✔️[^9] | [_multiple mods_](../info/mods/#smooth) | |
40-
| Shaders | ✔️[^10] | [Iris](https://curseforge.com/minecraft/mc-mods/irisshaders) | [Tutorial](../info/mods/shaders.md) |
41-
| Smart Leaves | ✔️[^11] | [MoreCulling](https://curseforge.com/minecraft/mc-mods/moreculling) | ...[^12] |
42-
| Zoom | ✔️[^13] | [Zoomify](https://curseforge.com/minecraft/mc-mods/zoomify) | ...[^14] |
43-
| Better Grass | 🚧[^15] | [Fast Better Grass](../info/resource-packs/#fast-better-grass) | [Issue #717](https://github.com/Fabulously-Optimized/fabulously-optimized/issues/717) |
44-
| 32+ Render Distance |[^16] | [Farsight](https://curseforge.com/minecraft/mc-mods/farsight-fabric) | [Issue #656](https://github.com/Fabulously-Optimized/fabulously-optimized/issues/656) |
45-
| Anisotropic Filtering |[^17] | _Not possible_ | [Discussion](https://discord.com/channels/756612889787498627/876567546390777856/978673913770950687) on [Discord](https://discord.gg/7rnTYXu) |
25+
| Option | Provider | Notes |
26+
| --------------------- | ------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
27+
| Animation toggles | [Sodium Extra](https://curseforge.com/minecraft/mc-mods/sodium-extra) | |
28+
| Anti-Aliasing | [Iris](https://curseforge.com/minecraft/mc-mods/irisshaders) | [Tutorial](../info/mods/shaders.md) |
29+
| Custom capes | [Capes](https://curseforge.com/minecraft/mc-mods/capes) | [Tutorial](../info/mods/capes.md) |
30+
| Detail toggles | [Sodium Extra](https://curseforge.com/minecraft/mc-mods/sodium-extra) | |
31+
| Dynamic Lights | [LambDynamicLights](https://curseforge.com/minecraft/mc-mods/lambdynamiclights) | |
32+
| HD Screenshots | [Fabrishot](https://curseforge.com/minecraft/mc-mods/fabrishot) | |
33+
| Miscellaneous toggles | [Sodium Extra](https://curseforge.com/minecraft/mc-mods/sodium-extra) | |
34+
| Particle toggles | [Sodium Extra](https://curseforge.com/minecraft/mc-mods/sodium-extra) | |
35+
| Performance | [_multiple mods_](../info/mods/#smooth) | |
36+
| Shaders | [Iris](https://curseforge.com/minecraft/mc-mods/irisshaders) | [Tutorial](../info/mods/shaders.md) |
37+
| Smart Leaves | [MoreCulling](https://curseforge.com/minecraft/mc-mods/moreculling) | ...[^1] |
38+
| Zoom | [Zoomify](https://curseforge.com/minecraft/mc-mods/zoomify) | ...[^2] |
39+
| Better Grass | 🚧[^3] [Fast Better Grass](../info/resource-packs/#fast-better-grass) | [Issue #717](https://github.com/Fabulously-Optimized/fabulously-optimized/issues/717) |
40+
| 32+ Render Distance |[^4] [Farsight](https://curseforge.com/minecraft/mc-mods/farsight-fabric) | [Issue #656](https://github.com/Fabulously-Optimized/fabulously-optimized/issues/656) |
41+
| Anisotropic Filtering |[^5] _Not possible_ | [Discussion](https://discord.com/channels/756612889787498627/876567546390777856/978673913770950687) on [Discord](https://discord.gg/7rnTYXu) |
4642

4743
## Advanced Resource Pack Features
4844

@@ -67,29 +63,7 @@ If you're having issues with a resource pack that uses these features, see the [
6763
| Custom Entity Models | [Entity Model Features](https://curseforge.com/minecraft/mc-mods/entity-model-features) |
6864
| Custom Colors | [Polytone](https://curseforge.com/minecraft/mc-mods/polytone) |
6965

70-
[^1]: Supported
71-
72-
[^2]: Supported
73-
74-
[^3]: Supported
75-
76-
[^4]: Supported
77-
78-
[^5]: Supported
79-
80-
[^6]: Supported
81-
82-
[^7]: Supported
83-
84-
[^8]: Supported
85-
86-
[^9]: Supported
87-
88-
[^10]: Supported
89-
90-
[^11]: Supported
91-
92-
[^12]: Not identical to OptiFine, as people did not prefer the look. If you want it to be identical:
66+
[^1]: Not identical to OptiFine, as people did not prefer the look. If you want it to be identical:
9367

9468
1. [Disable](../how-to/disable-mods/) MoreCulling
9569
2. [Add](../how-to/add-mods/) the [Cull Leaves](https://curseforge.com/minecraft/mc-mods/cull-leaves) mod
@@ -99,18 +73,16 @@ If you're having issues with a resource pack that uses these features, see the [
9973
6. Open **Performance**
10074
7. Disable **Use Block Face Culling**
10175

102-
[^13]: Supported
103-
104-
[^14]: Not identical to OptiFine, as people preferred a smoother zoom. If you want it to be identical:
76+
[^2]: Not identical to OptiFine, as people preferred a smoother zoom. If you want it to be identical:
10577

10678
1. Click on the **Mods** button
10779
2. Find and click on **Zoomify**
10880
3. Click on the **Configure** icon in the top-left
10981
4. Click on the **Misc** tab
11082
5. Select the **OptiFine** preset
11183

112-
[^15]: Partially supported
84+
[^3]: Partially supported
11385

114-
[^16]: Not supported anymore
86+
[^4]: No longer supported
11587

116-
[^17]: Not supported yet
88+
[^5]: Not supported

0 commit comments

Comments
 (0)