Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-25 01:06:32 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/source/Contribs/Contrib-Mail.md
Griatch b922cf9b3c Auto-convert contrib readmes to doc pages
2022-01-08 00:58:56 +01:00

1.6 KiB
Raw Blame History

In-Game Mail system

Evennia Contribution - grungies1138 2016

A simple Brandymail style mail system that uses the Msg class from Evennia Core. It has two Commands, both of which can be used on their own:

  • CmdMail - this should sit on the Account cmdset and makes the mail command available both IC and OOC. Mails will always go to Accounts (other players).
  • CmdMailCharacter - this should sit on the Character cmdset and makes the mail command ONLY available when puppeting a character. Mails will be sent to other Characters only and will not be available when OOC.
  • If adding both commands to their respective cmdsets, you'll get two separate IC and OOC mailing systems, with different lists of mail for IC and OOC modes.

Installation:

Install one or both of the following (see above):

  • CmdMail (IC + OOC mail, sent between players)

    mygame/commands/default_cmds.py

    from evennia.contrib.game_systems import mail

    in AccountCmdSet.at_cmdset_creation:

      self.add(mail.CmdMail())

  • CmdMailCharacter (optional, IC only mail, sent between characters)

    mygame/commands/default_cmds.py

    from evennia.contrib.game_systems import mail

    in CharacterCmdSet.at_cmdset_creation:

      self.add(mail.CmdMailCharacter())

Once installed, use help mail in game for help with the mail command. Use ic/ooc to switch in and out of IC/OOC modes.

This document page is generated from evennia/contrib/game_systems/mail/README.md. Changes to this file will be overwritten, so edit that file rather than this one.