Add options toggle menu image to README.md
Also cleaned up the README and added a section for mod support
56
README.md
|
|
@ -4,27 +4,45 @@
|
||||||
[](https://curseforge.com/minecraft/mc-mods/options-profiles)
|
[](https://curseforge.com/minecraft/mc-mods/options-profiles)
|
||||||
[](https://github.com/AxolotlMaid/options-profiles)
|
[](https://github.com/AxolotlMaid/options-profiles)
|
||||||
|
|
||||||
Options Profiles 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.
|
||||||
|
|
||||||
## Frequently Asked Questions
|
|
||||||
- If you would like a version ported, open an issue.
|
|
||||||
- Versions 1.1 require Architectury API, however versions 1.2+ does not.
|
|
||||||
- You may use this mod in modpacks / clients with credit.
|
|
||||||
- You can find other versions in the branches.<br/>
|
|
||||||
|
|
||||||
Contact: hello@axolotlmaid.com
|
|
||||||
|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
- Profiles are saved in a folder called "options-profiles" in the specified ".minecraft" directory.
|
- Save and load profiles in-game
|
||||||
- Sodium and Optifine support
|
- Load specific options (like only load keybinds, resource packs or FOV and GUI scale)
|
||||||
- Forge and Fabric support
|
- Edit profiles in-game (deleting, renaming, overwriting, pick options to only load)
|
||||||
- Resource packs support
|
- Fabric, NeoForge, Forge support
|
||||||
- Save current options
|
- Third party mod support (see below)
|
||||||
- Edit profiles in-game (deleting, renaming, overwriting)
|
|
||||||
|
## 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
|
## Gallery
|
||||||
|
|
||||||
Profiles Menu | Edit Profile Screen | Options Screen
|
Profiles Menu | Edit Profile Screen
|
||||||
:-------------------------:|:-------------------------:|:-------------------------:
|
:-------------------------:|:-------------------------:
|
||||||
<img src="gallery/profiles-menu.png" alt="profiles list" width="500"/> | <img src="gallery/edit-profile-screen.png" alt="edit profile screen" width="500"/> | <img src="gallery/options-screen.png" alt="options screen" width="500"/>
|
<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"/>
|
||||||
|
Before Width: | Height: | Size: 1.4 MiB After Width: | Height: | Size: 729 KiB |
|
Before Width: | Height: | Size: 1.3 MiB After Width: | Height: | Size: 570 KiB |
BIN
gallery/options-toggle-menu.png
Normal file
|
After Width: | Height: | Size: 578 KiB |
|
Before Width: | Height: | Size: 926 KiB After Width: | Height: | Size: 554 KiB |