id       = "nethack"
name     = "NetHack"
homepage = "https://www.nethack.org"
# No description: nethack.org and the Guidebook open in character rather than
# with a sentence saying what the program is, and inventing one to fill the gap
# is not what the field is for.
executables   = ["nethack"]

[dotfiles]

# The Guidebook for NetHack (https://www.nethack.org/v366/Guidebook.html),
# section 9 "Configuring NetHack", "9.2 Using a configuration file":
#
#   "On UNIX, Linux, and Mac OS X it is '.nethackrc' in the user's home
#    directory."
#   "On Windows, it is '.nethackrc' in the folder '\%USERPROFILE%\NetHack\3.6'."
#
# The Windows folder is versioned, so it is globbed; %USERPROFILE% resolves to
# the same place as ~, which is why that half is written with the ~ root.
# ~/.nethackrc covers both the Unix location and the file NETHACKOPTIONS points
# at when it is used to name a config file ("NETHACKOPTIONS=@/home/user/.nethackrc").
paths = [
  "~/.nethackrc",
  "~/NetHack/*/.nethackrc",
]

# The same folder holds ".nethackrc.template", the default NetHack writes on
# first run, plus the save files and the record of games played. None is under
# a path above — the template shares the directory but not the name — so there
# is nothing to carve out of what is.
exclude = []

# A config file of display options and key bindings; nothing in it is a
# credential.
secret = []

# Read once when the game starts.
side_effect = false

# No machine_lines: OPTIONS, SYMBOLS, BIND and MSGTYPE lines are the player's
# own preferences and are exactly what they want on another machine.