diff --git a/README.md b/README.md index bbac4d8b8..efa7fffaf 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,15 @@ # Development Branches -- [1.19.3 (v2.0)](https://github.com/Adrenix/Nostalgic-Tweaks/tree/1.19.3) -- [1.19.2 Multiplayer (v2.0)](https://github.com/Adrenix/Nostalgic-Tweaks/tree/1.19.2-multiplayer) -- [1.19 Multiplayer (v2.0)](https://github.com/Adrenix/Nostalgic-Tweaks/tree/1.19-multiplayer) -- [1.19 (v1.0)](https://github.com/Adrenix/Nostalgic-Tweaks/tree/1.19) -- [1.18.2 Multiplayer (v2.0)](https://github.com/Adrenix/Nostalgic-Tweaks/tree/1.18.2-multiplayer) -- [1.18.2 (v1.0)](https://github.com/Adrenix/Nostalgic-Tweaks/tree/1.18.2) -- [1.18 - 1.18.1 (v1.0)](https://github.com/Adrenix/Nostalgic-Tweaks/tree/1.18.1) +- [1.19.4 (v2.0)](https://github.com/Adrenix/Nostalgic-Tweaks/tree/1.19.4) **Current** +- ~~[1.19.3 (v2.0)](https://github.com/Adrenix/Nostalgic-Tweaks/tree/1.19.3)~~ **Discontinued** +- [1.19.2 Multiplayer (v2.0)](https://github.com/Adrenix/Nostalgic-Tweaks/tree/1.19.2-multiplayer) **LTS** +- [1.19 Multiplayer (v2.0)](https://github.com/Adrenix/Nostalgic-Tweaks/tree/1.19-multiplayer) **TBD** +- ~~[1.19 (v1.0)](https://github.com/Adrenix/Nostalgic-Tweaks/tree/1.19)~~ **Discontinued** +- [1.18.2 Multiplayer (v2.0)](https://github.com/Adrenix/Nostalgic-Tweaks/tree/1.18.2-multiplayer) **LTS** +- ~~[1.18.2 (v1.0)](https://github.com/Adrenix/Nostalgic-Tweaks/tree/1.18.2)~~ **Discontinued** +- ~~[1.18 - 1.18.1 (v1.0)](https://github.com/Adrenix/Nostalgic-Tweaks/tree/1.18.1)~~ **Discontinued** #### Changelogs -To see the changes made across all versions, please see the [changelog](https://github.com/Adrenix/Nostalgic-Tweaks/blob/main/changelog.md) file. +See the changelog in a branch for recent changes. # Nostalgic Tweaks Mod (Forge & Fabric) [ @@ -30,16 +31,18 @@ Inspired by Exalm's **Old Days** mod, **Nostalgic Tweaks** brings back a plethor Some major nostalgic tweaks included in this mod are **old classic/alpha/beta light rendering**, **old classic/alpha/beta fog rendering**, **old classic/alpha/beta sky and void colors**, **2D floating items with disabled diffused lighting**, **old mob spawning**, **old combat mechanics & aesthetics** (_e.g., disabled particles, sounds, and mob animations_), and **so much more**! There are currently over **300+** nostalgic tweaks available in the latest beta version of 2.0.0 with more on the way! -For the best nostalgic experience, I recommend using the **[Golden Days](https://github.com/PoeticRainbow/golden-days/releases)** resource pack by **PoeticRainbow**. It comes with an abundance of nostalgic packs, such as an alpha and picture perfect pack which coincides wonderfully with **Nostalgic Tweaks**. +For the best nostalgic experience, I recommend using the **[Golden Days](https://github.com/PoeticRainbow/golden-days/releases)** resource pack by **PoeticRainbow**. It comes with an abundance of nostalgic packs, such as an alpha and picture perfect pack which coincides wonderfully with **Nostalgic Tweaks**. Additionally, use the **[Modern Beta](https://www.curseforge.com/minecraft/mc-mods/modern-beta)** mod by **b3spectacled** for nostalgic terrain generation. ## Configuration -To open the mod's configuration menu, press O for "Old" while in-game or at the game's title screen. Alternatively, if you have [mod menu](https://modrinth.com/mod/modmenu) installed for Fabric, then you can also access the configuration screen through the Mods button. You can change the page that opens when pressing this hotkey by clicking the Settings button on the mod's settings homepage. The first category that appears when this button is clicked is the General category. Under the Menu Settings subcategory, you can pick which menu that opens by default. The config hotkey can be also changed in the vanilla controls menu or the mod's General config menu. +To open the mod's configuration menu, press **O** for "**Old**" while in-game or at the main title screen. This hotkey can be changed in the vanilla controls menu or in the mod's configuration menu. You can change the page that opens when pressing this hotkey by clicking the **Settings** button on the mod's settings homepage. The first category that appears when this button is clicked is the **General** category. Under the **Menu Settings** subcategory, you can pick which menu that opens by default. If you have **[Mod Menu](https://modrinth.com/mod/modmenu)** installed for Fabric, then you can also access the configuration screen through the **Mods** button. -Each tweak will have tags next their name in the configuration menu. Each tag identifies different aspects of each tweak. The most important tags are the Client, Server, and Reload/Restart tags. You can hover your mouse over each tag to see more information as a tooltip. You can also disable some tweak tags from appearing in the General category under the Menu Settings subcategory. +Each tweak will have **tags** next their name in the configuration menu. Each tag identifies different aspects of each tweak. The most important tags are the **Client**, **Server**, and **Reload/Restart** tags. You can hover your mouse over each tag to see more information as a tooltip. You can also disable some tweak tags from appearing in the **General** category under the **Menu Settings** subcategory. -Currently, the configuration menu comes with a fairly simple search feature. Right now it only matches typed input by a tweak's locale name. You can broaden your search by using Search Tags. To see all the search tags available to you, access the General category and open the Search Tags subcategory to read more. +The configuration menu comes with a special **Search** system. Text that is typed into the input bar will bring up fuzzy results by default. This means the mod will attempt to show results that it believes you were trying to search for. Some results will appear due to category names or related term searches. You can narrow search results by using **Search Tags**. To see all the search tags that are available, access the **General** category and open the **Search Tags** subcategory to read more. -Lastly, the configuration menu does come with a few keyboard shortcuts. Ctrl + F opens the search box, Ctrl + S saves and exits the config menu, Esc exits the config menu, and Ctrl + L, Alt + L, Ctrl + R, or Alt + R will change the the config group you are in without the need to click on a category button. +The configuration menu also comes with keyboard shortcuts. **Ctrl + F** opens the search box, **Ctrl + S** saves and exits the config menu, **Esc** exits the config menu, and **Ctrl + L**, **Alt + L**, **Ctrl + R**, or **Alt + R** will change the the config group you are in without the need to click on a category button. You can also use the **Tab** key to cycle through elements and press the **Spacebar** key or **Enter** key to perform an action on the highlighted element. + +The **Presets** button on the mod's settings homepage allows the user to define config presets similar to how resource packs are managed. _This feature is still in development and not yet available to use_. ## FAQ ### Does this mod have a dedicated discord server?