options-profiles/README.md
axolotlmaid ea1e7a3005 Add options toggle menu image to README.md
Also cleaned up the README and added a section for mod support
2024-07-03 16:35:59 +01:00

48 lines
No EOL
2.2 KiB
Markdown

# Options Profiles
[![Modrinth](https://github.com/intergrav/devins-badges/blob/v3/assets/cozy/available/modrinth_64h.png?raw=true)](https://modrinth.com/mod/options-profiles)
[![Curseforge](https://github.com/intergrav/devins-badges/blob/v3/assets/cozy/available/curseforge_64h.png?raw=true)](https://curseforge.com/minecraft/mc-mods/options-profiles)
[![GitHub](https://github.com/intergrav/devins-badges/blob/v3/assets/cozy/available/git_64h.png?raw=true)](https://github.com/AxolotlMaid/options-profiles)
Options Profiles is a Minecraft mod that lets you load and save your options as profiles from in-game.
## Features
- Save and load profiles in-game
- Load specific options (like only load keybinds, resource packs or FOV and GUI scale)
- Edit profiles in-game (deleting, renaming, overwriting, pick options to only load)
- Fabric, NeoForge, Forge support
- Third party mod support (see below)
## Mod Support
Options Profiles supports these mods which means you can create and load profiles with them and the mod will load their configuration.
- Sodium
- Sodium Extra
- Embeddium
- Distant Horizons
- OptiFine
If you would like support for another mod, open an issue.
## Frequently Asked Questions
- Can you port [version]?
> Open an issue in the GitHub repository.
- Can I use this in my modpack?
> You may use this mod in modpacks with credit.
- Where are the profiles saved?
> Profiles are saved in a folder called "options-profiles" in the specified ".minecraft" directory.
- Where can I find the source code for older versions?
> You can find them in the branches.
- Dependencies?
> Versions 1.1 require Architectury API, however versions 1.2+ do not.
- For any other questions, create an issue or contact me at hello@axolotlmaid.com
## Gallery
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"/>
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"/>