This mod can be used by Modpack developers to distribute default options and keybindings without overriding user changes on every modpack update.
Instead of shipping the options.txt directly, you will ship a "defaultoptions" folder in your modpack which contains the defaults previously saved through the /defaultoptions command.
This project is sponsored by Server.pro.
Need to host a modded server? Check out their plans here.
Features
- On the first run, users will start out with the options you configured - and future changes won't be overridden on updated
- Keybinds configured by the modpack will be set as new defaults, meaning changes made by users will persist even on updates
- The server list will be pre-populated with the server list provided by the modpack (and user changes will persist on updates, still)
Instructions
- 1. Configure the options, keybinds and server list as you would like them to be shipped in the modpack
- 2. Run /defaultoptions saveAll to save those options in the defaultoptions folder
- 3. Make sure you ship the defaultoptions folder, not the options.txt and servers.dat from the root directory
- 4. Fresh installations (meaning no existing options.txt) will now start out with your default options
If you are using FoamFix Anarchy Version, disable B:initOptions in the FoamFix config or else Default Options will not work. See this GitHub issue for more info.
Links
Is it okay to do this more than once before shipping the modpack?
currently I get this error message:
As far as i can tell the Keybinds are not being saved. The keybind txt file has NONE behind everything even after running the command.
Every time i launch a fresh install with no options.txt, it doesn't set any of the default options, but if I go and click reset controls to defaults, then it sets them. Why is it not just doing this automatically? I have the Defaultoptions folder in the config folder in the modpack, yet it still doesn't save.
So if you use this with an older version of the game, will it also overwrite the controls if you open a different version of Minecraft? Maybe a version with Forge and a vanilla Minecraft install?
In reply to ennh1349:
If options.txt already exists, it will not overwrite anything. For keys, it will only overwrite the default key assignments (what you get when you reset a key to default).
Is this installed server side or client side?
In reply to pongpaktech:
Client-side only.
what's the benefits of using this vs options.txt and optionsof.txt and the config folder?
In reply to Wohlf_craft:
If you as a modpack author publish a pack with options.txt included, every time the modpack updates all users will also have their options.txt overwritten again, undoing any changes to keybinds or options they may have made.
In reply to BlayTheNinth:
Is there a way to manually reset it if a pack user is having issues?
In reply to BlayTheNinth:
In reply to BlayTheNinth:
And how does the defaultconfigs work?
In reply to Wohlf_craft:
The pack user can just delete the options.txt file generated for them, then it will regenerate from the default options.txt.
Default configs are no longer a part of Default Options in 1.14+, as Forge itself now provides default configs. They're basically just copied into the config folder on first startup.
For 1.14, does this mod copy world/server configs?
In reply to thegiggitybyte:
No, as Forge now has native handling for that in its defaultconfig folder.
In reply to BlayTheNinth:
Ah. I wasn't aware that was the purpose of that folder. Thank you.
Sorry this is a dumb question but what does the author mean by "Make sure to ship the defaultoptions folder inside the config directory, and NOT the options.txt from the root directory in your modpack." I couldn't really find videos on how to use this mod.
In reply to chris221d:
When you're making a modpack, you select the files to be included with the modpack. What I mean is to not include the options.txt from within the Minecraft folder there.
Can I use it in my modpack. I will leave a credit in the list of mods
defaultoptions saveServers or /defaultoptions saveServers only gives me unknow command any ideas forge latest version of 1.12.2 and if you want more info lemme know any help is appriciated
I am already trying this mod for a while now but I can't get it to work like it should I guess. I make all my key configs and the options like music and video settings and then I go in game and execute the commands. The two configs (options and keybinds) are created in the defaultsettings folder in my config folder but when I play with a new instance without any configuration file, it is not taken from the mod. Only some controls are taken (not even all) but the options don't change, not the music, not the video settings, not the FOV. What am I doing wrong? The configs have to be in "modpack/config/defaultsettings" right? And I don't need to rename them or something?