From 132b86dc4167974038908c8f7e962f1da3f07252 Mon Sep 17 00:00:00 2001 From: Evennia docbuilder action Date: Thu, 10 Nov 2022 22:29:13 +0000 Subject: [PATCH] Updated HTML docs --- docs/0.9.5/.buildinfo | 2 +- docs/0.9.5/Default-Commands.html | 32 +++--- docs/0.9.5/_sources/Default-Commands.md.txt | 32 +++--- .../api/evennia.commands.default.account.html | 2 +- .../api/evennia.commands.default.admin.html | 2 +- .../evennia.commands.default.building.html | 6 +- .../api/evennia.commands.default.comms.html | 4 +- .../api/evennia.commands.default.general.html | 6 +- .../api/evennia.commands.default.system.html | 6 +- .../evennia.commands.default.unloggedin.html | 8 +- docs/0.9.5/api/evennia.contrib.chargen.html | 2 +- docs/0.9.5/api/evennia.contrib.clothing.html | 2 +- docs/0.9.5/api/evennia.contrib.dice.html | 2 +- .../api/evennia.contrib.email_login.html | 8 +- .../api/evennia.contrib.extended_room.html | 2 +- docs/0.9.5/api/evennia.contrib.rpsystem.html | 4 +- ...b.tutorial_examples.cmdset_red_button.html | 4 +- ...vennia.contrib.tutorial_world.objects.html | 6 +- .../evennia.contrib.tutorial_world.rooms.html | 6 +- docs/0.9.5/api/evennia.utils.eveditor.html | 2 +- docs/0.9.5/api/evennia.utils.evmore.html | 2 +- docs/1.0-dev/.buildinfo | 2 +- .../Components/Components-Overview.html | 3 +- docs/1.0-dev/Howtos/Howtos-Overview.html | 6 +- docs/1.0-dev/Setup/Installation-Git.html | 3 +- .../Setup/Installation-Non-Interactive.html | 2 +- docs/1.0-dev/Setup/Installation.html | 45 ++++----- docs/1.0-dev/Setup/Settings-Default.html | 1 - docs/1.0-dev/Setup/Setup-Overview.html | 7 +- docs/1.0-dev/Setup/Start-Stop-Reload.html | 93 ++++++++---------- .../_modules/evennia/commands/command.html | 16 +-- .../Components/Components-Overview.md.txt | 3 +- .../_sources/Howtos/Howtos-Overview.md.txt | 6 +- .../_sources/Setup/Installation-Git.md.txt | 3 +- .../Setup/Installation-Non-Interactive.md.txt | 2 +- .../_sources/Setup/Installation.md.txt | 48 ++++----- .../_sources/Setup/Settings-Default.md.txt | 1 - .../_sources/Setup/Setup-Overview.md.txt | 3 +- .../_sources/Setup/Start-Stop-Reload.md.txt | 92 ++++++++--------- docs/1.0-dev/_sources/index.md.txt | 30 +++--- .../1.0-dev/api/evennia.commands.command.html | 15 +-- .../api/evennia.commands.default.account.html | 4 +- ...evennia.commands.default.batchprocess.html | 4 +- .../evennia.commands.default.building.html | 12 +-- .../api/evennia.commands.default.general.html | 8 +- .../api/evennia.commands.default.tests.html | 17 ++-- .../evennia.commands.default.unloggedin.html | 8 +- ....base_systems.email_login.email_login.html | 8 +- ...b.base_systems.ingame_python.commands.html | 4 +- ...systems.mux_comms_cmds.mux_comms_cmds.html | 4 +- ...rib.full_systems.evscaperoom.commands.html | 20 ++-- ...trib.grid.extended_room.extended_room.html | 4 +- .../api/evennia.contrib.rpg.dice.dice.html | 4 +- ...evennia.contrib.rpg.rpsystem.rpsystem.html | 4 +- ...ontrib.tutorials.evadventure.commands.html | 4 +- ...ntrib.tutorials.red_button.red_button.html | 16 +-- ...trib.tutorials.tutorial_world.objects.html | 8 +- ...ontrib.tutorials.tutorial_world.rooms.html | 12 +-- ...utils.git_integration.git_integration.html | 4 +- docs/1.0-dev/api/evennia.utils.eveditor.html | 4 +- docs/1.0-dev/api/evennia.utils.evmenu.html | 4 +- docs/1.0-dev/api/evennia.utils.evmore.html | 4 +- docs/1.0-dev/index.html | 46 +++++---- docs/1.0-dev/objects.inv | Bin 157529 -> 157597 bytes docs/1.0-dev/searchindex.js | 2 +- 65 files changed, 351 insertions(+), 375 deletions(-) diff --git a/docs/0.9.5/.buildinfo b/docs/0.9.5/.buildinfo index 3ab6c3401d..3db21fe370 100644 --- a/docs/0.9.5/.buildinfo +++ b/docs/0.9.5/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: d916ba83d14bdd23d24af406d3c94a92 +config: 9116756ccc7a94e0bea91f44355f07a5 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/0.9.5/Default-Commands.html b/docs/0.9.5/Default-Commands.html index c4aaa66e48..8dfc6e95c0 100644 --- a/docs/0.9.5/Default-Commands.html +++ b/docs/0.9.5/Default-Commands.html @@ -67,45 +67,45 @@ with cdesc (cmdset: AccountCmdSet, help-category: Comms)

  • cdestroy (cmdset: AccountCmdSet, help-category: Comms)

  • cemit [cmsg] (cmdset: AccountCmdSet, help-category: Comms)

    • -

  • channels [all channels, chanlist, comlist, channellist, clist] (cmdset: AccountCmdSet, help-category: Comms)

    • +

  • channels [comlist, channellist, all channels, clist, chanlist] (cmdset: AccountCmdSet, help-category: Comms)

  • charcreate (cmdset: AccountCmdSet, help-category: General)

  • chardelete (cmdset: AccountCmdSet, help-category: General)

  • clock (cmdset: AccountCmdSet, help-category: Comms)

  • cmdsets [listcmsets] (cmdset: CharacterCmdSet, help-category: Building)

  • color (cmdset: AccountCmdSet, help-category: General)

    • -

  • connect [con, co, conn] (cmdset: UnloggedinCmdSet, help-category: General)

    • +

  • connect [conn, co, con] (cmdset: UnloggedinCmdSet, help-category: General)

  • copy (cmdset: CharacterCmdSet, help-category: Building)

  • cpattr (cmdset: CharacterCmdSet, help-category: Building)

  • create (cmdset: CharacterCmdSet, help-category: Building)

    • -

  • create [cr, cre] (cmdset: UnloggedinCmdSet, help-category: General)

    • +

  • create [cre, cr] (cmdset: UnloggedinCmdSet, help-category: General)

  • cwho (cmdset: AccountCmdSet, help-category: Comms)

    • -

  • delcom [delchanalias, delaliaschan] (cmdset: AccountCmdSet, help-category: Comms)

    • +

  • delcom [delaliaschan, delchanalias] (cmdset: AccountCmdSet, help-category: Comms)

  • desc [describe] (cmdset: CharacterCmdSet, help-category: Building)

    • -

  • destroy [delete, del] (cmdset: CharacterCmdSet, help-category: Building)

    • +

  • destroy [del, delete] (cmdset: CharacterCmdSet, help-category: Building)

  • dig (cmdset: CharacterCmdSet, help-category: Building)

  • drop (cmdset: CharacterCmdSet, help-category: General)

  • encoding [encode] (cmdset: UnloggedinCmdSet, help-category: General)

  • examine [exam, ex] (cmdset: AccountCmdSet, help-category: Building)

    • -

  • find [search, locate] (cmdset: CharacterCmdSet, help-category: Building)

    • +

  • find [locate, search] (cmdset: CharacterCmdSet, help-category: Building)

  • get [grab] (cmdset: CharacterCmdSet, help-category: General)

  • give (cmdset: CharacterCmdSet, help-category: General)

  • grapevine2chan (cmdset: AccountCmdSet, help-category: Comms)

  • help [?] (cmdset: AccountCmdSet, help-category: General)

    • -

  • help [h, ?] (cmdset: UnloggedinCmdSet, help-category: General)

    • +

  • help [?, h] (cmdset: UnloggedinCmdSet, help-category: General)

  • home (cmdset: CharacterCmdSet, help-category: General)

  • ic [puppet] (cmdset: AccountCmdSet, help-category: General)

  • info (cmdset: UnloggedinCmdSet, help-category: General)

    • -

  • inventory [i, inv] (cmdset: CharacterCmdSet, help-category: General)

    • +

  • inventory [inv, i] (cmdset: CharacterCmdSet, help-category: General)

  • irc2chan (cmdset: AccountCmdSet, help-category: Comms)

  • ircstatus (cmdset: AccountCmdSet, help-category: Comms)

  • link (cmdset: CharacterCmdSet, help-category: Building)

  • lock [locks] (cmdset: CharacterCmdSet, help-category: Building)

    • -

  • look [ls, l] (cmdset: AccountCmdSet, help-category: General)

    • -

  • look [ls, l] (cmdset: CharacterCmdSet, help-category: General)

    • +

  • look [l, ls] (cmdset: AccountCmdSet, help-category: General)

    • +

  • look [l, ls] (cmdset: CharacterCmdSet, help-category: General)

  • mvattr (cmdset: CharacterCmdSet, help-category: Building)

  • name [rename] (cmdset: CharacterCmdSet, help-category: Building)

  • nick [nickname, nicks] (cmdset: AccountCmdSet, help-category: General)

    • -

  • objects [listobjects, stats, listobjs, db] (cmdset: CharacterCmdSet, help-category: System)

    • +

  • objects [stats, listobjects, listobjs, db] (cmdset: CharacterCmdSet, help-category: System)

  • ooc [unpuppet] (cmdset: AccountCmdSet, help-category: General)

  • open (cmdset: CharacterCmdSet, help-category: Building)

  • option [options] (cmdset: AccountCmdSet, help-category: General)

    • @@ -115,15 +115,15 @@ with py [!] (cmdset: AccountCmdSet, help-category: System)

  • quell [unquell] (cmdset: AccountCmdSet, help-category: General)

  • quit (cmdset: AccountCmdSet, help-category: General)

    • -

  • quit [q, qu] (cmdset: UnloggedinCmdSet, help-category: General)

    • +

  • quit [qu, q] (cmdset: UnloggedinCmdSet, help-category: General)

  • reload [restart] (cmdset: AccountCmdSet, help-category: System)

  • reset [reboot] (cmdset: AccountCmdSet, help-category: System)

  • rss2chan (cmdset: AccountCmdSet, help-category: Comms)

    • -

  • say [”, ‘] (cmdset: CharacterCmdSet, help-category: General)

    • +

  • say [’, “] (cmdset: CharacterCmdSet, help-category: General)

  • screenreader (cmdset: UnloggedinCmdSet, help-category: General)

  • script [addscript] (cmdset: CharacterCmdSet, help-category: Building)

    • -

  • scripts [globalscript, listscripts] (cmdset: CharacterCmdSet, help-category: System)

    • -

  • server [serverprocess, serverload] (cmdset: CharacterCmdSet, help-category: System)

    • +

  • scripts [listscripts, globalscript] (cmdset: CharacterCmdSet, help-category: System)

    • +

  • server [serverload, serverprocess] (cmdset: CharacterCmdSet, help-category: System)

  • service [services] (cmdset: CharacterCmdSet, help-category: System)

  • sessions (cmdset: SessionCmdSet, help-category: General)

  • set (cmdset: CharacterCmdSet, help-category: Building)

    • @@ -138,7 +138,7 @@ with tickers (cmdset: CharacterCmdSet, help-category: System)

  • time [uptime] (cmdset: CharacterCmdSet, help-category: System)

  • tunnel [tun] (cmdset: CharacterCmdSet, help-category: Building)

    • -

  • typeclass [swap, parent, type, update] (cmdset: CharacterCmdSet, help-category: Building)

    • +

  • typeclass [parent, update, type, swap] (cmdset: CharacterCmdSet, help-category: Building)

  • unlink (cmdset: CharacterCmdSet, help-category: Building)

  • whisper (cmdset: CharacterCmdSet, help-category: General)

  • who [doing] (cmdset: AccountCmdSet, help-category: General)

    • diff --git a/docs/0.9.5/_sources/Default-Commands.md.txt b/docs/0.9.5/_sources/Default-Commands.md.txt index 4776d37dcf..6b02eeeb69 100644 --- a/docs/0.9.5/_sources/Default-Commands.md.txt +++ b/docs/0.9.5/_sources/Default-Commands.md.txt @@ -28,45 +28,45 @@ with [EvEditor](./EvEditor.md), flipping pages in [EvMore](./EvMore.md) or using - [**cdesc**](evennia.commands.default.comms.CmdCdesc) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _Comms_) - [**cdestroy**](evennia.commands.default.comms.CmdCdestroy) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _Comms_) - [**cemit** [cmsg]](evennia.commands.default.comms.CmdCemit) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _Comms_) -- [**channels** [all channels, chanlist, comlist, channellist, clist]](evennia.commands.default.comms.CmdChannels) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _Comms_) +- [**channels** [comlist, channellist, all channels, clist, chanlist]](evennia.commands.default.comms.CmdChannels) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _Comms_) - [**charcreate**](evennia.commands.default.account.CmdCharCreate) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _General_) - [**chardelete**](evennia.commands.default.account.CmdCharDelete) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _General_) - [**clock**](evennia.commands.default.comms.CmdClock) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _Comms_) - [**cmdsets** [listcmsets]](evennia.commands.default.building.CmdListCmdSets) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) - [**color**](evennia.commands.default.account.CmdColorTest) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _General_) -- [**connect** [con, co, conn]](evennia.commands.default.unloggedin.CmdUnconnectedConnect) (cmdset: [UnloggedinCmdSet](evennia.commands.default.cmdset_unloggedin.UnloggedinCmdSet), help-category: _General_) +- [**connect** [conn, co, con]](evennia.commands.default.unloggedin.CmdUnconnectedConnect) (cmdset: [UnloggedinCmdSet](evennia.commands.default.cmdset_unloggedin.UnloggedinCmdSet), help-category: _General_) - [**copy**](evennia.commands.default.building.CmdCopy) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) - [**cpattr**](evennia.commands.default.building.CmdCpAttr) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) - [**create**](evennia.commands.default.building.CmdCreate) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) -- [**create** [cr, cre]](evennia.commands.default.unloggedin.CmdUnconnectedCreate) (cmdset: [UnloggedinCmdSet](evennia.commands.default.cmdset_unloggedin.UnloggedinCmdSet), help-category: _General_) +- [**create** [cre, cr]](evennia.commands.default.unloggedin.CmdUnconnectedCreate) (cmdset: [UnloggedinCmdSet](evennia.commands.default.cmdset_unloggedin.UnloggedinCmdSet), help-category: _General_) - [**cwho**](evennia.commands.default.comms.CmdCWho) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _Comms_) -- [**delcom** [delchanalias, delaliaschan]](evennia.commands.default.comms.CmdDelCom) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _Comms_) +- [**delcom** [delaliaschan, delchanalias]](evennia.commands.default.comms.CmdDelCom) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _Comms_) - [**desc** [describe]](evennia.commands.default.building.CmdDesc) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) -- [**destroy** [delete, del]](evennia.commands.default.building.CmdDestroy) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) +- [**destroy** [del, delete]](evennia.commands.default.building.CmdDestroy) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) - [**dig**](evennia.commands.default.building.CmdDig) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) - [**drop**](evennia.commands.default.general.CmdDrop) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _General_) - [**encoding** [encode]](evennia.commands.default.unloggedin.CmdUnconnectedEncoding) (cmdset: [UnloggedinCmdSet](evennia.commands.default.cmdset_unloggedin.UnloggedinCmdSet), help-category: _General_) - [**examine** [exam, ex]](evennia.commands.default.building.CmdExamine) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _Building_) -- [**find** [search, locate]](evennia.commands.default.building.CmdFind) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) +- [**find** [locate, search]](evennia.commands.default.building.CmdFind) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) - [**get** [grab]](evennia.commands.default.general.CmdGet) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _General_) - [**give**](evennia.commands.default.general.CmdGive) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _General_) - [**grapevine2chan**](evennia.commands.default.comms.CmdGrapevine2Chan) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _Comms_) - [**help** [?]](evennia.commands.default.help.CmdHelp) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _General_) -- [**help** [h, ?]](evennia.commands.default.unloggedin.CmdUnconnectedHelp) (cmdset: [UnloggedinCmdSet](evennia.commands.default.cmdset_unloggedin.UnloggedinCmdSet), help-category: _General_) +- [**help** [?, h]](evennia.commands.default.unloggedin.CmdUnconnectedHelp) (cmdset: [UnloggedinCmdSet](evennia.commands.default.cmdset_unloggedin.UnloggedinCmdSet), help-category: _General_) - [**home**](evennia.commands.default.general.CmdHome) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _General_) - [**ic** [puppet]](evennia.commands.default.account.CmdIC) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _General_) - [**info**](evennia.commands.default.unloggedin.CmdUnconnectedInfo) (cmdset: [UnloggedinCmdSet](evennia.commands.default.cmdset_unloggedin.UnloggedinCmdSet), help-category: _General_) -- [**inventory** [i, inv]](evennia.commands.default.general.CmdInventory) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _General_) +- [**inventory** [inv, i]](evennia.commands.default.general.CmdInventory) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _General_) - [**irc2chan**](evennia.commands.default.comms.CmdIRC2Chan) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _Comms_) - [**ircstatus**](evennia.commands.default.comms.CmdIRCStatus) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _Comms_) - [**link**](evennia.commands.default.building.CmdLink) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) - [**lock** [locks]](evennia.commands.default.building.CmdLock) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) -- [**look** [ls, l]](evennia.commands.default.account.CmdOOCLook) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _General_) -- [**look** [ls, l]](evennia.commands.default.general.CmdLook) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _General_) +- [**look** [l, ls]](evennia.commands.default.account.CmdOOCLook) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _General_) +- [**look** [l, ls]](evennia.commands.default.general.CmdLook) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _General_) - [**mvattr**](evennia.commands.default.building.CmdMvAttr) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) - [**name** [rename]](evennia.commands.default.building.CmdName) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) - [**nick** [nickname, nicks]](evennia.commands.default.general.CmdNick) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _General_) -- [**objects** [listobjects, stats, listobjs, db]](evennia.commands.default.system.CmdObjects) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _System_) +- [**objects** [stats, listobjects, listobjs, db]](evennia.commands.default.system.CmdObjects) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _System_) - [**ooc** [unpuppet]](evennia.commands.default.account.CmdOOC) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _General_) - [**open**](evennia.commands.default.building.CmdOpen) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) - [**option** [options]](evennia.commands.default.account.CmdOption) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _General_) @@ -76,15 +76,15 @@ with [EvEditor](./EvEditor.md), flipping pages in [EvMore](./EvMore.md) or using - [**py** [!]](evennia.commands.default.system.CmdPy) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _System_) - [**quell** [unquell]](evennia.commands.default.account.CmdQuell) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _General_) - [**quit**](evennia.commands.default.account.CmdQuit) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _General_) -- [**quit** [q, qu]](evennia.commands.default.unloggedin.CmdUnconnectedQuit) (cmdset: [UnloggedinCmdSet](evennia.commands.default.cmdset_unloggedin.UnloggedinCmdSet), help-category: _General_) +- [**quit** [qu, q]](evennia.commands.default.unloggedin.CmdUnconnectedQuit) (cmdset: [UnloggedinCmdSet](evennia.commands.default.cmdset_unloggedin.UnloggedinCmdSet), help-category: _General_) - [**reload** [restart]](evennia.commands.default.system.CmdReload) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _System_) - [**reset** [reboot]](evennia.commands.default.system.CmdReset) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _System_) - [**rss2chan**](evennia.commands.default.comms.CmdRSS2Chan) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _Comms_) -- [**say** [", ']](evennia.commands.default.general.CmdSay) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _General_) +- [**say** [', "]](evennia.commands.default.general.CmdSay) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _General_) - [**screenreader**](evennia.commands.default.unloggedin.CmdUnconnectedScreenreader) (cmdset: [UnloggedinCmdSet](evennia.commands.default.cmdset_unloggedin.UnloggedinCmdSet), help-category: _General_) - [**script** [addscript]](evennia.commands.default.building.CmdScript) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) -- [**scripts** [globalscript, listscripts]](evennia.commands.default.system.CmdScripts) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _System_) -- [**server** [serverprocess, serverload]](evennia.commands.default.system.CmdServerLoad) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _System_) +- [**scripts** [listscripts, globalscript]](evennia.commands.default.system.CmdScripts) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _System_) +- [**server** [serverload, serverprocess]](evennia.commands.default.system.CmdServerLoad) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _System_) - [**service** [services]](evennia.commands.default.system.CmdService) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _System_) - [**sessions**](evennia.commands.default.account.CmdSessions) (cmdset: [SessionCmdSet](evennia.commands.default.cmdset_session.SessionCmdSet), help-category: _General_) - [**set**](evennia.commands.default.building.CmdSetAttribute) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) @@ -99,7 +99,7 @@ with [EvEditor](./EvEditor.md), flipping pages in [EvMore](./EvMore.md) or using - [**tickers**](evennia.commands.default.system.CmdTickers) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _System_) - [**time** [uptime]](evennia.commands.default.system.CmdTime) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _System_) - [**tunnel** [tun]](evennia.commands.default.building.CmdTunnel) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) -- [**typeclass** [swap, parent, type, update]](evennia.commands.default.building.CmdTypeclass) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) +- [**typeclass** [parent, update, type, swap]](evennia.commands.default.building.CmdTypeclass) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) - [**unlink**](evennia.commands.default.building.CmdUnLink) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _Building_) - [**whisper**](evennia.commands.default.general.CmdWhisper) (cmdset: [CharacterCmdSet](evennia.commands.default.cmdset_character.CharacterCmdSet), help-category: _General_) - [**who** [doing]](evennia.commands.default.account.CmdWho) (cmdset: [AccountCmdSet](evennia.commands.default.cmdset_account.AccountCmdSet), help-category: _General_) diff --git a/docs/0.9.5/api/evennia.commands.default.account.html b/docs/0.9.5/api/evennia.commands.default.account.html index d998c2f3e5..b0883f258d 100644 --- a/docs/0.9.5/api/evennia.commands.default.account.html +++ b/docs/0.9.5/api/evennia.commands.default.account.html @@ -72,7 +72,7 @@ method. Otherwise all text will be returned to all connected sessions.

    -aliases = ['ls', 'l']
    +aliases = ['l', 'ls']
    diff --git a/docs/0.9.5/api/evennia.commands.default.admin.html b/docs/0.9.5/api/evennia.commands.default.admin.html index 1fdb15eef8..fc745748e6 100644 --- a/docs/0.9.5/api/evennia.commands.default.admin.html +++ b/docs/0.9.5/api/evennia.commands.default.admin.html @@ -241,7 +241,7 @@ to accounts respectively.

    -aliases = ['pemit', 'remit']
    +aliases = ['remit', 'pemit']
    diff --git a/docs/0.9.5/api/evennia.commands.default.building.html b/docs/0.9.5/api/evennia.commands.default.building.html index 046aa5a7e4..3465b805f4 100644 --- a/docs/0.9.5/api/evennia.commands.default.building.html +++ b/docs/0.9.5/api/evennia.commands.default.building.html @@ -496,7 +496,7 @@ You can specify the /force switch to bypass this confirmation.

    -aliases = ['delete', 'del']
    +aliases = ['del', 'delete']
    @@ -1186,7 +1186,7 @@ server settings.

    -aliases = ['swap', 'parent', 'type', 'update']
    +aliases = ['parent', 'update', 'type', 'swap']
    @@ -1481,7 +1481,7 @@ one is given.

    -aliases = ['search', 'locate']
    +aliases = ['locate', 'search']
    diff --git a/docs/0.9.5/api/evennia.commands.default.comms.html b/docs/0.9.5/api/evennia.commands.default.comms.html index 9b47583857..30ddffced5 100644 --- a/docs/0.9.5/api/evennia.commands.default.comms.html +++ b/docs/0.9.5/api/evennia.commands.default.comms.html @@ -118,7 +118,7 @@ for that channel.

    -aliases = ['delchanalias', 'delaliaschan']
    +aliases = ['delaliaschan', 'delchanalias']
    @@ -221,7 +221,7 @@ Use addcom/delcom to join and leave channels

    -aliases = ['all channels', 'chanlist', 'comlist', 'channellist', 'clist']
    +aliases = ['comlist', 'channellist', 'all channels', 'clist', 'chanlist']
    diff --git a/docs/0.9.5/api/evennia.commands.default.general.html b/docs/0.9.5/api/evennia.commands.default.general.html index 6a6e0ca067..b2f44ae146 100644 --- a/docs/0.9.5/api/evennia.commands.default.general.html +++ b/docs/0.9.5/api/evennia.commands.default.general.html @@ -109,7 +109,7 @@ look *<account&g
    -aliases = ['ls', 'l']
    +aliases = ['l', 'ls']
    @@ -247,7 +247,7 @@ inv

    -aliases = ['i', 'inv']
    +aliases = ['inv', 'i']
    @@ -497,7 +497,7 @@ placing it in their inventory.

    -aliases = ['"', "'"]
    +aliases = ["'", '"']
    diff --git a/docs/0.9.5/api/evennia.commands.default.system.html b/docs/0.9.5/api/evennia.commands.default.system.html index d0dfd20e7b..e82280f35b 100644 --- a/docs/0.9.5/api/evennia.commands.default.system.html +++ b/docs/0.9.5/api/evennia.commands.default.system.html @@ -296,7 +296,7 @@ required since whole classes of scripts often have the same name.

    -aliases = ['globalscript', 'listscripts']
    +aliases = ['listscripts', 'globalscript']
    @@ -351,7 +351,7 @@ given, <nr> defaults to 10.

    -aliases = ['listobjects', 'stats', 'listobjs', 'db']
    +aliases = ['stats', 'listobjects', 'listobjs', 'db']
    @@ -558,7 +558,7 @@ the released memory will instead be re-used by the program.

    -aliases = ['serverprocess', 'serverload']
    +aliases = ['serverload', 'serverprocess']
    diff --git a/docs/0.9.5/api/evennia.commands.default.unloggedin.html b/docs/0.9.5/api/evennia.commands.default.unloggedin.html index 6fb73d54bb..fb214a30ea 100644 --- a/docs/0.9.5/api/evennia.commands.default.unloggedin.html +++ b/docs/0.9.5/api/evennia.commands.default.unloggedin.html @@ -61,7 +61,7 @@ connect “account name” “pass word”

    -aliases = ['con', 'co', 'conn']
    +aliases = ['conn', 'co', 'con']
    @@ -115,7 +115,7 @@ create “account name” “pass word”

    -aliases = ['cr', 'cre']
    +aliases = ['cre', 'cr']
    @@ -165,7 +165,7 @@ version is a bit more complicated.

    -aliases = ['q', 'qu']
    +aliases = ['qu', 'q']
    @@ -254,7 +254,7 @@ for simplicity. It shows a pane of info.

    -aliases = ['h', '?']
    +aliases = ['?', 'h']
    diff --git a/docs/0.9.5/api/evennia.contrib.chargen.html b/docs/0.9.5/api/evennia.contrib.chargen.html index e7f84087a5..d12901c845 100644 --- a/docs/0.9.5/api/evennia.contrib.chargen.html +++ b/docs/0.9.5/api/evennia.contrib.chargen.html @@ -79,7 +79,7 @@ at them with this command.

    -aliases = ['ls', 'l']
    +aliases = ['l', 'ls']
    diff --git a/docs/0.9.5/api/evennia.contrib.clothing.html b/docs/0.9.5/api/evennia.contrib.clothing.html index 68cdbe13fa..e1d032f019 100644 --- a/docs/0.9.5/api/evennia.contrib.clothing.html +++ b/docs/0.9.5/api/evennia.contrib.clothing.html @@ -600,7 +600,7 @@ inv

    -aliases = ['i', 'inv']
    +aliases = ['inv', 'i']
    diff --git a/docs/0.9.5/api/evennia.contrib.dice.html b/docs/0.9.5/api/evennia.contrib.dice.html index 31f97ae1cb..6dc941e2e3 100644 --- a/docs/0.9.5/api/evennia.contrib.dice.html +++ b/docs/0.9.5/api/evennia.contrib.dice.html @@ -151,7 +151,7 @@ everyone but the person rolling.

    -aliases = ['roll', '@dice']
    +aliases = ['@dice', 'roll']
    diff --git a/docs/0.9.5/api/evennia.contrib.email_login.html b/docs/0.9.5/api/evennia.contrib.email_login.html index f315d3c8c2..2186de4cf4 100644 --- a/docs/0.9.5/api/evennia.contrib.email_login.html +++ b/docs/0.9.5/api/evennia.contrib.email_login.html @@ -76,7 +76,7 @@ the module given by settings.CONNECTION_SCREEN_MODULE.

    -aliases = ['con', 'co', 'conn']
    +aliases = ['conn', 'co', 'con']
    @@ -123,7 +123,7 @@ there is no object yet before the account has logged in)

    -aliases = ['cr', 'cre']
    +aliases = ['cre', 'cr']
    @@ -173,7 +173,7 @@ version is a bit more complicated.

    -aliases = ['q', 'qu']
    +aliases = ['qu', 'q']
    @@ -252,7 +252,7 @@ for simplicity. It shows a pane of info.

    -aliases = ['h', '?']
    +aliases = ['?', 'h']
    diff --git a/docs/0.9.5/api/evennia.contrib.extended_room.html b/docs/0.9.5/api/evennia.contrib.extended_room.html index 06d3ab50ad..82cd005b3a 100644 --- a/docs/0.9.5/api/evennia.contrib.extended_room.html +++ b/docs/0.9.5/api/evennia.contrib.extended_room.html @@ -278,7 +278,7 @@ look *<account&g
    -aliases = ['ls', 'l']
    +aliases = ['l', 'ls']
    diff --git a/docs/0.9.5/api/evennia.contrib.rpsystem.html b/docs/0.9.5/api/evennia.contrib.rpsystem.html index 9855c49ce1..80729fb150 100644 --- a/docs/0.9.5/api/evennia.contrib.rpsystem.html +++ b/docs/0.9.5/api/evennia.contrib.rpsystem.html @@ -625,7 +625,7 @@ a different language.

    -aliases = ['"', "'"]
    +aliases = ["'", '"']
    @@ -775,7 +775,7 @@ Using the command without arguments will list all current recogs.

    -aliases = ['forget', 'recognize']
    +aliases = ['recognize', 'forget']
    diff --git a/docs/0.9.5/api/evennia.contrib.tutorial_examples.cmdset_red_button.html b/docs/0.9.5/api/evennia.contrib.tutorial_examples.cmdset_red_button.html index 53a732d153..abf8c998ce 100644 --- a/docs/0.9.5/api/evennia.contrib.tutorial_examples.cmdset_red_button.html +++ b/docs/0.9.5/api/evennia.contrib.tutorial_examples.cmdset_red_button.html @@ -107,7 +107,7 @@ push the lid of the button away.

    -aliases = ['press', 'push', 'press button']
    +aliases = ['push', 'press button', 'press']
    @@ -284,7 +284,7 @@ of causing the lamp to break.

    -aliases = ['ex', 'listen', 'get', 'l', 'feel', 'examine']
    +aliases = ['l', 'listen', 'feel', 'get', 'ex', 'examine']
    diff --git a/docs/0.9.5/api/evennia.contrib.tutorial_world.objects.html b/docs/0.9.5/api/evennia.contrib.tutorial_world.objects.html index 2d462a99d1..51fd85b1ce 100644 --- a/docs/0.9.5/api/evennia.contrib.tutorial_world.objects.html +++ b/docs/0.9.5/api/evennia.contrib.tutorial_world.objects.html @@ -479,7 +479,7 @@ shift green root up/down

    -aliases = ['shiftroot', 'pull', 'push', 'move']
    +aliases = ['push', 'pull', 'shiftroot', 'move']
    @@ -527,7 +527,7 @@ yellow/green - horizontal roots

    -aliases = ['button', 'push button', 'press button']
    +aliases = ['push button', 'press button', 'button']
    @@ -692,7 +692,7 @@ parry - forgoes your attack but will make you harder to hit on next

    -aliases = ['chop', 'defend', 'fight', 'kill', 'stab', 'pierce', 'hit', 'slash', 'parry', 'bash', 'thrust']
    +aliases = ['hit', 'fight', 'slash', 'defend', 'chop', 'pierce', 'bash', 'parry', 'stab', 'kill', 'thrust']
    diff --git a/docs/0.9.5/api/evennia.contrib.tutorial_world.rooms.html b/docs/0.9.5/api/evennia.contrib.tutorial_world.rooms.html index 0d1fcce7b6..fa8b36c206 100644 --- a/docs/0.9.5/api/evennia.contrib.tutorial_world.rooms.html +++ b/docs/0.9.5/api/evennia.contrib.tutorial_world.rooms.html @@ -176,7 +176,7 @@ code except for adding in the details.

    -aliases = ['ls', 'l']
    +aliases = ['l', 'ls']
    @@ -675,7 +675,7 @@ if they fall off the bridge.

    -aliases = ['h', '?']
    +aliases = ['?', 'h']
    @@ -822,7 +822,7 @@ to find something.

    -aliases = ['search', 'l', 'feel', 'fiddle', 'feel around']
    +aliases = ['l', 'feel', 'feel around', 'search', 'fiddle']
    diff --git a/docs/0.9.5/api/evennia.utils.eveditor.html b/docs/0.9.5/api/evennia.utils.eveditor.html index 647dae285f..da64dc12bf 100644 --- a/docs/0.9.5/api/evennia.utils.eveditor.html +++ b/docs/0.9.5/api/evennia.utils.eveditor.html @@ -267,7 +267,7 @@ indentation.

    -aliases = [':I', ':', ':j', ':s', ':=', ':UU', ':uu', ':y', ':h', ':i', ':f', ':w', ':dd', ':wq', ':r', ':fd', '::', ':echo', ':fi', ':::', ':q', ':DD', ':p', ':x', ':dw', ':<', ':u', ':q!', ':S', ':!', ':>', ':A']
    +aliases = [':p', ':r', ':', '::', ':<', ':h', ':dw', ':UU', ':>', ':s', ':w', ':j', ':dd', ':uu', ':!', ':f', ':y', ':u', ':q!', ':i', ':wq', ':::', ':DD', ':A', ':S', ':fi', ':echo', ':x', ':q', ':fd', ':=', ':I']
    diff --git a/docs/0.9.5/api/evennia.utils.evmore.html b/docs/0.9.5/api/evennia.utils.evmore.html index a403a4c892..89bd49b7a8 100644 --- a/docs/0.9.5/api/evennia.utils.evmore.html +++ b/docs/0.9.5/api/evennia.utils.evmore.html @@ -77,7 +77,7 @@ the caller.msg() construct every time the page is updated.

    -aliases = ['t', 'back', 'q', 'next', 'top', 'end', 'n', 'abort', 'a', 'quit', 'b', 'e']
    +aliases = ['t', 'back', 'top', 'quit', 'b', 'q', 'e', 'a', 'n', 'end', 'abort', 'next']
    diff --git a/docs/1.0-dev/.buildinfo b/docs/1.0-dev/.buildinfo index 921c69a87a..a0f459866b 100644 --- a/docs/1.0-dev/.buildinfo +++ b/docs/1.0-dev/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 764ca445dfcca78eb741d61d0a6eba35 +config: b7f1604cef888337c7228b63dedf290f tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/1.0-dev/Components/Components-Overview.html b/docs/1.0-dev/Components/Components-Overview.html index 21c45965c1..4328524dcc 100644 --- a/docs/1.0-dev/Components/Components-Overview.html +++ b/docs/1.0-dev/Components/Components-Overview.html @@ -107,8 +107,7 @@

    Core Components

    -

    These are the ‘building blocks’ out of which Evennia is built. This documentation is complementary to, and often goes deeper -than, the doc-strings of each component in the API.

    +

    These are the ‘building blocks’ out of which Evennia is built. This documentation is complementary to, and often goes deeper than, the doc-strings of each component in the API.

    Database entites

    diff --git a/docs/1.0-dev/Howtos/Howtos-Overview.html b/docs/1.0-dev/Howtos/Howtos-Overview.html index 241b339048..b966d1ef71 100644 --- a/docs/1.0-dev/Howtos/Howtos-Overview.html +++ b/docs/1.0-dev/Howtos/Howtos-Overview.html @@ -110,11 +110,7 @@

    Tutorials and Howto’s

    -

    The documents in this section aims to teach how to use Evennia in a tutorial or -a step-by-step way. They often give hints on about solving a problem or implementing -a particular feature or concept. They will often refer to the -components or concepts -docs for those that want to dive deeper.

    +

    All Evennia tutorials. They will often refer to the components or concepts if you want to dive deeper.

    Beginner Tutorial

    Recommended starting point! This will take you from absolute beginner to making diff --git a/docs/1.0-dev/Setup/Installation-Git.html b/docs/1.0-dev/Setup/Installation-Git.html index 9e11336e89..c4946a3595 100644 --- a/docs/1.0-dev/Setup/Installation-Git.html +++ b/docs/1.0-dev/Setup/Installation-Git.html @@ -107,8 +107,7 @@

    Installing with GIT

    -

    This installs and runs Evennia from its sources. This is required if you want to contribute to Evennia -itself or have an easier time exploring the code. See the basic Installation for +

    This installs and runs Evennia from its sources. This is required if you want to contribute to Evennia itself or have an easier time exploring the code. See the basic Installation for a quick installation of the library. See the troubleshooting if you run into trouble.

    diff --git a/docs/1.0-dev/Setup/Installation-Non-Interactive.html b/docs/1.0-dev/Setup/Installation-Non-Interactive.html index bb2b8f7236..5894ba3bcb 100644 --- a/docs/1.0-dev/Setup/Installation-Non-Interactive.html +++ b/docs/1.0-dev/Setup/Installation-Non-Interactive.html @@ -96,7 +96,7 @@

    Non-interactive setup

    -

    The first ime you run evennia start (just after having created the database), you will be asked +

    The first time you run evennia start (just after having created the database), you will be asked to interactively insert the superuser username, email and password. If you are deploying Evennia as part of an automatic build script, you don’t want to enter this information manually.

    You can have the superuser be created automatically by passing environment variables to your diff --git a/docs/1.0-dev/Setup/Installation.html b/docs/1.0-dev/Setup/Installation.html index 642bd51ab8..b52081d67f 100644 --- a/docs/1.0-dev/Setup/Installation.html +++ b/docs/1.0-dev/Setup/Installation.html @@ -110,13 +110,6 @@

    Installation

    -

    The Evennia server is installed, run and maintained from the terminal (console/CMD on Windows). Starting the server -doesn’t make anything visible online. Once you download everything you can in fact develop your game in complete -isolation if you want, without needing any access to the internet.

    -

    Evennia requires Python 3.9 or 3.10. -Using a Python virtualenv is highly recommended in order to keep your -Evennia installation independent from the system libraries. Don’t install Evennia as -administrator or superuser.

    Warning

    pip install evennia is not yet available in develop branch. Use the git installation.

    @@ -125,14 +118,24 @@ administrator or superuser.

    Important

    If you are converting an existing game from a previous version, see here.

    +
      +

    • Evennia requires Python 3.9 or 3.10.

      • +

    • Using a Python virtualenv is highly recommended in order to keep your +Evennia installation independent from the system libraries.

      • +

    • Don’t install Evennia as +administrator or superuser.

      • +
    +

    Evennia is managed from the terminal (console/CMD on Windows). If you have a suitable Python installed, you can install with

    pip install evennia
    -

    Once installed, make sure the evennia command works. Use evennia -h for usage help. If you are using a -virtualenv, make sure it’s active whenever you need to use the evennia command.

    -

    Alternatively, you can install Evennia from github or use docker. -Check out installation troubleshooting if you run into problems. Some +

    Alternatively, you can install Evennia from github or use docker.

    +

    Installing doesn’t make anything visible online. Apart from installation and updating, you can develop your game without any internet connection.

    +

    Once installed, make sure the evennia command works. Use evennia -h for usage help. If you are using a virtualenv, make sure it’s active whenever you need to use the evennia command.

    +
    +

    Check out installation troubleshooting if you run into problems. Some users have also experimented with installing Evennia on Android.

    +

    Initialize a new game

    Use cd to enter a folder where you want to do your game development. Here (and in @@ -150,18 +153,15 @@ contains empty templates and all the default settings needed to start the server evennia migrate

    -

    This will create the default database (Sqlite3). The database file ends up as mygame/server/evennia.db3. If you -ever want to start from a fresh database, just delete this file and re-run evennia migrate again.

    +

    This will create the default database (Sqlite3). The database file ends up as mygame/server/evennia.db3. If you ever want to start from a fresh database, just delete this file and re-run evennia migrate again.

    evennia start
    -

    Set your user-name and password when prompted. This will be the “god user” or “superuser” in-game. -The email is optional.

    +

    Set your user-name and password when prompted. This will be the “god user” or “superuser” in-game. The email is optional.

    You can also automate the creation of the super user.

    -

    If all went well, the server is now up and running. Point a legacy MUD/telnet client to localhost:4000 or -a web browser at http://localhost:4001 to play your new (if empty) game!

    +

    If all went well, the server is now up and running. Point a legacy MUD/telnet client to localhost:4000 or a web browser at http://localhost:4001 to play your new (if empty) game!

    Log in as a new account or use the superuser you just created.

    @@ -197,8 +197,7 @@ a web browser at http

    Server configuration

    -

    The server configuration file is mygame/server/settings.py. It’s empty by default. Copy and change -only the settings you want from the default settings file.

    +

    The server configuration file is mygame/server/settings.py. It’s empty by default. Copy and change only the settings you want from the default settings file.

    Register with the Evennia Game Index (optional)

    @@ -214,13 +213,7 @@ beforehand to make sure you don’t pick a game name that is already taken - be

    The Next steps

    You are good to go!

    -

    Evennia comes with a small Tutorial World to experiment and learn from. After logging -in, you can create it by running

    -
    batchcommand tutorial_world.build
-
    -
    -

    Next, why not head into the Starting Tutorial -to learn how to start making your new game!

    +

    Next, why not head into the Starting Tutorial to learn how to start making your new game!

    diff --git a/docs/1.0-dev/Setup/Settings-Default.html b/docs/1.0-dev/Setup/Settings-Default.html index 78a515352e..aa773d1745 100644 --- a/docs/1.0-dev/Setup/Settings-Default.html +++ b/docs/1.0-dev/Setup/Settings-Default.html @@ -927,7 +927,6 @@ to change into myga "aliases": ("pub",), "desc": "Public discussion", "locks": "control:perm(Admin);listen:all();send:all()", - "typeclass": BASE_CHANNEL_TYPECLASS, } ] diff --git a/docs/1.0-dev/Setup/Setup-Overview.html b/docs/1.0-dev/Setup/Setup-Overview.html index 954cd8dfd5..26d0e577c7 100644 --- a/docs/1.0-dev/Setup/Setup-Overview.html +++ b/docs/1.0-dev/Setup/Setup-Overview.html @@ -105,8 +105,7 @@

    Server Setup and Life

    -

    This documentation covers how to setup and maintain the server, -from first install to opening your game to the public.

    +

    This sums up all steps of maintaining your Evennia game from first installation to production release.

    Installation & running

    @@ -160,11 +159,11 @@ from first install to opening your game to the public.

  • Non-interactive setup
  • Start Stop Reload
    • Starting Evennia
      • -
    • Foreground mode
    • Reloading
      • +
    • Stopping
      • +
    • Foreground mode
    • Resetting
    • Rebooting
      • -
    • Shutting down
    • Status and info
    • Killing (Linux/Mac only)
    • Django options
      • diff --git a/docs/1.0-dev/Setup/Start-Stop-Reload.html b/docs/1.0-dev/Setup/Start-Stop-Reload.html index 77ceb97e07..03ddcf38d0 100644 --- a/docs/1.0-dev/Setup/Start-Stop-Reload.html +++ b/docs/1.0-dev/Setup/Start-Stop-Reload.html @@ -64,11 +64,11 @@
      • Start Stop Reload
        • Starting Evennia
          • -
        • Foreground mode
        • Reloading
          • +
        • Stopping
          • +
        • Foreground mode
        • Resetting
        • Rebooting
          • -
        • Shutting down
        • Status and info
        • Killing (Linux/Mac only)
        • Django options
          • @@ -118,11 +118,11 @@

          Start Stop Reload

          You control Evennia from your game folder (we refer to it as mygame/ here), using the evennia program. If the evennia program is not available on the command line you must first install -Evennia as described in the Setup Quickstart page.

          -
          -

          Hint: If you ever try the evennia command and get an error complaining that the command is not -available, make sure your virtualenv is active.

          -
          +Evennia as described on the Installation page.

          +

          Below are described the various management options. Run

          evennia -h
          @@ -134,7 +134,7 @@ available, make sure your

          Starting Evennia

          -

          Evennia consists of two components, the Evennia Server and Portal. Briefly, +

          Evennia consists of two components, the Evennia Portal and Server. Briefly, the Server is what is running the mud. It handles all game-specific things but doesn’t care exactly how players connect, only that they have. The Portal is a gateway to which players connect. It knows everything about telnet, ssh, webclient protocols etc but very little about the @@ -142,10 +142,7 @@ game. Both are required for a functioning mud.

           evennia start
          -

          The above command will start the Portal, which in turn will boot up the Server. The command will -print a summary of the process and unless there is an error you will see no further output. Both -components will instead log to log files in mygame/server/logs/. For convenience you can follow -those logs directly in your terminal by attaching -l to commands:

          +

          The above command will start the Portal, which in turn will boot up the Server. The command will print a summary of the process and unless there is an error you will see no further output. Both components will instead log to log files in mygame/server/logs/. For convenience you can follow those logs directly in your terminal by attaching -l to commands:

           evennia -l
          @@ -157,23 +154,6 @@ those logs directly in your terminal by attaching Ctrl-C.

    • -
    -

    Foreground mode

    -

    Normally, Evennia runs as a ‘daemon’, in the background. If you want you can start either of the -processes (but not both) as foreground processes in interactive mode. This means they will log -directly to the terminal (rather than to log files that we then echo to the terminal) and you can -kill the process (not just the log-file view) with Ctrl-C.

    -
    evennia istart
-
    -
    -

    will start/restart the Server in interactive mode. This is required if you want to run a -debugger. Next time you reload the server, it will return to normal mode.

    -
    evennia ipstart
-
    -
    -

    will start the Portal in interactive mode. This is usually only necessary if you want to run -Evennia under the control of some other type of process.

    -

    Reloading

    The act of reloading means the Portal will tell the Server to shut down and then boot it back up @@ -191,6 +171,34 @@ can save eventual temporary properties you want.

    Sometimes reloading from “the outside” is necessary in case you have added some sort of bug that blocks in-game input.

    +
    +

    Stopping

    +

    A full shutdown closes Evennia completely, both Server and Portal. All accounts will be booted and +systems saved and turned off cleanly.

    +

    From inside the game you initiate a shutdown with the @shutdown command. From command line you do

    +
     evennia stop
+
    +
    +

    You will see messages of both Server and Portal closing down. All accounts will see the shutdown +message and then be disconnected. The same effect happens if you press Ctrl+C while the server +runs in interactive mode.

    +
    +
    +

    Foreground mode

    +

    Normally, Evennia runs as a ‘daemon’, in the background. If you want you can start either of the +processes (but not both) as foreground processes in interactive mode. This means they will log +directly to the terminal (rather than to log files that we then echo to the terminal) and you can +kill the process (not just the log-file view) with Ctrl-C.

    +
    evennia istart
+
    +
    +

    will start/restart the Server in interactive mode. This is required if you want to run a +debugger. Next time you evennia reload the server, it will return to normal mode.

    +
    evennia ipstart
+
    +
    +

    will start the Portal in interactive mode.

    +

    Resetting

    Resetting is the equivalent of a “cold reboot” - the Server will shut down and then restarted @@ -216,18 +224,6 @@ connection. It can only be initiated from the terminal:

    -
    -

    Shutting down

    -

    A full shutdown closes Evennia completely, both Server and Portal. All accounts will be booted and -systems saved and turned off cleanly.

    -

    From inside the game you initiate a shutdown with the @shutdown command. From command line you do

    -
     evennia stop
-
    -
    -

    You will see messages of both Server and Portal closing down. All accounts will see the shutdown -message and then be disconnected. The same effect happens if you press Ctrl+C while the server -runs in interactive mode.

    -

    Status and info

    To check basic Evennia settings, such as which ports and services are active, this will repeat the @@ -244,7 +240,7 @@ initial return given when starting the server:

    Killing (Linux/Mac only)

    In the extreme case that neither of the server processes locks up and does not respond to commands, -you can send them kill-signals to force them to shut down. To kill only the Server:

    +you can send them kill-signals to force them to shut down. To kill only the Server:

    evennia skill
    @@ -256,15 +252,13 @@ you can send them kill-signals to force them to shut down. To kill only the Serv

    Django options

    -

    The evennia program will also pass-through options used by the django-admin. These operate on -the database in various ways.

    +

    The evennia program will also pass-through options used by the django-admin. These operate on the database in various ways.

     evennia migrate # migrate the database
  evennia shell   # launch an interactive, django-aware python shell
- evennia dbshell # launch database shell
+ evennia dbshell # launch the database shell
    -

    For (many) more options, see the django-admin -docs.

    +

    For (many) more options, see the django-admin docs.

    Advanced handling of Evennia processes

    @@ -273,10 +267,7 @@ such as Linux’ to related to Evennia:

    • 1 x twistd ... evennia/server/portal/portal.py - this is the Portal process.

      • -

    • 3 x twistd ... server.py - One of these processes manages Evennia’s Server component, the main -game. The other processes (with the same name but different process id) handle’s Evennia’s -internal web server threads. You can look at mygame/server/server.pid to determine which is the -main process.

      • +

    • 3 x twistd ... server.py - One of these processes manages Evennia’s Server component, the main game. The other processes (with the same name but different process id) handle’s Evennia’s internal web server threads. You can look at mygame/server/server.pid to determine which is the main process.

    Syntax errors during live development

    diff --git a/docs/1.0-dev/_modules/evennia/commands/command.html b/docs/1.0-dev/_modules/evennia/commands/command.html index 7e5d6539bc..480316310a 100644 --- a/docs/1.0-dev/_modules/evennia/commands/command.html +++ b/docs/1.0-dev/_modules/evennia/commands/command.html @@ -222,17 +222,19 @@ The cmdhandler makes the following variables available to the command methods (so you can always assume them to be there): + self.caller - the game object calling the command self.cmdstring - the command name used to trigger this command (allows you to know which alias was used, for example) - cmd.args - everything supplied to the command following the cmdstring + self.args - everything supplied to the command following the cmdstring (this is usually what is parsed in self.parse()) - cmd.cmdset - the cmdset from which this command was matched (useful only - seldomly, notably for help-type commands, to create dynamic - help entries and lists) - cmd.obj - the object on which this command is defined. If a default command, - this is usually the same as caller. - cmd.rawstring - the full raw string input, including any args and no parsing. + self.cmdset - the cmdset from which this command was matched (useful only + seldomly, notably for help-type commands, to create dynamic + help entries and lists) + self.obj - the object on which this command is defined. If a default command, + this is usually the same as caller. + self.raw_string - the full raw string input, including the command name, + any args and no parsing. The following class properties can/should be defined on your child class: diff --git a/docs/1.0-dev/_sources/Components/Components-Overview.md.txt b/docs/1.0-dev/_sources/Components/Components-Overview.md.txt index 0f0e93d248..a0cc25688b 100644 --- a/docs/1.0-dev/_sources/Components/Components-Overview.md.txt +++ b/docs/1.0-dev/_sources/Components/Components-Overview.md.txt @@ -1,7 +1,6 @@ # Core Components -These are the 'building blocks' out of which Evennia is built. This documentation is complementary to, and often goes deeper -than, the doc-strings of each component in the [API](../Evennia-API.md). +These are the 'building blocks' out of which Evennia is built. This documentation is complementary to, and often goes deeper than, the doc-strings of each component in the [API](../Evennia-API.md). ## Database entites diff --git a/docs/1.0-dev/_sources/Howtos/Howtos-Overview.md.txt b/docs/1.0-dev/_sources/Howtos/Howtos-Overview.md.txt index d0cac98f1a..190387dd83 100644 --- a/docs/1.0-dev/_sources/Howtos/Howtos-Overview.md.txt +++ b/docs/1.0-dev/_sources/Howtos/Howtos-Overview.md.txt @@ -1,10 +1,6 @@ # Tutorials and Howto's -The documents in this section aims to teach how to use Evennia in a tutorial or -a step-by-step way. They often give hints on about solving a problem or implementing -a particular feature or concept. They will often refer to the -[components](../Components/Components-Overview.md) or [concepts](../Concepts/Concepts-Overview.md) -docs for those that want to dive deeper. +All Evennia tutorials. They will often refer to the [components](../Components/Components-Overview.md) or [concepts](../Concepts/Concepts-Overview.md) if you want to dive deeper. ## Beginner Tutorial diff --git a/docs/1.0-dev/_sources/Setup/Installation-Git.md.txt b/docs/1.0-dev/_sources/Setup/Installation-Git.md.txt index 1ffffa220a..00c3fc89de 100644 --- a/docs/1.0-dev/_sources/Setup/Installation-Git.md.txt +++ b/docs/1.0-dev/_sources/Setup/Installation-Git.md.txt @@ -1,7 +1,6 @@ # Installing with GIT -This installs and runs Evennia from its sources. This is required if you want to contribute to Evennia -itself or have an easier time exploring the code. See the basic [Installation](./Installation.md) for +This installs and runs Evennia from its sources. This is required if you want to contribute to Evennia itself or have an easier time exploring the code. See the basic [Installation](./Installation.md) for a quick installation of the library. See the [troubleshooting](./Installation-Troubleshooting.md) if you run into trouble. diff --git a/docs/1.0-dev/_sources/Setup/Installation-Non-Interactive.md.txt b/docs/1.0-dev/_sources/Setup/Installation-Non-Interactive.md.txt index 7095260830..3a056858d3 100644 --- a/docs/1.0-dev/_sources/Setup/Installation-Non-Interactive.md.txt +++ b/docs/1.0-dev/_sources/Setup/Installation-Non-Interactive.md.txt @@ -1,6 +1,6 @@ # Non-interactive setup -The first ime you run `evennia start` (just after having created the database), you will be asked +The first time you run `evennia start` (just after having created the database), you will be asked to interactively insert the superuser username, email and password. If you are deploying Evennia as part of an automatic build script, you don't want to enter this information manually. diff --git a/docs/1.0-dev/_sources/Setup/Installation.md.txt b/docs/1.0-dev/_sources/Setup/Installation.md.txt index 7dbb5449f7..6a6fa7232c 100644 --- a/docs/1.0-dev/_sources/Setup/Installation.md.txt +++ b/docs/1.0-dev/_sources/Setup/Installation.md.txt @@ -1,14 +1,5 @@ # Installation -The Evennia server is installed, run and maintained from the terminal (console/CMD on Windows). Starting the server -doesn't make anything visible online. Once you download everything you can in fact develop your game in complete -isolation if you want, without needing any access to the internet. - -Evennia requires [Python](https://www.python.org/downloads/) 3.9 or 3.10. -Using a [Python virtualenv](../Glossary.md#virtualenv) is highly recommended in order to keep your -Evennia installation independent from the system libraries. Don't install Evennia as -administrator or superuser. - ```{warning} pip install evennia is not yet available in develop branch. Use the [git installation](./Installation-Git.md). ``` @@ -16,13 +7,24 @@ pip install evennia is not yet available in develop branch. Use the [git install If you are converting an existing game from a previous version, [see here](./Installation-Upgrade.md). ``` + +- Evennia requires [Python](https://www.python.org/downloads/) 3.9 or 3.10. +- Using a [Python virtualenv](../Glossary.md#virtualenv) is highly recommended in order to keep your +Evennia installation independent from the system libraries. +- Don't install Evennia as +administrator or superuser. + +Evennia is managed from the terminal (console/CMD on Windows). If you have a suitable Python installed, you can install with + pip install evennia -Once installed, make sure the `evennia` command works. Use `evennia -h` for usage help. If you are using a -virtualenv, make sure it's active whenever you need to use the `evennia` command. - Alternatively, you can [install Evennia from github](./Installation-Git.md) or use [docker](./Installation-Docker.md). -Check out [installation troubleshooting](./Installation-Troubleshooting.md) if you run into problems. Some + +Installing doesn't make anything visible online. Apart from installation and updating, you can develop your game without any internet connection. + +Once installed, make sure the `evennia` command works. Use `evennia -h` for usage help. If you are using a virtualenv, make sure it's active whenever you need to use the `evennia` command. + +> Check out [installation troubleshooting](./Installation-Troubleshooting.md) if you run into problems. Some users have also experimented with [installing Evennia on Android](./Installation-Android.md). ## Initialize a new game @@ -42,18 +44,15 @@ contains empty templates and all the default settings needed to start the server cd mygame evennia migrate -This will create the default database (Sqlite3). The database file ends up as `mygame/server/evennia.db3`. If you -ever want to start from a fresh database, just delete this file and re-run `evennia migrate` again. +This will create the default database (Sqlite3). The database file ends up as `mygame/server/evennia.db3`. If you ever want to start from a fresh database, just delete this file and re-run `evennia migrate` again. evennia start -Set your user-name and password when prompted. This will be the "god user" or "superuser" in-game. -The email is optional. +Set your user-name and password when prompted. This will be the "god user" or "superuser" in-game. The email is optional. > You can also [automate](./Installation-Non-Interactive.md) the creation of the super user. -If all went well, the server is now up and running. Point a legacy MUD/telnet client to `localhost:4000` or -a web browser at [http://localhost:4001](http://localhost:4001) to play your new (if empty) game! +If all went well, the server is now up and running. Point a legacy MUD/telnet client to `localhost:4000` or a web browser at [http://localhost:4001](http://localhost:4001) to play your new (if empty) game! Log in as a new account or use the superuser you just created. @@ -93,8 +92,7 @@ To exit the log tailing, enter `Ctrl-C` (`Cmd-C` for Mac). This will not affect ## Server configuration -The server configuration file is `mygame/server/settings.py`. It's empty by default. Copy and change -only the settings you want from the [default settings file](./Settings-Default.md). +The server configuration file is `mygame/server/settings.py`. It's empty by default. Copy and change only the settings you want from the [default settings file](./Settings-Default.md). ## Register with the Evennia Game Index (optional) @@ -111,10 +109,4 @@ beforehand to make sure you don't pick a game name that is already taken - be ni You are good to go! -Evennia comes with a small [Tutorial World](../Howtos/Beginner-Tutorial/Part1/Beginner-Tutorial-Tutorial-World.md) to experiment and learn from. After logging -in, you can create it by running - - batchcommand tutorial_world.build - -Next, why not head into the [Starting Tutorial](../Howtos/Beginner-Tutorial/Part1/Beginner-Tutorial-Part1-Intro.md) -to learn how to start making your new game! \ No newline at end of file +Next, why not head into the [Starting Tutorial](../Howtos/Beginner-Tutorial/Part1/Beginner-Tutorial-Part1-Intro.md) to learn how to start making your new game! \ No newline at end of file diff --git a/docs/1.0-dev/_sources/Setup/Settings-Default.md.txt b/docs/1.0-dev/_sources/Setup/Settings-Default.md.txt index 9fc52a20b5..1550dcee80 100644 --- a/docs/1.0-dev/_sources/Setup/Settings-Default.md.txt +++ b/docs/1.0-dev/_sources/Setup/Settings-Default.md.txt @@ -837,7 +837,6 @@ DEFAULT_CHANNELS = [ "aliases": ("pub",), "desc": "Public discussion", "locks": "control:perm(Admin);listen:all();send:all()", - "typeclass": BASE_CHANNEL_TYPECLASS, } ] diff --git a/docs/1.0-dev/_sources/Setup/Setup-Overview.md.txt b/docs/1.0-dev/_sources/Setup/Setup-Overview.md.txt index eed92376a1..8adb04aee4 100644 --- a/docs/1.0-dev/_sources/Setup/Setup-Overview.md.txt +++ b/docs/1.0-dev/_sources/Setup/Setup-Overview.md.txt @@ -1,7 +1,6 @@ # Server Setup and Life -This documentation covers how to setup and maintain the server, -from first install to opening your game to the public. +This sums up all steps of maintaining your Evennia game from first installation to production release. ## Installation & running diff --git a/docs/1.0-dev/_sources/Setup/Start-Stop-Reload.md.txt b/docs/1.0-dev/_sources/Setup/Start-Stop-Reload.md.txt index 80cb76cf3e..25ea908939 100644 --- a/docs/1.0-dev/_sources/Setup/Start-Stop-Reload.md.txt +++ b/docs/1.0-dev/_sources/Setup/Start-Stop-Reload.md.txt @@ -3,10 +3,11 @@ You control Evennia from your game folder (we refer to it as `mygame/` here), using the `evennia` program. If the `evennia` program is not available on the command line you must first install -Evennia as described in the [Setup Quickstart](./Installation.md) page. +Evennia as described on the [Installation](./Installation.md) page. -> Hint: If you ever try the `evennia` command and get an error complaining that the command is not -available, make sure your [virtualenv](../Glossary.md#virtualenv) is active. +```{sidebar} evennia not found? +If you ever try the `evennia` command and get an error complaining that the command is not available, make sure your [virtualenv](../Glossary.md#virtualenv) is active. +``` Below are described the various management options. Run @@ -20,7 +21,7 @@ to give you a menu with options. ## Starting Evennia -Evennia consists of two components, the Evennia [Server and Portal](../Components/Portal-And-Server.md). Briefly, +Evennia consists of two components, the Evennia [Portal and Server](../Components/Portal-And-Server.md). Briefly, the *Server* is what is running the mud. It handles all game-specific things but doesn't care exactly how players connect, only that they have. The *Portal* is a gateway to which players connect. It knows everything about telnet, ssh, webclient protocols etc but very little about the @@ -28,10 +29,7 @@ game. Both are required for a functioning mud. evennia start -The above command will start the Portal, which in turn will boot up the Server. The command will -print a summary of the process and unless there is an error you will see no further output. Both -components will instead log to log files in `mygame/server/logs/`. For convenience you can follow -those logs directly in your terminal by attaching `-l` to commands: +The above command will start the Portal, which in turn will boot up the Server. The command will print a summary of the process and unless there is an error you will see no further output. Both components will instead log to log files in `mygame/server/logs/`. For convenience you can follow those logs directly in your terminal by attaching `-l` to commands: evennia -l @@ -41,23 +39,6 @@ Will start following the logs of an already running server. When starting Evenni > To stop viewing the log files, press `Ctrl-C`. -## Foreground mode - -Normally, Evennia runs as a 'daemon', in the background. If you want you can start either of the -processes (but not both) as foreground processes in *interactive* mode. This means they will log -directly to the terminal (rather than to log files that we then echo to the terminal) and you can -kill the process (not just the log-file view) with `Ctrl-C`. - - evennia istart - -will start/restart the *Server* in interactive mode. This is required if you want to run a -*debugger*. Next time you reload the server, it will return to normal mode. - - evennia ipstart - -will start the *Portal* in interactive mode. This is usually only necessary if you want to run -Evennia under the control of some other type of process. - ## Reloading The act of *reloading* means the Portal will tell the Server to shut down and then boot it back up @@ -78,6 +59,36 @@ From in-game the `@reload` command is used. You can also reload the server from Sometimes reloading from "the outside" is necessary in case you have added some sort of bug that blocks in-game input. +## Stopping + +A full shutdown closes Evennia completely, both Server and Portal. All accounts will be booted and +systems saved and turned off cleanly. + +From inside the game you initiate a shutdown with the `@shutdown` command. From command line you do + + evennia stop + +You will see messages of both Server and Portal closing down. All accounts will see the shutdown +message and then be disconnected. The same effect happens if you press `Ctrl+C` while the server +runs in interactive mode. + + +## Foreground mode + +Normally, Evennia runs as a 'daemon', in the background. If you want you can start either of the +processes (but not both) as foreground processes in *interactive* mode. This means they will log +directly to the terminal (rather than to log files that we then echo to the terminal) and you can +kill the process (not just the log-file view) with `Ctrl-C`. + + evennia istart + +will start/restart the *Server* in interactive mode. This is required if you want to run a +[debugger](../Coding/Debugging.md). Next time you `evennia reload` the server, it will return to normal mode. + + evennia ipstart + +will start the *Portal* in interactive mode. + ## Resetting *Resetting* is the equivalent of a "cold reboot" - the Server will shut down and then restarted @@ -103,20 +114,6 @@ This is identical to doing these two commands: evennia stop evennia start - -## Shutting down - -A full shutdown closes Evennia completely, both Server and Portal. All accounts will be booted and -systems saved and turned off cleanly. - -From inside the game you initiate a shutdown with the `@shutdown` command. From command line you do - - evennia stop - -You will see messages of both Server and Portal closing down. All accounts will see the shutdown -message and then be disconnected. The same effect happens if you press `Ctrl+C` while the server -runs in interactive mode. - ## Status and info To check basic Evennia settings, such as which ports and services are active, this will repeat the @@ -134,7 +131,7 @@ This can be useful for automating checks to make sure the game is running and is ## Killing (Linux/Mac only) In the extreme case that neither of the server processes locks up and does not respond to commands, -you can send them kill-signals to force them to shut down. To kill only the Server: +[]()you can send them kill-signals to force them to shut down. To kill only the Server: evennia skill @@ -147,19 +144,17 @@ Note that this functionality is not supported on Windows. ## Django options -The `evennia` program will also pass-through options used by the `django-admin`. These operate on -the database in various ways. +The `evennia` program will also pass-through options used by the `django-admin`. These operate on the database in various ways. ```bash evennia migrate # migrate the database evennia shell # launch an interactive, django-aware python shell - evennia dbshell # launch database shell + evennia dbshell # launch the database shell ``` -For (many) more options, see [the django-admin -docs](https://docs.djangoproject.com/en/1.7/ref/django-admin/#usage). +For (many) more options, see [the django-admin docs](https://docs.djangoproject.com/en/1.7/ref/django-admin/#usage). ## Advanced handling of Evennia processes @@ -168,10 +163,7 @@ such as Linux' `top` or the more advanced `htop`), you will find the following p related to Evennia: * 1 x `twistd ... evennia/server/portal/portal.py` - this is the Portal process. -* 3 x `twistd ... server.py` - One of these processes manages Evennia's Server component, the main - game. The other processes (with the same name but different process id) handle's Evennia's - internal web server threads. You can look at `mygame/server/server.pid` to determine which is the - main process. +* 3 x `twistd ... server.py` - One of these processes manages Evennia's Server component, the main game. The other processes (with the same name but different process id) handle's Evennia's internal web server threads. You can look at `mygame/server/server.pid` to determine which is the main process. ### Syntax errors during live development @@ -193,4 +185,4 @@ Fix your bug then run evennia start Assuming the bug was fixed, this will start the Server manually (while not restarting the Portal). -In-game you should now get the message that the Server has successfully restarted. +In-game you should now get the message that the Server has successfully restarted. \ No newline at end of file diff --git a/docs/1.0-dev/_sources/index.md.txt b/docs/1.0-dev/_sources/index.md.txt index 11eba37116..e8950126c8 100644 --- a/docs/1.0-dev/_sources/index.md.txt +++ b/docs/1.0-dev/_sources/index.md.txt @@ -14,27 +14,35 @@ This is the manual of [Evennia](https://www.evennia.com), the open source Python `MU*` creation system. - [Evennia Introduction](./Evennia-Introduction.md) -- [Installation](Setup/Installation.md) -- [Beginner Tutorial](Howtos/Beginner-Tutorial/Beginner-Tutorial-Intro.md) - [How to contribute and get help](./Contributing.md) -## Main sections +## Setup -- [Server Setup, Maintenance and Life](Setup/Setup-Overview.md) - how to run, maintain and release -- [Tutorials and Howto's](Howtos/Howtos-Overview.md) - projects and hints for reaching particular effects and goals ----- +- [Installation](Setup/Installation.md) +- [Starting, Stopping and Reloading](Setup/Start-Stop-Reload.md) - how to manage the Evennia server +- [Configurations](Setup/Setup-Overview.md) - how to run, maintain and release + +## Howtos and Tutorials + +- [The Beginner Tutorial](Howtos/Beginner-Tutorial/Beginner-Tutorial-Intro.md) - learn the basics and build a small game (in progress) +- [Tutorials and Howto's](Howtos/Howtos-Overview.md) - mixed tutorials to learn Evennia + +## Developing with Evennia - [Core components](Components/Components-Overview.md) - the core building blocks of Evennia - [Concepts](Concepts/Concepts-Overview.md) - larger-scale concepts and features ----- - - [API](./Evennia-API.md) - the full API-reference, generated from source - [Default Commands](Components/Default-Commands.md) - list of game commands included out of the box - [Coding](Coding/Coding-Overview.md) - coding and development hints and resources -- [Contribs](Contribs/Contribs-Overview.md) - game-specific tools and code added by the community ----- -- [Links](./Links.md) - useful links + +## Contributions and Info + +- [Contribs](Contribs/Contribs-Overview.md) - game-specific code and snippets to use for your game - [How to contribute to these docs](./Contributing-Docs.md) - if you want to help out +- [Links](./Links.md) - useful links +- [Licensing](./Licensing.md) - Evennia licensing info (BSD) + +---- ## All Sections diff --git a/docs/1.0-dev/api/evennia.commands.command.html b/docs/1.0-dev/api/evennia.commands.command.html index cf1865eb9a..4657407a77 100644 --- a/docs/1.0-dev/api/evennia.commands.command.html +++ b/docs/1.0-dev/api/evennia.commands.command.html @@ -133,22 +133,23 @@

    This is the base command class. Inherit from this to create new commands.

    The cmdhandler makes the following variables available to the -command methods (so you can always assume them to be there): -self.caller - the game object calling the command +command methods (so you can always assume them to be there):

    +

    self.caller - the game object calling the command self.cmdstring - the command name used to trigger this command (allows

    you to know which alias was used, for example)

    -
    cmd.args - everything supplied to the command following the cmdstring

    (this is usually what is parsed in self.parse())

    +
    self.args - everything supplied to the command following the cmdstring

    (this is usually what is parsed in self.parse())

    -
    cmd.cmdset - the cmdset from which this command was matched (useful only

    seldomly, notably for help-type commands, to create dynamic +

    self.cmdset - the cmdset from which this command was matched (useful only

    seldomly, notably for help-type commands, to create dynamic help entries and lists)

    -
    cmd.obj - the object on which this command is defined. If a default command,

    this is usually the same as caller.

    +
    self.obj - the object on which this command is defined. If a default command,

    this is usually the same as caller.

    +
    +
    self.raw_string - the full raw string input, including the command name,

    any args and no parsing.

    -

    cmd.rawstring - the full raw string input, including any args and no parsing.

    The following class properties can/should be defined on your child class:

    key - identifier for command (e.g. “look”) aliases - (optional) list of aliases (e.g. [“l”, “loo”]) @@ -548,7 +549,7 @@ detailing the contents of the table.

    -search_index_entry = {'aliases': '', 'category': 'general', 'key': 'command', 'no_prefix': ' ', 'tags': '', 'text': '\n ## Base command\n\n (you may see this if a child command had no help text defined)\n\n Usage:\n command [args]\n\n This is the base command class. Inherit from this\n to create new commands.\n\n The cmdhandler makes the following variables available to the\n command methods (so you can always assume them to be there):\n self.caller - the game object calling the command\n self.cmdstring - the command name used to trigger this command (allows\n you to know which alias was used, for example)\n cmd.args - everything supplied to the command following the cmdstring\n (this is usually what is parsed in self.parse())\n cmd.cmdset - the cmdset from which this command was matched (useful only\n seldomly, notably for help-type commands, to create dynamic\n help entries and lists)\n cmd.obj - the object on which this command is defined. If a default command,\n this is usually the same as caller.\n cmd.rawstring - the full raw string input, including any args and no parsing.\n\n The following class properties can/should be defined on your child class:\n\n key - identifier for command (e.g. "look")\n aliases - (optional) list of aliases (e.g. ["l", "loo"])\n locks - lock string (default is "cmd:all()")\n help_category - how to organize this help entry in help system\n (default is "General")\n auto_help - defaults to True. Allows for turning off auto-help generation\n arg_regex - (optional) raw string regex defining how the argument part of\n the command should look in order to match for this command\n (e.g. must it be a space between cmdname and arg?)\n auto_help_display_key - (optional) if given, this replaces the string shown\n in the auto-help listing. This is particularly useful for system-commands\n whose actual key is not really meaningful.\n\n (Note that if auto_help is on, this initial string is also used by the\n system to create the help entry for the command, so it\'s a good idea to\n format it similar to this one). This behavior can be changed by\n overriding the method \'get_help\' of a command: by default, this\n method returns cmd.__doc__ (that is, this very docstring, or\n the docstring of your command). You can, however, extend or\n replace this without disabling auto_help.\n '}
    +search_index_entry = {'aliases': '', 'category': 'general', 'key': 'command', 'no_prefix': ' ', 'tags': '', 'text': '\n ## Base command\n\n (you may see this if a child command had no help text defined)\n\n Usage:\n command [args]\n\n This is the base command class. Inherit from this\n to create new commands.\n\n The cmdhandler makes the following variables available to the\n command methods (so you can always assume them to be there):\n\n self.caller - the game object calling the command\n self.cmdstring - the command name used to trigger this command (allows\n you to know which alias was used, for example)\n self.args - everything supplied to the command following the cmdstring\n (this is usually what is parsed in self.parse())\n self.cmdset - the cmdset from which this command was matched (useful only\n seldomly, notably for help-type commands, to create dynamic\n help entries and lists)\n self.obj - the object on which this command is defined. If a default command,\n this is usually the same as caller.\n self.raw_string - the full raw string input, including the command name,\n any args and no parsing.\n\n The following class properties can/should be defined on your child class:\n\n key - identifier for command (e.g. "look")\n aliases - (optional) list of aliases (e.g. ["l", "loo"])\n locks - lock string (default is "cmd:all()")\n help_category - how to organize this help entry in help system\n (default is "General")\n auto_help - defaults to True. Allows for turning off auto-help generation\n arg_regex - (optional) raw string regex defining how the argument part of\n the command should look in order to match for this command\n (e.g. must it be a space between cmdname and arg?)\n auto_help_display_key - (optional) if given, this replaces the string shown\n in the auto-help listing. This is particularly useful for system-commands\n whose actual key is not really meaningful.\n\n (Note that if auto_help is on, this initial string is also used by the\n system to create the help entry for the command, so it\'s a good idea to\n format it similar to this one). This behavior can be changed by\n overriding the method \'get_help\' of a command: by default, this\n method returns cmd.__doc__ (that is, this very docstring, or\n the docstring of your command). You can, however, extend or\n replace this without disabling auto_help.\n '}
    diff --git a/docs/1.0-dev/api/evennia.commands.default.account.html b/docs/1.0-dev/api/evennia.commands.default.account.html index af7a700db7..bad7f25c6e 100644 --- a/docs/1.0-dev/api/evennia.commands.default.account.html +++ b/docs/1.0-dev/api/evennia.commands.default.account.html @@ -131,7 +131,7 @@ method. Otherwise all text will be returned to all connected sessions.

    -aliases = ['ls', 'l']
    +aliases = ['l', 'ls']
    @@ -162,7 +162,7 @@ method. Otherwise all text will be returned to all connected sessions.

    -search_index_entry = {'aliases': 'ls l', 'category': 'general', 'key': 'look', 'no_prefix': ' ls l', 'tags': '', 'text': '\n look while out-of-character\n\n Usage:\n look\n\n Look in the ooc state.\n '}
    +search_index_entry = {'aliases': 'l ls', 'category': 'general', 'key': 'look', 'no_prefix': ' l ls', 'tags': '', 'text': '\n look while out-of-character\n\n Usage:\n look\n\n Look in the ooc state.\n '}
    diff --git a/docs/1.0-dev/api/evennia.commands.default.batchprocess.html b/docs/1.0-dev/api/evennia.commands.default.batchprocess.html index 790dbbf58d..129c09be4a 100644 --- a/docs/1.0-dev/api/evennia.commands.default.batchprocess.html +++ b/docs/1.0-dev/api/evennia.commands.default.batchprocess.html @@ -136,7 +136,7 @@ skipping, reloading etc.

    -aliases = ['batchcommand', 'batchcmd']
    +aliases = ['batchcmd', 'batchcommand']
    @@ -167,7 +167,7 @@ skipping, reloading etc.

    -search_index_entry = {'aliases': 'batchcommand batchcmd', 'category': 'building', 'key': 'batchcommands', 'no_prefix': ' batchcommand batchcmd', 'tags': '', 'text': '\n build from batch-command file\n\n Usage:\n batchcommands[/interactive] <python.path.to.file>\n\n Switch:\n interactive - this mode will offer more control when\n executing the batch file, like stepping,\n skipping, reloading etc.\n\n Runs batches of commands from a batch-cmd text file (*.ev).\n\n '}
    +search_index_entry = {'aliases': 'batchcmd batchcommand', 'category': 'building', 'key': 'batchcommands', 'no_prefix': ' batchcmd batchcommand', 'tags': '', 'text': '\n build from batch-command file\n\n Usage:\n batchcommands[/interactive] <python.path.to.file>\n\n Switch:\n interactive - this mode will offer more control when\n executing the batch file, like stepping,\n skipping, reloading etc.\n\n Runs batches of commands from a batch-cmd text file (*.ev).\n\n '}
    diff --git a/docs/1.0-dev/api/evennia.commands.default.building.html b/docs/1.0-dev/api/evennia.commands.default.building.html index fc2ce0d4cc..bcdb528996 100644 --- a/docs/1.0-dev/api/evennia.commands.default.building.html +++ b/docs/1.0-dev/api/evennia.commands.default.building.html @@ -590,7 +590,7 @@ You can specify the /force switch to bypass this confirmation.

    -aliases = ['@del', '@delete']
    +aliases = ['@delete', '@del']
    @@ -631,7 +631,7 @@ You can specify the /force switch to bypass this confirmation.

    -search_index_entry = {'aliases': '@del @delete', 'category': 'building', 'key': '@destroy', 'no_prefix': 'destroy del delete', 'tags': '', 'text': '\n permanently delete objects\n\n Usage:\n destroy[/switches] [obj, obj2, obj3, [dbref-dbref], ...]\n\n Switches:\n override - The destroy command will usually avoid accidentally\n destroying account objects. This switch overrides this safety.\n force - destroy without confirmation.\n Examples:\n destroy house, roof, door, 44-78\n destroy 5-10, flower, 45\n destroy/force north\n\n Destroys one or many objects. If dbrefs are used, a range to delete can be\n given, e.g. 4-10. Also the end points will be deleted. This command\n displays a confirmation before destroying, to make sure of your choice.\n You can specify the /force switch to bypass this confirmation.\n '}
    +search_index_entry = {'aliases': '@delete @del', 'category': 'building', 'key': '@destroy', 'no_prefix': 'destroy delete del', 'tags': '', 'text': '\n permanently delete objects\n\n Usage:\n destroy[/switches] [obj, obj2, obj3, [dbref-dbref], ...]\n\n Switches:\n override - The destroy command will usually avoid accidentally\n destroying account objects. This switch overrides this safety.\n force - destroy without confirmation.\n Examples:\n destroy house, roof, door, 44-78\n destroy 5-10, flower, 45\n destroy/force north\n\n Destroys one or many objects. If dbrefs are used, a range to delete can be\n given, e.g. 4-10. Also the end points will be deleted. This command\n displays a confirmation before destroying, to make sure of your choice.\n You can specify the /force switch to bypass this confirmation.\n '}
    @@ -1343,7 +1343,7 @@ server settings.

    -aliases = ['@typeclasses', '@type', '@parent', '@update', '@swap']
    +aliases = ['@parent', '@type', '@typeclasses', '@update', '@swap']
    @@ -1374,7 +1374,7 @@ server settings.

    -search_index_entry = {'aliases': '@typeclasses @type @parent @update @swap', 'category': 'building', 'key': '@typeclass', 'no_prefix': 'typeclass typeclasses type parent update swap', 'tags': '', 'text': "\n set or change an object's typeclass\n\n Usage:\n typeclass[/switch] <object> [= typeclass.path]\n typeclass/prototype <object> = prototype_key\n\n typeclasses or typeclass/list/show [typeclass.path]\n swap - this is a shorthand for using /force/reset flags.\n update - this is a shorthand for using the /force/reload flag.\n\n Switch:\n show, examine - display the current typeclass of object (default) or, if\n given a typeclass path, show the docstring of that typeclass.\n update - *only* re-run at_object_creation on this object\n meaning locks or other properties set later may remain.\n reset - clean out *all* the attributes and properties on the\n object - basically making this a new clean object. This will also\n reset cmdsets!\n force - change to the typeclass also if the object\n already has a typeclass of the same name.\n list - show available typeclasses. Only typeclasses in modules actually\n imported or used from somewhere in the code will show up here\n (those typeclasses are still available if you know the path)\n prototype - clean and overwrite the object with the specified\n prototype key - effectively making a whole new object.\n\n Example:\n type button = examples.red_button.RedButton\n type/prototype button=a red button\n\n If the typeclass_path is not given, the current object's typeclass is\n assumed.\n\n View or set an object's typeclass. If setting, the creation hooks of the\n new typeclass will be run on the object. If you have clashing properties on\n the old class, use /reset. By default you are protected from changing to a\n typeclass of the same name as the one you already have - use /force to\n override this protection.\n\n The given typeclass must be identified by its location using python\n dot-notation pointing to the correct module and class. If no typeclass is\n given (or a wrong typeclass is given). Errors in the path or new typeclass\n will lead to the old typeclass being kept. The location of the typeclass\n module is searched from the default typeclass directory, as defined in the\n server settings.\n\n "}
    +search_index_entry = {'aliases': '@parent @type @typeclasses @update @swap', 'category': 'building', 'key': '@typeclass', 'no_prefix': 'typeclass parent type typeclasses update swap', 'tags': '', 'text': "\n set or change an object's typeclass\n\n Usage:\n typeclass[/switch] <object> [= typeclass.path]\n typeclass/prototype <object> = prototype_key\n\n typeclasses or typeclass/list/show [typeclass.path]\n swap - this is a shorthand for using /force/reset flags.\n update - this is a shorthand for using the /force/reload flag.\n\n Switch:\n show, examine - display the current typeclass of object (default) or, if\n given a typeclass path, show the docstring of that typeclass.\n update - *only* re-run at_object_creation on this object\n meaning locks or other properties set later may remain.\n reset - clean out *all* the attributes and properties on the\n object - basically making this a new clean object. This will also\n reset cmdsets!\n force - change to the typeclass also if the object\n already has a typeclass of the same name.\n list - show available typeclasses. Only typeclasses in modules actually\n imported or used from somewhere in the code will show up here\n (those typeclasses are still available if you know the path)\n prototype - clean and overwrite the object with the specified\n prototype key - effectively making a whole new object.\n\n Example:\n type button = examples.red_button.RedButton\n type/prototype button=a red button\n\n If the typeclass_path is not given, the current object's typeclass is\n assumed.\n\n View or set an object's typeclass. If setting, the creation hooks of the\n new typeclass will be run on the object. If you have clashing properties on\n the old class, use /reset. By default you are protected from changing to a\n typeclass of the same name as the one you already have - use /force to\n override this protection.\n\n The given typeclass must be identified by its location using python\n dot-notation pointing to the correct module and class. If no typeclass is\n given (or a wrong typeclass is given). Errors in the path or new typeclass\n will lead to the old typeclass being kept. The location of the typeclass\n module is searched from the default typeclass directory, as defined in the\n server settings.\n\n "}
    @@ -1529,7 +1529,7 @@ If object is not specified, the current location is examined.

    -aliases = ['@exam', '@ex']
    +aliases = ['@ex', '@exam']
    @@ -1797,7 +1797,7 @@ the cases, see the module doc.

    -search_index_entry = {'aliases': '@exam @ex', 'category': 'building', 'key': '@examine', 'no_prefix': 'examine exam ex', 'tags': '', 'text': '\n get detailed information about an object\n\n Usage:\n examine [<object>[/attrname]]\n examine [*<account>[/attrname]]\n\n Switch:\n account - examine an Account (same as adding *)\n object - examine an Object (useful when OOC)\n script - examine a Script\n channel - examine a Channel\n\n The examine command shows detailed game info about an\n object and optionally a specific attribute on it.\n If object is not specified, the current location is examined.\n\n Append a * before the search string to examine an account.\n\n '}
    +search_index_entry = {'aliases': '@ex @exam', 'category': 'building', 'key': '@examine', 'no_prefix': 'examine ex exam', 'tags': '', 'text': '\n get detailed information about an object\n\n Usage:\n examine [<object>[/attrname]]\n examine [*<account>[/attrname]]\n\n Switch:\n account - examine an Account (same as adding *)\n object - examine an Object (useful when OOC)\n script - examine a Script\n channel - examine a Channel\n\n The examine command shows detailed game info about an\n object and optionally a specific attribute on it.\n If object is not specified, the current location is examined.\n\n Append a * before the search string to examine an account.\n\n '}
    diff --git a/docs/1.0-dev/api/evennia.commands.default.general.html b/docs/1.0-dev/api/evennia.commands.default.general.html index 97fd99a720..3369df2e0e 100644 --- a/docs/1.0-dev/api/evennia.commands.default.general.html +++ b/docs/1.0-dev/api/evennia.commands.default.general.html @@ -173,7 +173,7 @@ look *<account&g
    -aliases = ['ls', 'l']
    +aliases = ['l', 'ls']
    @@ -204,7 +204,7 @@ look *<account&g
    -search_index_entry = {'aliases': 'ls l', 'category': 'general', 'key': 'look', 'no_prefix': ' ls l', 'tags': '', 'text': '\n look at location or object\n\n Usage:\n look\n look <obj>\n look *<account>\n\n Observes your location or objects in your vicinity.\n '}
    +search_index_entry = {'aliases': 'l ls', 'category': 'general', 'key': 'look', 'no_prefix': ' l ls', 'tags': '', 'text': '\n look at location or object\n\n Usage:\n look\n look <obj>\n look *<account>\n\n Observes your location or objects in your vicinity.\n '}
    @@ -771,7 +771,7 @@ which permission groups you are a member of.

    -aliases = ['hierarchy', 'groups']
    +aliases = ['groups', 'hierarchy']
    @@ -802,7 +802,7 @@ which permission groups you are a member of.

    -search_index_entry = {'aliases': 'hierarchy groups', 'category': 'general', 'key': 'access', 'no_prefix': ' hierarchy groups', 'tags': '', 'text': '\n show your current game access\n\n Usage:\n access\n\n This command shows you the permission hierarchy and\n which permission groups you are a member of.\n '}
    +search_index_entry = {'aliases': 'groups hierarchy', 'category': 'general', 'key': 'access', 'no_prefix': ' groups hierarchy', 'tags': '', 'text': '\n show your current game access\n\n Usage:\n access\n\n This command shows you the permission hierarchy and\n which permission groups you are a member of.\n '}
    diff --git a/docs/1.0-dev/api/evennia.commands.default.tests.html b/docs/1.0-dev/api/evennia.commands.default.tests.html index 8d7ecb4641..4e80055f34 100644 --- a/docs/1.0-dev/api/evennia.commands.default.tests.html +++ b/docs/1.0-dev/api/evennia.commands.default.tests.html @@ -900,7 +900,7 @@ main test suite started with

    Test the batch processor.

    -red_button = <module 'evennia.contrib.tutorials.red_button.red_button' from '/tmp/tmp9qhx00ov/7d2d8aaa49e8e4b7f4000bef078036b7bd8ed2fd/evennia/contrib/tutorials/red_button/red_button.py'>
    +red_button = <module 'evennia.contrib.tutorials.red_button.red_button' from '/tmp/tmp6bfo0rqt/014c9383612e80a10a57ddaeee1cd3b99ca58606/evennia/contrib/tutorials/red_button/red_button.py'>
    @@ -922,22 +922,23 @@ main test suite started with

    This is the base command class. Inherit from this to create new commands.

    The cmdhandler makes the following variables available to the -command methods (so you can always assume them to be there): -self.caller - the game object calling the command +command methods (so you can always assume them to be there):

    +

    self.caller - the game object calling the command self.cmdstring - the command name used to trigger this command (allows

    you to know which alias was used, for example)

    -
    cmd.args - everything supplied to the command following the cmdstring

    (this is usually what is parsed in self.parse())

    +
    self.args - everything supplied to the command following the cmdstring

    (this is usually what is parsed in self.parse())

    -
    cmd.cmdset - the cmdset from which this command was matched (useful only

    seldomly, notably for help-type commands, to create dynamic +

    self.cmdset - the cmdset from which this command was matched (useful only

    seldomly, notably for help-type commands, to create dynamic help entries and lists)

    -
    cmd.obj - the object on which this command is defined. If a default command,

    this is usually the same as caller.

    +
    self.obj - the object on which this command is defined. If a default command,

    this is usually the same as caller.

    +
    +
    self.raw_string - the full raw string input, including the command name,

    any args and no parsing.

    -

    cmd.rawstring - the full raw string input, including any args and no parsing.

    The following class properties can/should be defined on your child class:

    key - identifier for command (e.g. “look”) aliases - (optional) list of aliases (e.g. [“l”, “loo”]) @@ -1007,7 +1008,7 @@ set in self.parse())

    -search_index_entry = {'aliases': '', 'category': 'general', 'key': 'interrupt', 'no_prefix': ' ', 'tags': '', 'text': '\n ## Base command\n\n (you may see this if a child command had no help text defined)\n\n Usage:\n command [args]\n\n This is the base command class. Inherit from this\n to create new commands.\n\n The cmdhandler makes the following variables available to the\n command methods (so you can always assume them to be there):\n self.caller - the game object calling the command\n self.cmdstring - the command name used to trigger this command (allows\n you to know which alias was used, for example)\n cmd.args - everything supplied to the command following the cmdstring\n (this is usually what is parsed in self.parse())\n cmd.cmdset - the cmdset from which this command was matched (useful only\n seldomly, notably for help-type commands, to create dynamic\n help entries and lists)\n cmd.obj - the object on which this command is defined. If a default command,\n this is usually the same as caller.\n cmd.rawstring - the full raw string input, including any args and no parsing.\n\n The following class properties can/should be defined on your child class:\n\n key - identifier for command (e.g. "look")\n aliases - (optional) list of aliases (e.g. ["l", "loo"])\n locks - lock string (default is "cmd:all()")\n help_category - how to organize this help entry in help system\n (default is "General")\n auto_help - defaults to True. Allows for turning off auto-help generation\n arg_regex - (optional) raw string regex defining how the argument part of\n the command should look in order to match for this command\n (e.g. must it be a space between cmdname and arg?)\n auto_help_display_key - (optional) if given, this replaces the string shown\n in the auto-help listing. This is particularly useful for system-commands\n whose actual key is not really meaningful.\n\n (Note that if auto_help is on, this initial string is also used by the\n system to create the help entry for the command, so it\'s a good idea to\n format it similar to this one). This behavior can be changed by\n overriding the method \'get_help\' of a command: by default, this\n method returns cmd.__doc__ (that is, this very docstring, or\n the docstring of your command). You can, however, extend or\n replace this without disabling auto_help.\n '}
    +search_index_entry = {'aliases': '', 'category': 'general', 'key': 'interrupt', 'no_prefix': ' ', 'tags': '', 'text': '\n ## Base command\n\n (you may see this if a child command had no help text defined)\n\n Usage:\n command [args]\n\n This is the base command class. Inherit from this\n to create new commands.\n\n The cmdhandler makes the following variables available to the\n command methods (so you can always assume them to be there):\n\n self.caller - the game object calling the command\n self.cmdstring - the command name used to trigger this command (allows\n you to know which alias was used, for example)\n self.args - everything supplied to the command following the cmdstring\n (this is usually what is parsed in self.parse())\n self.cmdset - the cmdset from which this command was matched (useful only\n seldomly, notably for help-type commands, to create dynamic\n help entries and lists)\n self.obj - the object on which this command is defined. If a default command,\n this is usually the same as caller.\n self.raw_string - the full raw string input, including the command name,\n any args and no parsing.\n\n The following class properties can/should be defined on your child class:\n\n key - identifier for command (e.g. "look")\n aliases - (optional) list of aliases (e.g. ["l", "loo"])\n locks - lock string (default is "cmd:all()")\n help_category - how to organize this help entry in help system\n (default is "General")\n auto_help - defaults to True. Allows for turning off auto-help generation\n arg_regex - (optional) raw string regex defining how the argument part of\n the command should look in order to match for this command\n (e.g. must it be a space between cmdname and arg?)\n auto_help_display_key - (optional) if given, this replaces the string shown\n in the auto-help listing. This is particularly useful for system-commands\n whose actual key is not really meaningful.\n\n (Note that if auto_help is on, this initial string is also used by the\n system to create the help entry for the command, so it\'s a good idea to\n format it similar to this one). This behavior can be changed by\n overriding the method \'get_help\' of a command: by default, this\n method returns cmd.__doc__ (that is, this very docstring, or\n the docstring of your command). You can, however, extend or\n replace this without disabling auto_help.\n '}
    diff --git a/docs/1.0-dev/api/evennia.commands.default.unloggedin.html b/docs/1.0-dev/api/evennia.commands.default.unloggedin.html index 4dbc4dbec0..1ed25f460b 100644 --- a/docs/1.0-dev/api/evennia.commands.default.unloggedin.html +++ b/docs/1.0-dev/api/evennia.commands.default.unloggedin.html @@ -234,7 +234,7 @@ version is a bit more complicated.

    -aliases = ['qu', 'q']
    +aliases = ['q', 'qu']
    @@ -260,7 +260,7 @@ version is a bit more complicated.

    -search_index_entry = {'aliases': 'qu q', 'category': 'general', 'key': 'quit', 'no_prefix': ' qu q', 'tags': '', 'text': '\n quit when in unlogged-in state\n\n Usage:\n quit\n\n We maintain a different version of the quit command\n here for unconnected accounts for the sake of simplicity. The logged in\n version is a bit more complicated.\n '}
    +search_index_entry = {'aliases': 'q qu', 'category': 'general', 'key': 'quit', 'no_prefix': ' q qu', 'tags': '', 'text': '\n quit when in unlogged-in state\n\n Usage:\n quit\n\n We maintain a different version of the quit command\n here for unconnected accounts for the sake of simplicity. The logged in\n version is a bit more complicated.\n '}
    @@ -333,7 +333,7 @@ for simplicity. It shows a pane of info.

    -aliases = ['?', 'h']
    +aliases = ['h', '?']
    @@ -359,7 +359,7 @@ for simplicity. It shows a pane of info.

    -search_index_entry = {'aliases': '? h', 'category': 'general', 'key': 'help', 'no_prefix': ' ? h', 'tags': '', 'text': '\n get help when in unconnected-in state\n\n Usage:\n help\n\n This is an unconnected version of the help command,\n for simplicity. It shows a pane of info.\n '}
    +search_index_entry = {'aliases': 'h ?', 'category': 'general', 'key': 'help', 'no_prefix': ' h ?', 'tags': '', 'text': '\n get help when in unconnected-in state\n\n Usage:\n help\n\n This is an unconnected version of the help command,\n for simplicity. It shows a pane of info.\n '}
    diff --git a/docs/1.0-dev/api/evennia.contrib.base_systems.email_login.email_login.html b/docs/1.0-dev/api/evennia.contrib.base_systems.email_login.email_login.html index a9ce68c054..49770f9866 100644 --- a/docs/1.0-dev/api/evennia.contrib.base_systems.email_login.email_login.html +++ b/docs/1.0-dev/api/evennia.contrib.base_systems.email_login.email_login.html @@ -244,7 +244,7 @@ version is a bit more complicated.

    -aliases = ['qu', 'q']
    +aliases = ['q', 'qu']
    @@ -270,7 +270,7 @@ version is a bit more complicated.

    -search_index_entry = {'aliases': 'qu q', 'category': 'general', 'key': 'quit', 'no_prefix': ' qu q', 'tags': '', 'text': '\n We maintain a different version of the `quit` command\n here for unconnected accounts for the sake of simplicity. The logged in\n version is a bit more complicated.\n '}
    +search_index_entry = {'aliases': 'q qu', 'category': 'general', 'key': 'quit', 'no_prefix': ' q qu', 'tags': '', 'text': '\n We maintain a different version of the `quit` command\n here for unconnected accounts for the sake of simplicity. The logged in\n version is a bit more complicated.\n '}
    @@ -333,7 +333,7 @@ for simplicity. It shows a pane of info.

    -aliases = ['?', 'h']
    +aliases = ['h', '?']
    @@ -359,7 +359,7 @@ for simplicity. It shows a pane of info.

    -search_index_entry = {'aliases': '? h', 'category': 'general', 'key': 'help', 'no_prefix': ' ? h', 'tags': '', 'text': '\n This is an unconnected version of the help command,\n for simplicity. It shows a pane of info.\n '}
    +search_index_entry = {'aliases': 'h ?', 'category': 'general', 'key': 'help', 'no_prefix': ' h ?', 'tags': '', 'text': '\n This is an unconnected version of the help command,\n for simplicity. It shows a pane of info.\n '}
    diff --git a/docs/1.0-dev/api/evennia.contrib.base_systems.ingame_python.commands.html b/docs/1.0-dev/api/evennia.contrib.base_systems.ingame_python.commands.html index ef6742c570..c37bf9ef5c 100644 --- a/docs/1.0-dev/api/evennia.contrib.base_systems.ingame_python.commands.html +++ b/docs/1.0-dev/api/evennia.contrib.base_systems.ingame_python.commands.html @@ -114,7 +114,7 @@
    -aliases = ['@calls', '@callbacks', '@callback']
    +aliases = ['@callback', '@calls', '@callbacks']
    @@ -195,7 +195,7 @@ on user permission.

    -search_index_entry = {'aliases': '@calls @callbacks @callback', 'category': 'building', 'key': '@call', 'no_prefix': 'call calls callbacks callback', 'tags': '', 'text': '\n Command to edit callbacks.\n '}
    +search_index_entry = {'aliases': '@callback @calls @callbacks', 'category': 'building', 'key': '@call', 'no_prefix': 'call callback calls callbacks', 'tags': '', 'text': '\n Command to edit callbacks.\n '}
    diff --git a/docs/1.0-dev/api/evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.html b/docs/1.0-dev/api/evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.html index 71a557774d..758fdd7995 100644 --- a/docs/1.0-dev/api/evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.html +++ b/docs/1.0-dev/api/evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.html @@ -215,7 +215,7 @@ for that channel.

    -aliases = ['delchanalias', 'delaliaschan']
    +aliases = ['delaliaschan', 'delchanalias']
    @@ -246,7 +246,7 @@ for that channel.

    -search_index_entry = {'aliases': 'delchanalias delaliaschan', 'category': 'comms', 'key': 'delcom', 'no_prefix': ' delchanalias delaliaschan', 'tags': '', 'text': "\n remove a channel alias and/or unsubscribe from channel\n\n Usage:\n delcom <alias or channel>\n delcom/all <channel>\n\n If the full channel name is given, unsubscribe from the\n channel. If an alias is given, remove the alias but don't\n unsubscribe. If the 'all' switch is used, remove all aliases\n for that channel.\n "}
    +search_index_entry = {'aliases': 'delaliaschan delchanalias', 'category': 'comms', 'key': 'delcom', 'no_prefix': ' delaliaschan delchanalias', 'tags': '', 'text': "\n remove a channel alias and/or unsubscribe from channel\n\n Usage:\n delcom <alias or channel>\n delcom/all <channel>\n\n If the full channel name is given, unsubscribe from the\n channel. If an alias is given, remove the alias but don't\n unsubscribe. If the 'all' switch is used, remove all aliases\n for that channel.\n "}
    diff --git a/docs/1.0-dev/api/evennia.contrib.full_systems.evscaperoom.commands.html b/docs/1.0-dev/api/evennia.contrib.full_systems.evscaperoom.commands.html index 16400b0484..58527cfbce 100644 --- a/docs/1.0-dev/api/evennia.contrib.full_systems.evscaperoom.commands.html +++ b/docs/1.0-dev/api/evennia.contrib.full_systems.evscaperoom.commands.html @@ -209,7 +209,7 @@ the operation will be general or on the room.

    -aliases = ['q', 'chicken out', 'abort', 'quit']
    +aliases = ['q', 'quit', 'abort', 'chicken out']
    @@ -233,7 +233,7 @@ set in self.parse())

    -search_index_entry = {'aliases': 'q chicken out abort quit', 'category': 'evscaperoom', 'key': 'give up', 'no_prefix': ' q chicken out abort quit', 'tags': '', 'text': '\n Give up\n\n Usage:\n give up\n\n Abandons your attempts at escaping and of ever winning the pie-eating contest.\n\n '}
    +search_index_entry = {'aliases': 'q quit abort chicken out', 'category': 'evscaperoom', 'key': 'give up', 'no_prefix': ' q quit abort chicken out', 'tags': '', 'text': '\n Give up\n\n Usage:\n give up\n\n Abandons your attempts at escaping and of ever winning the pie-eating contest.\n\n '}
    @@ -254,7 +254,7 @@ set in self.parse())

    -aliases = ['ls', 'l']
    +aliases = ['l', 'ls']
    @@ -288,7 +288,7 @@ set in self.parse())

    -search_index_entry = {'aliases': 'ls l', 'category': 'evscaperoom', 'key': 'look', 'no_prefix': ' ls l', 'tags': '', 'text': '\n Look at the room, an object or the currently focused object\n\n Usage:\n look [obj]\n\n '}
    +search_index_entry = {'aliases': 'l ls', 'category': 'evscaperoom', 'key': 'look', 'no_prefix': ' l ls', 'tags': '', 'text': '\n Look at the room, an object or the currently focused object\n\n Usage:\n look [obj]\n\n '}
    @@ -369,7 +369,7 @@ shout

    -aliases = ['whisper', ';', 'shout']
    +aliases = ['shout', 'whisper', ';']
    @@ -398,7 +398,7 @@ set in self.parse())

    -search_index_entry = {'aliases': 'whisper ; shout', 'category': 'general', 'key': 'say', 'no_prefix': ' whisper ; shout', 'tags': '', 'text': '\n Perform an communication action.\n\n Usage:\n say <text>\n whisper\n shout\n\n '}
    +search_index_entry = {'aliases': 'shout whisper ;', 'category': 'general', 'key': 'say', 'no_prefix': ' shout whisper ;', 'tags': '', 'text': '\n Perform an communication action.\n\n Usage:\n say <text>\n whisper\n shout\n\n '}
    @@ -488,7 +488,7 @@ looks and what actions is available.

    -aliases = ['ex', 'examine', 'unfocus', 'e']
    +aliases = ['e', 'ex', 'unfocus', 'examine']
    @@ -517,7 +517,7 @@ set in self.parse())

    -search_index_entry = {'aliases': 'ex examine unfocus e', 'category': 'evscaperoom', 'key': 'focus', 'no_prefix': ' ex examine unfocus e', 'tags': '', 'text': '\n Focus your attention on a target.\n\n Usage:\n focus <obj>\n\n Once focusing on an object, use look to get more information about how it\n looks and what actions is available.\n\n '}
    +search_index_entry = {'aliases': 'e ex unfocus examine', 'category': 'evscaperoom', 'key': 'focus', 'no_prefix': ' e ex unfocus examine', 'tags': '', 'text': '\n Focus your attention on a target.\n\n Usage:\n focus <obj>\n\n Once focusing on an object, use look to get more information about how it\n looks and what actions is available.\n\n '}
    @@ -579,7 +579,7 @@ set in self.parse())

    -aliases = ['inventory', 'inv', 'i', 'give']
    +aliases = ['inventory', 'inv', 'give', 'i']
    @@ -603,7 +603,7 @@ set in self.parse())

    -search_index_entry = {'aliases': 'inventory inv i give', 'category': 'evscaperoom', 'key': 'get', 'no_prefix': ' inventory inv i give', 'tags': '', 'text': '\n Use focus / examine instead.\n\n '}
    +search_index_entry = {'aliases': 'inventory inv give i', 'category': 'evscaperoom', 'key': 'get', 'no_prefix': ' inventory inv give i', 'tags': '', 'text': '\n Use focus / examine instead.\n\n '}
    diff --git a/docs/1.0-dev/api/evennia.contrib.grid.extended_room.extended_room.html b/docs/1.0-dev/api/evennia.contrib.grid.extended_room.extended_room.html index 4d01868d90..a3e2c01355 100644 --- a/docs/1.0-dev/api/evennia.contrib.grid.extended_room.extended_room.html +++ b/docs/1.0-dev/api/evennia.contrib.grid.extended_room.extended_room.html @@ -338,7 +338,7 @@ look *<account&g
    -aliases = ['ls', 'l']
    +aliases = ['l', 'ls']
    @@ -358,7 +358,7 @@ look *<account&g
    -search_index_entry = {'aliases': 'ls l', 'category': 'general', 'key': 'look', 'no_prefix': ' ls l', 'tags': '', 'text': '\n look\n\n Usage:\n look\n look <obj>\n look <room detail>\n look *<account>\n\n Observes your location, details at your location or objects in your vicinity.\n '}
    +search_index_entry = {'aliases': 'l ls', 'category': 'general', 'key': 'look', 'no_prefix': ' l ls', 'tags': '', 'text': '\n look\n\n Usage:\n look\n look <obj>\n look <room detail>\n look *<account>\n\n Observes your location, details at your location or objects in your vicinity.\n '}
    diff --git a/docs/1.0-dev/api/evennia.contrib.rpg.dice.dice.html b/docs/1.0-dev/api/evennia.contrib.rpg.dice.dice.html index a2ca7e1c6a..3c56f13b4e 100644 --- a/docs/1.0-dev/api/evennia.contrib.rpg.dice.dice.html +++ b/docs/1.0-dev/api/evennia.contrib.rpg.dice.dice.html @@ -303,7 +303,7 @@ everyone but the person rolling.

    -aliases = ['@dice', 'roll']
    +aliases = ['roll', '@dice']
    @@ -329,7 +329,7 @@ everyone but the person rolling.

    -search_index_entry = {'aliases': '@dice roll', 'category': 'general', 'key': 'dice', 'no_prefix': ' dice roll', 'tags': '', 'text': "\n roll dice\n\n Usage:\n dice[/switch] <nr>d<sides> [modifier] [success condition]\n\n Switch:\n hidden - tell the room the roll is being done, but don't show the result\n secret - don't inform the room about neither roll nor result\n\n Examples:\n dice 3d6 + 4\n dice 1d100 - 2 < 50\n\n This will roll the given number of dice with given sides and modifiers.\n So e.g. 2d6 + 3 means to 'roll a 6-sided die 2 times and add the result,\n then add 3 to the total'.\n Accepted modifiers are +, -, * and /.\n A success condition is given as normal Python conditionals\n (<,>,<=,>=,==,!=). So e.g. 2d6 + 3 > 10 means that the roll will succeed\n only if the final result is above 8. If a success condition is given, the\n outcome (pass/fail) will be echoed along with how much it succeeded/failed\n with. The hidden/secret switches will hide all or parts of the roll from\n everyone but the person rolling.\n "}
    +search_index_entry = {'aliases': 'roll @dice', 'category': 'general', 'key': 'dice', 'no_prefix': ' roll dice', 'tags': '', 'text': "\n roll dice\n\n Usage:\n dice[/switch] <nr>d<sides> [modifier] [success condition]\n\n Switch:\n hidden - tell the room the roll is being done, but don't show the result\n secret - don't inform the room about neither roll nor result\n\n Examples:\n dice 3d6 + 4\n dice 1d100 - 2 < 50\n\n This will roll the given number of dice with given sides and modifiers.\n So e.g. 2d6 + 3 means to 'roll a 6-sided die 2 times and add the result,\n then add 3 to the total'.\n Accepted modifiers are +, -, * and /.\n A success condition is given as normal Python conditionals\n (<,>,<=,>=,==,!=). So e.g. 2d6 + 3 > 10 means that the roll will succeed\n only if the final result is above 8. If a success condition is given, the\n outcome (pass/fail) will be echoed along with how much it succeeded/failed\n with. The hidden/secret switches will hide all or parts of the roll from\n everyone but the person rolling.\n "}
    diff --git a/docs/1.0-dev/api/evennia.contrib.rpg.rpsystem.rpsystem.html b/docs/1.0-dev/api/evennia.contrib.rpg.rpsystem.rpsystem.html index 7076c09637..c1b1cf079d 100644 --- a/docs/1.0-dev/api/evennia.contrib.rpg.rpsystem.rpsystem.html +++ b/docs/1.0-dev/api/evennia.contrib.rpg.rpsystem.rpsystem.html @@ -863,7 +863,7 @@ Using the command without arguments will list all current recogs.

    -aliases = ['forget', 'recognize']
    +aliases = ['recognize', 'forget']
    @@ -890,7 +890,7 @@ Using the command without arguments will list all current recogs.

    -search_index_entry = {'aliases': 'forget recognize', 'category': 'general', 'key': 'recog', 'no_prefix': ' forget recognize', 'tags': '', 'text': '\n Recognize another person in the same room.\n\n Usage:\n recog\n recog sdesc as alias\n forget alias\n\n Example:\n recog tall man as Griatch\n forget griatch\n\n This will assign a personal alias for a person, or forget said alias.\n Using the command without arguments will list all current recogs.\n\n '}
    +search_index_entry = {'aliases': 'recognize forget', 'category': 'general', 'key': 'recog', 'no_prefix': ' recognize forget', 'tags': '', 'text': '\n Recognize another person in the same room.\n\n Usage:\n recog\n recog sdesc as alias\n forget alias\n\n Example:\n recog tall man as Griatch\n forget griatch\n\n This will assign a personal alias for a person, or forget said alias.\n Using the command without arguments will list all current recogs.\n\n '}
    diff --git a/docs/1.0-dev/api/evennia.contrib.tutorials.evadventure.commands.html b/docs/1.0-dev/api/evennia.contrib.tutorials.evadventure.commands.html index 8136b80f31..76b56ff5e3 100644 --- a/docs/1.0-dev/api/evennia.contrib.tutorials.evadventure.commands.html +++ b/docs/1.0-dev/api/evennia.contrib.tutorials.evadventure.commands.html @@ -254,7 +254,7 @@ set in self.parse())

    -aliases = ['inv', 'i']
    +aliases = ['i', 'inv']
    @@ -278,7 +278,7 @@ set in self.parse())

    -search_index_entry = {'aliases': 'inv i', 'category': 'general', 'key': 'inventory', 'no_prefix': ' inv i', 'tags': '', 'text': '\n View your inventory\n\n Usage:\n inventory\n\n '}
    +search_index_entry = {'aliases': 'i inv', 'category': 'general', 'key': 'inventory', 'no_prefix': ' i inv', 'tags': '', 'text': '\n View your inventory\n\n Usage:\n inventory\n\n '}
    diff --git a/docs/1.0-dev/api/evennia.contrib.tutorials.red_button.red_button.html b/docs/1.0-dev/api/evennia.contrib.tutorials.red_button.red_button.html index 2f3508cef2..0ba8af70ee 100644 --- a/docs/1.0-dev/api/evennia.contrib.tutorials.red_button.red_button.html +++ b/docs/1.0-dev/api/evennia.contrib.tutorials.red_button.red_button.html @@ -151,7 +151,7 @@ such as when closing the lid and un-blinding a character.

    -aliases = ['press button', 'push', 'press']
    +aliases = ['press', 'press button', 'push']
    @@ -180,7 +180,7 @@ check if the lid is open or closed.

    -search_index_entry = {'aliases': 'press button push press', 'category': 'general', 'key': 'push button', 'no_prefix': ' press button push press', 'tags': '', 'text': '\n Push the red button (lid closed)\n\n Usage:\n push button\n\n '}
    +search_index_entry = {'aliases': 'press press button push', 'category': 'general', 'key': 'push button', 'no_prefix': ' press press button push', 'tags': '', 'text': '\n Push the red button (lid closed)\n\n Usage:\n push button\n\n '}
    @@ -250,7 +250,7 @@ check if the lid is open or closed.

    -aliases = ['break lid', 'smash lid', 'smash']
    +aliases = ['smash', 'break lid', 'smash lid']
    @@ -277,7 +277,7 @@ break.

    -search_index_entry = {'aliases': 'break lid smash lid smash', 'category': 'general', 'key': 'smash glass', 'no_prefix': ' break lid smash lid smash', 'tags': '', 'text': '\n Smash the protective glass.\n\n Usage:\n smash glass\n\n Try to smash the glass of the button.\n\n '}
    +search_index_entry = {'aliases': 'smash break lid smash lid', 'category': 'general', 'key': 'smash glass', 'no_prefix': ' smash break lid smash lid', 'tags': '', 'text': '\n Smash the protective glass.\n\n Usage:\n smash glass\n\n Try to smash the glass of the button.\n\n '}
    @@ -377,7 +377,7 @@ be mutually exclusive.

    -aliases = ['press button', 'push', 'press']
    +aliases = ['press', 'press button', 'push']
    @@ -406,7 +406,7 @@ set in self.parse())

    -search_index_entry = {'aliases': 'press button push press', 'category': 'general', 'key': 'push button', 'no_prefix': ' press button push press', 'tags': '', 'text': '\n Push the red button\n\n Usage:\n push button\n\n '}
    +search_index_entry = {'aliases': 'press press button push', 'category': 'general', 'key': 'push button', 'no_prefix': ' press press button push', 'tags': '', 'text': '\n Push the red button\n\n Usage:\n push button\n\n '}
    @@ -504,7 +504,7 @@ be mutually exclusive.

    -aliases = ['listen', 'examine', 'ex', 'l', 'feel', 'get']
    +aliases = ['ex', 'feel', 'listen', 'examine', 'get', 'l']
    @@ -530,7 +530,7 @@ be mutually exclusive.

    -search_index_entry = {'aliases': 'listen examine ex l feel get', 'category': 'general', 'key': 'look', 'no_prefix': ' listen examine ex l feel get', 'tags': '', 'text': "\n Looking around in darkness\n\n Usage:\n look <obj>\n\n ... not that there's much to see in the dark.\n\n "}
    +search_index_entry = {'aliases': 'ex feel listen examine get l', 'category': 'general', 'key': 'look', 'no_prefix': ' ex feel listen examine get l', 'tags': '', 'text': "\n Looking around in darkness\n\n Usage:\n look <obj>\n\n ... not that there's much to see in the dark.\n\n "}
    diff --git a/docs/1.0-dev/api/evennia.contrib.tutorials.tutorial_world.objects.html b/docs/1.0-dev/api/evennia.contrib.tutorials.tutorial_world.objects.html index bc3492697c..e68877c52a 100644 --- a/docs/1.0-dev/api/evennia.contrib.tutorials.tutorial_world.objects.html +++ b/docs/1.0-dev/api/evennia.contrib.tutorials.tutorial_world.objects.html @@ -554,7 +554,7 @@ shift green root up/down

    -aliases = ['move', 'pull', 'push', 'shiftroot']
    +aliases = ['pull', 'push', 'shiftroot', 'move']
    @@ -590,7 +590,7 @@ yellow/green - horizontal roots

    -search_index_entry = {'aliases': 'move pull push shiftroot', 'category': 'tutorialworld', 'key': 'shift', 'no_prefix': ' move pull push shiftroot', 'tags': '', 'text': '\n Shifts roots around.\n\n Usage:\n shift blue root left/right\n shift red root left/right\n shift yellow root up/down\n shift green root up/down\n\n '}
    +search_index_entry = {'aliases': 'pull push shiftroot move', 'category': 'tutorialworld', 'key': 'shift', 'no_prefix': ' pull push shiftroot move', 'tags': '', 'text': '\n Shifts roots around.\n\n Usage:\n shift blue root left/right\n shift red root left/right\n shift yellow root up/down\n shift green root up/down\n\n '}
    @@ -777,7 +777,7 @@ parry - forgoes your attack but will make you harder to hit on next

    -aliases = ['fight', 'slash', 'bash', 'thrust', 'chop', 'hit', 'defend', 'pierce', 'stab', 'kill', 'parry']
    +aliases = ['chop', 'parry', 'stab', 'pierce', 'slash', 'kill', 'thrust', 'hit', 'bash', 'defend', 'fight']
    @@ -803,7 +803,7 @@ parry - forgoes your attack but will make you harder to hit on next

    -search_index_entry = {'aliases': 'fight slash bash thrust chop hit defend pierce stab kill parry', 'category': 'tutorialworld', 'key': 'attack', 'no_prefix': ' fight slash bash thrust chop hit defend pierce stab kill parry', 'tags': '', 'text': '\n Attack the enemy. Commands:\n\n stab <enemy>\n slash <enemy>\n parry\n\n stab - (thrust) makes a lot of damage but is harder to hit with.\n slash - is easier to land, but does not make as much damage.\n parry - forgoes your attack but will make you harder to hit on next\n enemy attack.\n\n '}
    +search_index_entry = {'aliases': 'chop parry stab pierce slash kill thrust hit bash defend fight', 'category': 'tutorialworld', 'key': 'attack', 'no_prefix': ' chop parry stab pierce slash kill thrust hit bash defend fight', 'tags': '', 'text': '\n Attack the enemy. Commands:\n\n stab <enemy>\n slash <enemy>\n parry\n\n stab - (thrust) makes a lot of damage but is harder to hit with.\n slash - is easier to land, but does not make as much damage.\n parry - forgoes your attack but will make you harder to hit on next\n enemy attack.\n\n '}
    diff --git a/docs/1.0-dev/api/evennia.contrib.tutorials.tutorial_world.rooms.html b/docs/1.0-dev/api/evennia.contrib.tutorials.tutorial_world.rooms.html index 2f3d9ee3c4..cfee7ff4e7 100644 --- a/docs/1.0-dev/api/evennia.contrib.tutorials.tutorial_world.rooms.html +++ b/docs/1.0-dev/api/evennia.contrib.tutorials.tutorial_world.rooms.html @@ -246,7 +246,7 @@ code except for adding in the details.

    -aliases = ['ls', 'l']
    +aliases = ['l', 'ls']
    @@ -261,7 +261,7 @@ code except for adding in the details.

    -search_index_entry = {'aliases': 'ls l', 'category': 'tutorialworld', 'key': 'look', 'no_prefix': ' ls l', 'tags': '', 'text': '\n looks at the room and on details\n\n Usage:\n look <obj>\n look <room detail>\n look *<account>\n\n Observes your location, details at your location or objects\n in your vicinity.\n\n Tutorial: This is a child of the default Look command, that also\n allows us to look at "details" in the room. These details are\n things to examine and offers some extra description without\n actually having to be actual database objects. It uses the\n return_detail() hook on TutorialRooms for this.\n '}
    +search_index_entry = {'aliases': 'l ls', 'category': 'tutorialworld', 'key': 'look', 'no_prefix': ' l ls', 'tags': '', 'text': '\n looks at the room and on details\n\n Usage:\n look <obj>\n look <room detail>\n look *<account>\n\n Observes your location, details at your location or objects\n in your vicinity.\n\n Tutorial: This is a child of the default Look command, that also\n allows us to look at "details" in the room. These details are\n things to examine and offers some extra description without\n actually having to be actual database objects. It uses the\n return_detail() hook on TutorialRooms for this.\n '}
    @@ -814,7 +814,7 @@ if they fall off the bridge.

    -aliases = ['?', 'h']
    +aliases = ['h', '?']
    @@ -840,7 +840,7 @@ if they fall off the bridge.

    -search_index_entry = {'aliases': '? h', 'category': 'tutorial world', 'key': 'help', 'no_prefix': ' ? h', 'tags': '', 'text': '\n Overwritten help command while on the bridge.\n '}
    +search_index_entry = {'aliases': 'h ?', 'category': 'tutorial world', 'key': 'help', 'no_prefix': ' h ?', 'tags': '', 'text': '\n Overwritten help command while on the bridge.\n '}
    @@ -966,7 +966,7 @@ to find something.

    -aliases = ['fiddle', 'feel around', 'search', 'l', 'feel']
    +aliases = ['feel', 'fiddle', 'feel around', 'search', 'l']
    @@ -994,7 +994,7 @@ random chance of eventually finding a light source.

    -search_index_entry = {'aliases': 'fiddle feel around search l feel', 'category': 'tutorialworld', 'key': 'look', 'no_prefix': ' fiddle feel around search l feel', 'tags': '', 'text': '\n Look around in darkness\n\n Usage:\n look\n\n Look around in the darkness, trying\n to find something.\n '}
    +search_index_entry = {'aliases': 'feel fiddle feel around search l', 'category': 'tutorialworld', 'key': 'look', 'no_prefix': ' feel fiddle feel around search l', 'tags': '', 'text': '\n Look around in darkness\n\n Usage:\n look\n\n Look around in the darkness, trying\n to find something.\n '}
    diff --git a/docs/1.0-dev/api/evennia.contrib.utils.git_integration.git_integration.html b/docs/1.0-dev/api/evennia.contrib.utils.git_integration.git_integration.html index 1c68ad0d87..55ef655142 100644 --- a/docs/1.0-dev/api/evennia.contrib.utils.git_integration.git_integration.html +++ b/docs/1.0-dev/api/evennia.contrib.utils.git_integration.git_integration.html @@ -206,7 +206,7 @@ git evennia pull - Pull the latest evennia code.

    -directory = '/tmp/tmp9qhx00ov/7d2d8aaa49e8e4b7f4000bef078036b7bd8ed2fd/evennia'
    +directory = '/tmp/tmp6bfo0rqt/014c9383612e80a10a57ddaeee1cd3b99ca58606/evennia'
    @@ -267,7 +267,7 @@ git pull - Pull the latest code from your current branch.

    -directory = '/tmp/tmp9qhx00ov/7d2d8aaa49e8e4b7f4000bef078036b7bd8ed2fd/evennia/game_template'
    +directory = '/tmp/tmp6bfo0rqt/014c9383612e80a10a57ddaeee1cd3b99ca58606/evennia/game_template'
    diff --git a/docs/1.0-dev/api/evennia.utils.eveditor.html b/docs/1.0-dev/api/evennia.utils.eveditor.html index e1b4d1634c..300a6240cd 100644 --- a/docs/1.0-dev/api/evennia.utils.eveditor.html +++ b/docs/1.0-dev/api/evennia.utils.eveditor.html @@ -334,7 +334,7 @@ indentation.

    -aliases = [':u', ':echo', ':s', ':=', ':r', ':q!', ':p', ':uu', ':q', ':y', ':x', ':i', '::', ':dd', ':DD', ':>', ':', ':f', ':j', ':wq', ':A', ':UU', ':S', ':dw', ':h', ':w', ':fd', ':::', ':fi', ':I', ':<', ':!']
    +aliases = [':>', ':UU', ':uu', ':s', ':q', ':f', ':x', ':=', ':w', ':A', ':fi', ':j', ':DD', ':dd', ':', ':q!', ':wq', ':echo', ':i', ':h', ':u', ':I', ':<', ':dw', ':y', ':!', ':r', ':S', ':::', '::', ':fd', ':p']
    @@ -362,7 +362,7 @@ efficient presentation.

    -search_index_entry = {'aliases': ':u :echo :s := :r :q! :p :uu :q :y :x :i :: :dd :DD :> : :f :j :wq :A :UU :S :dw :h :w :fd ::: :fi :I :< :!', 'category': 'general', 'key': ':editor_command_group', 'no_prefix': ' :u :echo :s := :r :q! :p :uu :q :y :x :i :: :dd :DD :> : :f :j :wq :A :UU :S :dw :h :w :fd ::: :fi :I :< :!', 'tags': '', 'text': '\n Commands for the editor\n '}
    +search_index_entry = {'aliases': ':> :UU :uu :s :q :f :x := :w :A :fi :j :DD :dd : :q! :wq :echo :i :h :u :I :< :dw :y :! :r :S ::: :: :fd :p', 'category': 'general', 'key': ':editor_command_group', 'no_prefix': ' :> :UU :uu :s :q :f :x := :w :A :fi :j :DD :dd : :q! :wq :echo :i :h :u :I :< :dw :y :! :r :S ::: :: :fd :p', 'tags': '', 'text': '\n Commands for the editor\n '}
    diff --git a/docs/1.0-dev/api/evennia.utils.evmenu.html b/docs/1.0-dev/api/evennia.utils.evmenu.html index 945251189d..dd34a5dc83 100644 --- a/docs/1.0-dev/api/evennia.utils.evmenu.html +++ b/docs/1.0-dev/api/evennia.utils.evmenu.html @@ -1009,7 +1009,7 @@ single question.

    -aliases = ['no', 'a', 'n', 'yes', 'y', '__nomatch_command', 'abort']
    +aliases = ['no', 'abort', 'a', 'n', 'y', 'yes', '__nomatch_command']
    @@ -1035,7 +1035,7 @@ single question.

    -search_index_entry = {'aliases': 'no a n yes y __nomatch_command abort', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' no a n yes y __nomatch_command abort', 'tags': '', 'text': '\n Handle a prompt for yes or no. Press [return] for the default choice.\n\n '}
    +search_index_entry = {'aliases': 'no abort a n y yes __nomatch_command', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' no abort a n y yes __nomatch_command', 'tags': '', 'text': '\n Handle a prompt for yes or no. Press [return] for the default choice.\n\n '}
    diff --git a/docs/1.0-dev/api/evennia.utils.evmore.html b/docs/1.0-dev/api/evennia.utils.evmore.html index c7833236e9..b621e2312b 100644 --- a/docs/1.0-dev/api/evennia.utils.evmore.html +++ b/docs/1.0-dev/api/evennia.utils.evmore.html @@ -135,7 +135,7 @@ the caller.msg() construct every time the page is updated.

    -aliases = ['end', 'a', 'p', 'quit', 'n', 'top', 'next', 'e', 'previous', 'abort', 'q', 't']
    +aliases = ['abort', 'e', 'p', 'top', 'a', 'n', 'q', 'previous', 't', 'quit', 'end', 'next']
    @@ -161,7 +161,7 @@ the caller.msg() construct every time the page is updated.

    -search_index_entry = {'aliases': 'end a p quit n top next e previous abort q t', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' end a p quit n top next e previous abort q t', 'tags': '', 'text': '\n Manipulate the text paging. Catch no-input with aliases.\n '}
    +search_index_entry = {'aliases': 'abort e p top a n q previous t quit end next', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' abort e p top a n q previous t quit end next', 'tags': '', 'text': '\n Manipulate the text paging. Catch no-input with aliases.\n '}
    diff --git a/docs/1.0-dev/index.html b/docs/1.0-dev/index.html index c8d4bc26b1..8d9b897ce2 100644 --- a/docs/1.0-dev/index.html +++ b/docs/1.0-dev/index.html @@ -58,7 +58,10 @@

    Table of Contents