-
Notifications
You must be signed in to change notification settings - Fork 20
Wiki Rewrite: "Compare FO" #130
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
its-miroma
wants to merge
10
commits into
Fabulously-Optimized:main
Choose a base branch
from
its-miroma:rewrite/about/ad
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
08778e4
rewrite(about/ad): initial commit
its-miroma 5352c50
rewrite(about/ad): add servers.md
its-miroma 5ee5be8
rewrite(about/ad): add contributing
its-miroma 939790a
rewrite(about/fo): fix urls
its-miroma ddbc282
rewrite(about/optifine.md): format table
its-miroma 93fa466
rewrite(about/servers.md): fix punctuation in list
its-miroma 437ef7e
rewrite(about/unsupported.md): copy from upstream
its-miroma 8ac6467
rewrite(about/ad): update mod list
its-miroma 45c4c4a
rewrite(about/servers.md): add "Share Your World"
its-miroma 69746f6
rewrite(about/ad): use `kbd` for every UI button
its-miroma File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
hidden: true | ||
icon: heart | ||
--- | ||
|
||
# Contribute |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
--- | ||
hidden: true | ||
icon: code-fork | ||
--- | ||
|
||
# Fork | ||
|
||
{% hint style="info" %} | ||
Read more about [FO's license](https://github.com/Fabulously-Optimized/fabulously-optimized/blob/main/LICENSE.md). | ||
{% endhint %} | ||
|
||
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. | ||
|
||
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: | ||
|
||
{% tabs %} | ||
{% tab title="Preview" %} | ||
[](https://download.fo/) | ||
|
||
[](https://download.fo) | ||
{% endtab %} | ||
|
||
{% tab title="Markdown" %} | ||
```md | ||
[](https://download.fo/) | ||
``` | ||
|
||
```md | ||
[](https://download.fo) | ||
``` | ||
{% endtab %} | ||
|
||
{% tab title="HTML" %} | ||
```html | ||
<!-- Resizable with `height` --> | ||
<a href="https://download.fo/"> | ||
<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"> | ||
</a> | ||
``` | ||
|
||
```html | ||
<!-- Resizable with `height` --> | ||
<a href="https://download.fo/"> | ||
<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"> | ||
</a> | ||
``` | ||
{% endtab %} | ||
{% endtabs %} | ||
|
||
The same terms also apply for [FO's resource packs](../../info/resource-packs/): YOU may not use the names nor logos FO uses to represent YOUR remixes. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,129 @@ | ||
--- | ||
hidden: true | ||
icon: language | ||
--- | ||
|
||
# Translate | ||
|
||
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. | ||
|
||
## Mods | ||
|
||
1. Check out the [list of mods in FO](../../info/mods/). The most important mods are: | ||
* [Sodium](translate.md#sodium) | ||
* [Sodium Extra](https://crowdin.com/project/sodium-extra) | ||
* [Mod Menu](https://crowdin.com/project/mod-menu) | ||
* [Fabric API and Installer](https://crowdin.com/project/fabricmc) | ||
* [Iris](https://github.com/IrisShaders/Iris/blob/multiloader-new/common/src/main/resources/assets/iris/lang/en_us.json) | ||
* [MoreCulling](https://github.com/fxmorin/MoreCulling/blob/master/common/src/main/resources/assets/moreculling/lang/en_us.json) | ||
* [Controlify](https://github.com/isXander/Controlify/blob/1.20.x/dev/src/main/resources/assets/controlify/lang/en_us.json) | ||
* [Zoomify](https://github.com/isXander/Zoomify/blob/multiversion/dev/src/main/resources/assets/zoomify/lang/en_us.json) | ||
* [Fabric Capes](https://github.com/CaelTheColher/Capes/blob/architectury/common/src/main/resources/assets/capes/lang/en_us.json) | ||
* [Continuity](https://github.com/PepperCode1/Continuity/blob/1.19.3/dev/src/main/resources/assets/continuity/lang/en_us.json) | ||
* [CIT Resewn](https://github.com/SHsuperCM/CITResewn/blob/main/src/main/resources/assets/citresewn/lang/en_us.json) | ||
2. For each mod you want to translate, open its page | ||
3. Find the link to Source code | ||
4. Read the mod's documentation to understand if translations happen on a translation platform | ||
5. If not, find the path where language files are memorized, generally under the <kbd>**Code**</kbd> tab, in `src/main/resources/assets/mod-name/lang/en_us.json` (sometimes under a `common/` folder) | ||
6. Copy that file's content | ||
7. In the `lang` folder, click on the <kbd>**Add file**</kbd> button | ||
8. Click on the <kbd>**Create new file**</kbd> button. This should fork the repo | ||
9. Name the file following the [language codes format](https://minecraft.wiki/w/Language#Languages). For example `en_ud.json` | ||
10. Paste the content you copied in _step 6_ | ||
11. Start translating the values inside of the quotes, on the right side of the colon. For example: | ||
|
||
```json | ||
"cool-mod.config.title": "Cool Mod Options", | ||
``` | ||
|
||
Translate `Cool Mod Options` only! | ||
12. Commit the file | ||
13. Create a pull request | ||
14. You're now done, you just have to wait: | ||
* The author must accept your translations | ||
* The mod must be updated to include your contribution | ||
* FO must be updated to include the new version of the mod | ||
|
||
### Sodium | ||
|
||
Sodium does not support translations natively, but the creators of Sodium Extra and FO have created an independent resource pack to add translations to Sodium. FO includes the [Translations for Sodium resource pack](../../info/resource-packs/#translations-for-sodium). | ||
|
||
To translate Sodium, open its [unofficial page on Crowdin](https://crowdin.com/project/sodium-fabric). Translations are published every Saturday, and FO versions right after will include them. | ||
|
||
Read more about [localization in Sodium natively](https://github.com/CaffeineMC/sodium-fabric/issues/2304). | ||
|
||
## Resource Packs | ||
|
||
{% tabs %} | ||
{% tab title="Translator" %} | ||
1. Join the [FO project on Crowdin](https://download.fo/crowdin) | ||
2. Translate the files you prefer. Files are sorted according to the priority | ||
3. Vote for existing suggestions with the <kbd>**Plus**</kbd> and <kbd>**Minus**</kbd> buttons | ||
4. Discuss or ask for information in the comments | ||
5. Join the [FO Discord server](https://download.fo/discord) to get a yellow rank for translating a file to 100%. The rank gives access to some secret channels ;) | ||
6. You'll get an email and a Discord notification when there are new phrases to translate | ||
{% endtab %} | ||
|
||
{% tab title="Proofreader" %} | ||
1. To become a proofreader, you must ask on the Discord server after getting the yellow rank | ||
2. Check and approve all strings. Files must be 100% approved to be accepted | ||
3. Test the [Mod Menu Helper resource pack](../../info/resource-packs/#mod-menu-helper) and [Chat Reporting Helper](../../info/resource-packs/#chat-reporting-helper)'s description in-game | ||
|
||
The resource pack must be tested because there are specific length requirements: | ||
|
||
* 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: | ||
1. Open <kbd>**Options...**</kbd> | ||
2. Open <kbd>**Video Settings...**</kbd> | ||
3. Set <kbd>**Fullscreen Resolution**</kbd> to <kbd>`1920x1080@60 (24 bit)`</kbd> (The number after `@` may vary) | ||
4. Check the <kbd>**Fullscreen**</kbd> checkbox | ||
5. Click on <kbd>**Apply**</kbd> | ||
6. If you're experiencing issues, press <kbd>⇧ Shift</kbd> + <kbd>P</kbd> to reset to default settings | ||
7. Click on <kbd>**Done**</kbd> | ||
* The [online translations tester](https://download.fo/size-checker) may help, but does not replace in-game testing | ||
* Feel free to rephrase sentences if you see fit | ||
* In the options row, list as many of them as you can fit | ||
* Do NOT change the strings' format! Keep paragraph signs `§`, the tools `⚒️` and arrows `🔀` emoji, and newlines `\n` intact | ||
|
||
To test the translation in-game: | ||
|
||
1. In Crowdin, open the **Mod Menu Helper** file (not _All strings_!) | ||
2. Click on the <kbd>**menu**</kbd> button in the top-left corner | ||
3. Click on the <kbd>**Download**</kbd> button. You'll get a `xx_xx.json` file | ||
4. In Minecraft, open <kbd>**Options...**</kbd> | ||
5. Open <kbd>**Resource Packs...**</kbd> | ||
6. Click on <kbd>**Open Pack Folder**</kbd> | ||
7. Open the `Mod Menu Helper.zip` file. If the `zip` file gets extracted, open the extracted folder | ||
8. Navigate to `assets/fo/lang` | ||
9. Drag the file you downloaded in _step 3_ and drop it into the folder you opened in _step 9_ | ||
10. In Minecraft, if the `zip` file got extracted in _step 8_, activate it | ||
11. Click on <kbd>**Done**</kbd> | ||
12. Click on <kbd>**Done**</kbd> | ||
13. Open a world or a server, and press <kbd>F3</kbd> + <kbd>T</kbd> (sometimes <kbd>Fn</kbd> + <kbd>F3</kbd> + <kbd>T</kbd>) to reload the resource pack | ||
14. In the main menu, click on the <kbd>**Mods**</kbd> button to open the Mod Menu | ||
15. Make sure the translations fit the criteria above | ||
16. Click on <kbd>**Back**</kbd> | ||
17. Click on <kbd>**Options...**</kbd> | ||
18. Click on <kbd>**Resource Packs...**</kbd> | ||
19. Make sure the translations fit the criteria above | ||
{% endtab %} | ||
{% endtabs %} | ||
|
||
## Website | ||
|
||
The website is almost entirely translatable, except the wiki, which would get outdated very quickly. | ||
|
||
Do NOT change the strings' format! If the original says `[Hello World!][1]`, you should only translate `Hello World!` | ||
|
||
Translation testing is recommended for proofreaders: | ||
|
||
1. Approve all translations on Crowdin. You may have to wait for some time | ||
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) | ||
3. Find a comment by the user `vercel` | ||
4. Click on the <kbd>**Visit Preview**</kbd> link in that comment | ||
5. Navigate the website and make sure translations are correct | ||
|
||
## Installer | ||
|
||
Most messages on the installer, except for some very detailed errors, are translatable. | ||
|
||
However, translation testing is not very easy, so it's not required. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
hidden: true | ||
icon: scroll-old | ||
--- | ||
|
||
# Fabric | ||
|
||
FO uses Fabric, instead of NeoForge, for the following reasons: | ||
|
||
* **Popular**: there are [at least 10000 Fabric mods on CurseForge](https://www.curseforge.com/minecraft/search?gameVersionTypeId=4) and [over 20000 Fabric mods on Modrinth](https://modrinth.com/mods?g=categories:fabric) | ||
<!-- | ||
Modrinth: `total_hits` from https://api.modrinth.com/v2/search?facets=[[%22categories=fabric%22]] | ||
CurseForge: `10000+ Projects found` in https://www.curseforge.com/minecraft/search?gameVersionTypeId=4 | ||
TODO: find reliable API result for CurseForge | ||
--> | ||
* **Supported**: most authors of NeoForge mods nowadays support Fabric as well, if not exclusively | ||
* **Compatible**: Fabric mod developers work together to keep their mods compatible with each other | ||
* **Easy installation**: there's a [Fabric installer](https://fabricmc.net/use/installer), which supports many launchers | ||
* **Fast updates**: on the same day as Minecraft, and so do many mods | ||
* **Fast loading**: roughly the same as vanilla Minecraft | ||
* **Small size**: no huge libraries, just the [Fabric Loader](https://fabricmc.net/use) and the [Fabric API](https://www.curseforge.com/minecraft/mc-mods/fabric-api) | ||
|
||
{% hint style="success" %} | ||
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). | ||
{% endhint %} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
GitHub's syntax highlighting does not seem to be a fan...