docs: update README and gallery

This commit is contained in:
trafficlunar 2025-10-16 17:42:27 +01:00
parent 5df3f81fc6
commit 0c767a4ba1
5 changed files with 20 additions and 15 deletions

View file

@ -7,42 +7,47 @@
Options Profiles is a Minecraft mod that lets you load and save your options as profiles from in-game. Options Profiles is a Minecraft mod that lets you load and save your options as profiles from in-game.
## Features ## Features
- Save and load profiles in-game - Save and load profiles in-game
- Load specific options (like only load keybinds, resource packs or FOV and GUI scale) - Load specific options (e.g. only load keybinds, resource packs, FOV, etc.)
- Edit profiles in-game (deleting, renaming, overwriting, pick options to only load) - Load profiles when joining a certain server
- Fabric, NeoForge, Forge support - Edit profiles in-game (deleting, renaming, overwriting, pick options to only load)
- Fabric, NeoForge support
- Third party mod support (see below) - Third party mod support (see below)
## Mod Support ## Mod Support
Options Profiles supports these mods which means you can create and load profiles with them and the mod will load their configuration. Options Profiles supports these mods which means you can create and load profiles with them and the mod will load their configuration.
- Sodium - Sodium
- Sodium Extra - Sodium Extra
- Iris - Iris
- Distant Horizons - Distant Horizons
- OptiFine
If you would like support for another mod, open an issue. If you would like support for another mod, open an issue.
## Frequently Asked Questions ## Frequently Asked Questions
- How to open profiles menu without going to options?
> You can open the profiles menu by using the command `/optionsprofiles` or by accessing it from Mod Menu
- Can you port [version]? - Can you port [version]?
> Open an issue in the GitHub repository. > Open an issue in the GitHub repository.
- Can I use this in my modpack? - Can I use this in my modpack?
> You may use this mod in modpacks with credit. > You may use this mod in modpacks with credit.
- Where are the profiles saved? - Where are the profiles saved?
> Profiles are saved in a folder called "options-profiles" in the specified ".minecraft" directory. > Profiles are saved in a folder called "options-profiles" in the specified ".minecraft" directory.
- Where can I find the source code for older versions? - Where can I find the source code for older versions?
> You can find them in the branches. > You can find them in the branches.
- Dependencies? - Dependencies?
> Architectury API and Fabric API (if on Fabric) > Architectury API and Fabric API (if on Fabric)
- For any other questions, create an issue or contact me at hello@trafficlunar.net - For any other questions, create an issue or contact me at hello@trafficlunar.net
## Gallery ## Gallery
Profiles Menu | Edit Profile Screen | Profiles Menu | Edit Profile Screen |
:-------------------------:|:-------------------------: | :--------------------------------------------------------: | :--------------------------------------------------------------------: |
<img src="gallery/profiles-menu.png" alt="profiles list"/> | <img src="gallery/edit-profile-screen.png" alt="edit profile screen"/> | <img src="gallery/profiles-menu.png" alt="profiles list"/> | <img src="gallery/edit-profile-screen.png" alt="edit profile screen"/> |
Options Toggle Menu | Options Screen | Options Toggle Menu | Options Screen |
:-------------------------:|:-------------------------: | :--------------------------------------------------------------------: | :----------------------------------------------------------: |
<img src="gallery/options-toggle-menu.png" alt="options toggle menu"/> | <img src="gallery/options-screen.png" alt="options screen"/> | <img src="gallery/options-toggle-menu.png" alt="options toggle menu"/> | <img src="gallery/options-screen.png" alt="options screen"/> |

Binary file not shown.

Before

Width:  |  Height:  |  Size: 729 KiB

After

Width:  |  Height:  |  Size: 835 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 570 KiB

After

Width:  |  Height:  |  Size: 733 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 578 KiB

After

Width:  |  Height:  |  Size: 748 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 554 KiB

After

Width:  |  Height:  |  Size: 710 KiB