"""
File-based help entries. These complements command-based help and help entries
added in the database using the `sethelp` command in-game.

Control where Evennia reads these entries with `settings.FILE_HELP_ENTRY_MODULES`,
which is a list of python-paths to modules to read.

A module like this should hold a global `HELP_ENTRY_DICTS` list, containing
dicts that each represent a help entry. If no `HELP_ENTRY_DICTS` variable is
given, all top-level variables that are dicts in the module are read as help
entries.

Each dict is on the form
::

    {'key': <str>,
     'text': <str>}``     # the actual help text. Can contain # subtopic sections
     'category': <str>,   # optional, otherwise settings.DEFAULT_HELP_CATEGORY
     'aliases': <list>,   # optional
     'locks': <str>       # optional, 'view' controls seeing in help index, 'read'
                          #           if the entry can be read. If 'view' is unset,
                          #           'read' is used for the index. If unset, everyone
                          #           can read/view the entry.

"""

HELP_ENTRY_DICTS = [
    {
        "key": "start",
        "aliases": ["me start"],
        "locks": "read:all()",
        "text": """Again, welcome to my cozy little game.

To |wplay this game|n, you typically type a |w<verb>|b for an action, or |w<verb> <object>|b combinations. For instance, type |blook|n to look around the area, and |blook tree|n to examine the trees in particular. The more you look, the more you explore.

What verbs are available depends on where you are and what you might be holding. Type |bhelp|n with so other option to get a list. Then type |bhelp look|n to get details on how to use the |wlook|n verb.

This is a multi-user game, you might run into other characters, and they may look at you, so let's use some special verbs to affect the world from outside the storybook. Type:

    |w@setdesc A frumpy, but spry person with large ears and a dark blue cloak.|n

You see what people see when they look at you by typing:

    |wlook self|n

What is the goal of this game? Just to escape the chaos of the world and explore an idyllic setting. I call it my |gegg hunt game|n, as the game is full odd stuff to discover. Feel free to find me to chat, but good luck finding me, as I may be hiding.
        """
    },
    {
        "key": "charrename",
        "aliases": ["renaming characters"],
        "locks": "read:all()",
        "text": """When you created your account, my game creates a character with the same name. If you want to rename yourself, you create a new character. Follow these steps.

First, delete your introductory letter, using the |bburn|n command:

     |wburn letter|n

Next, leave your current character by typing:

     |wooc|n

Then delete your old character with:

     |wchardelete <original-name>|n

This only deletes the character of that name, not your account with that name.

Next, create a new character by typing:

     |wcharcreate Rambler = A frumpy, but spry person with large ears and dark blue cloak.|n

And now, assume that character by typing:

     |wic Rambler|n"""
    },
    {
        "key": "evennia",
        "aliases": ["ev"],
        "category": "General",
        "locks": "read:perm(Developer)",
        "text": """
            Evennia is a MU-game server and framework written in Python. You can read more
            on https://www.evennia.com.

            # subtopics

            ## Installation

            You'll find installation instructions on https://www.evennia.com.

            ## Community

            There are many ways to get help and communicate with other devs!

            ### Discussions

            The Discussions forum is found at https://github.com/evennia/evennia/discussions.

            ### Discord

            There is also a discord channel for chatting - connect using the
            following link: https://discord.gg/AJJpcRUhtF

        """,
    },
]