Skip to content

Revise skin instructions, move to separate README #4896

@egmontkob

Description

@egmontkob

Is there an existing request for this?

  • I have searched the existing issues

Is your feature request related to a problem?

Currently the colors that can be used in skins, as well as how inheritance works, are described in sand256.ini, the first 256-color skin.

Now that we have many 256-color skins, it's hard to find this info.

It should be moved to a separate README file which also gets installed to the skin directory. That's how people can easily find it. Or to the manual page?

While at it, do some further cleanups and fixes:

  • mention that from [whatever-section]/_default_ we further fall back to [core]/_default_.
  • merge truecolor syntax description from the seasons* skins.
  • Wrong comment about 256 colors in truecolor skins #4885
  • mention the 256colors and truecolors keywords
  • remove sentences referring to ancient versions, like sand256: needs ncurses or slang from 10 years ago or newer; modar*: needs mc 4.8 or newer
  • mention that the file needs to be encoded in UTF-8 (all those *-char definitions)
  • mention that currently only narrow (single charcell) characters are supported for *-char
  • point to the online skin viewer, to make it easier to discover

@horkykuba as per #4885 you have ongoing work hereabouts, I don't want to conflict with that so I'll work on this once you're done with that. Or, if you feel like taking on any of these, I won't hold you back :)

Describe the solution you'd like

.

Describe alternatives you've considered

No response

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: docsImprovements or additions to documentationprio: mediumHas the potential to affect progress

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions