OfflineSkins icon indicating copy to clipboard operation
OfflineSkins copied to clipboard

Config documentation

Open C0rn3j opened this issue 3 years ago • 1 comments

First of, all thanks for maintaining this mod over the years!

Current config for reference:

{
  "useMojang": true,
  "useCrafatar": true,
  "useCustomServer": false,
  "hostCustomServer": "http://example.com",
  "useCustomServer2": false,
  "hostCustomServer2Skin": "http://example.com/skins/%auto%",
  "hostCustomServer2Cape": "http://example.com/capes/%auto%"
}

The current config options are very confusing. Why are there two custom servers? Does the mod open a webserver with my skins if I turn the server(1) on?

Currently a .json file is being used. JSON does not allow comments. It looks like all other mods I use migrated to .toml files. TOML does allow comments, so if this format were to be used, you could add comments into the config to prevent user confusion, like so, which would make things simpler to understand:

image

C0rn3j avatar Aug 04 '20 21:08 C0rn3j

I chose json as it was very easy to load, also vanilla uses them...

It is confusing to have two custom servers. They do serve different options though, but I might just remove the old one later.

A different format with comments might just work, I might change it to something else later.

zlainsama avatar Oct 24 '20 03:10 zlainsama