From 5177efe129b4788235fcd3bd74001b1620fa79e0 Mon Sep 17 00:00:00 2001 From: Griatch Date: Sun, 12 Jul 2020 18:10:13 +0200 Subject: [PATCH] Fixes to auto-link remapper --- docs/Makefile | 4 +- ...reate_toctree.py => auto_link_remapper.py} | 40 +- docs/source/Coding/Coding-Overview.md | 2 + docs/source/Coding/Flat-API.md | 46 +- docs/source/Components/Command-System.md | 9 + docs/source/Components/Commands.md | 2 +- docs/source/Components/Components-Overview.md | 9 +- .../source/Components/Default-Command-Help.md | 2641 ----------------- docs/source/Concepts/Command-System.md | 9 - docs/source/Concepts/Concepts-Overview.md | 1 + docs/source/Contribs/Static-In-Game-Map.md | 2 +- docs/source/Howto/Howto-Overview.md | 2 + ...ctices.md => Parsing-commands-tutorial.md} | 0 .../Starting/Part1/Building-Quickstart.md | 2 +- .../Part1/Evennia-Library-Overview.md | 2 +- docs/source/conf.py | 4 +- docs/source/toc.md | 39 +- 17 files changed, 74 insertions(+), 2740 deletions(-) rename docs/pylib/{create_toctree.py => auto_link_remapper.py} (89%) create mode 100644 docs/source/Components/Command-System.md delete mode 100644 docs/source/Components/Default-Command-Help.md delete mode 100644 docs/source/Concepts/Command-System.md rename docs/source/Howto/{Parsing-command-arguments,-theory-and-best-practices.md => Parsing-commands-tutorial.md} (100%) diff --git a/docs/Makefile b/docs/Makefile index de813e0401..da08a2887e 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -56,7 +56,7 @@ _multiversion-check-env: _clean_api_index: rm source/api/* -# remove supervluous 'module' and 'package' text from api headers +# remove superfluous 'module' and 'package' text from api headers _reformat_apidoc_headers: for f in source/api/*.rst; do\ perl -pi -e 's/(module|package)$$// if $$. == 1' $$f ;\ @@ -71,7 +71,7 @@ _multiversion-autodoc-index: make _clean_api_index @EVDIR=$(EVDIR) EVGAMEDIR=$(EVGAMEDIR) SPHINX_APIDOC_OPTIONS=$(SPHINXAPIDOCENV) $(SPHINXAPIDOC) $(SPHINXAPIDOCOPTS) -o $(SOURCEDIR)/api/ $(EVDIR) $(SPHINXAPIDOCEXCLUDE) make _reformat_apidoc_headers - git diff-index --quiet HEAD || git commit -a -m "Updated API autodoc index." + -git diff-index --quiet HEAD || git commit -a -m "Updated API autodoc index." _html-build: @EVDIR=$(EVDIR) EVGAMEDIR=$(EVGAMEDIR) $(SPHINXBUILD) $(SPHINXOPTS) "$(SOURCEDIR)" "$(BUILDDIR)/html" diff --git a/docs/pylib/create_toctree.py b/docs/pylib/auto_link_remapper.py similarity index 89% rename from docs/pylib/create_toctree.py rename to docs/pylib/auto_link_remapper.py index ff98f2e767..dd7df35958 100644 --- a/docs/pylib/create_toctree.py +++ b/docs/pylib/auto_link_remapper.py @@ -43,24 +43,25 @@ URL_REMAPS = { "issues": "github:issue", "bug": "github:issue", "bug-report": "github:issue", - "Components/Components-Overview": "Components-Overview", - "Components-Overview": "Components-Overview", - "Concepts/Concepts-Overview": "Concepts-Overview", - "Concepts-Overview": "Concepts-Overview", + "./Default-Command-Help": "api:evennia.commands.default#modules", + "../Components/Default-Command-Help": "api:evennia.commands.default#modules", + "../../../Components/Default-Command-Help": "api:evennia.commands.default#modules", } _USED_REFS = {} _CURRFILE = None -def create_toctree(): +def auto_link_remapper(): """ - Create source/toc.md file + - Auto-Remaps links to fit with the actual document file structure. Requires + all doc files to have a unique name. + - Creates source/toc.md file """ global _CURRFILE - print(" -- Auto-Remapper") + print(" -- Auto-Remapper starting.") def _get_rel_source_ref(path): """Get the path relative the source/ dir""" @@ -135,12 +136,14 @@ def create_toctree(): fname = part[0] if part else fname fname = fname.rsplit(".", 1)[0] fname, *anchor = fname.rsplit("#", 1) - _USED_REFS[fname] = url + + if not _CURRFILE.endswith("toc.md"): + _USED_REFS[fname] = url if _CURRFILE in docref_map and fname in docref_map[_CURRFILE]: cfilename = _CURRFILE.rsplit("/", 1)[-1] urlout = docref_map[_CURRFILE][fname] + ('#' + anchor[0] if anchor else '') - if urlout != url and not _CURRFILE.endswith("toc.md"): + if urlout != url: print(f" {cfilename}: [{txt}]({url}) -> [{txt}]({urlout})") else: urlout = url @@ -166,12 +169,14 @@ def create_toctree(): fname = part[0] if part else fname fname = fname.rsplit(".", 1)[0] fname, *anchor = fname.rsplit("#", 1) - _USED_REFS[fname] = url + + if not _CURRFILE.endswith("toc.md"): + _USED_REFS[fname] = url if _CURRFILE in docref_map and fname in docref_map[_CURRFILE]: cfilename = _CURRFILE.rsplit("/", 1)[-1] urlout = docref_map[_CURRFILE][fname] + ('#' + anchor[0] if anchor else '') - if urlout != url and not _CURRFILE.endswith("toc.md"): + if urlout != url: print(f" {cfilename}: [{txt}]: {url} -> [{txt}]: {urlout}") else: urlout = url @@ -198,6 +203,10 @@ def create_toctree(): if count > 0: print(f" -- Auto-corrected links in {count} documents.") + for (fname, src_url) in sorted(toc_map.items(), key=lambda tup: tup[0]): + if fname not in _USED_REFS: + print(f" ORPHANED DOC: no refs found to {src_url}.md") + # write tocfile with open(_TOC_FILE, "w") as fil: fil.write("# Toc\n") @@ -212,15 +221,16 @@ def create_toctree(): if "Part1/" in ref: continue + if not "/" in ref: + ref = "./" + ref + linkname = ref.replace("-", " ") fil.write(f"\n- [{linkname}]({ref})") # we add a self-reference so the toc itself is also a part of a toctree fil.write("\n\n```toctree::\n :hidden:\n\n toc\n```") - for (fname, src_url) in sorted(toc_map.items(), key=lambda tup: tup[0]): - if fname not in _USED_REFS: - print(f" WARNING: no links found to {fname}.md ({src_url})") + print(" -- Auto-Remapper finished.") if __name__ == "__main__": - create_toctree() + auto_link_remapper() diff --git a/docs/source/Coding/Coding-Overview.md b/docs/source/Coding/Coding-Overview.md index 8e962f484c..96533b2a3d 100644 --- a/docs/source/Coding/Coding-Overview.md +++ b/docs/source/Coding/Coding-Overview.md @@ -18,8 +18,10 @@ to you, but some things may still be useful. ## Coding away +- [Coding Introduction](./Coding-Introduction) - [Ways to Debug](./Debugging) - [Adding unit-tests](./Unit-Testing) +- [Things to remember when importing from evennia](./Flat-API) ## Advanced concepts diff --git a/docs/source/Coding/Flat-API.md b/docs/source/Coding/Flat-API.md index a59f987591..58b22fd6a8 100644 --- a/docs/source/Coding/Flat-API.md +++ b/docs/source/Coding/Flat-API.md @@ -1,47 +1,7 @@ -# Evennia API - - -Evennia makes much of its programming tools available directly from the top-level `evennia` package. -This is often referred to as Evennia's "flat" [Application Programming -Interface](https://en.wikipedia.org/wiki/Application_programming_interface) (API). The flat API -tries to collect and bring the most commonly used resources to the front in a way where everything -is available at a glance (in a flat display), making it a good place to start to learn Evennia. - -> Evennia's flat (and full) API can be perused through the auto-generated [API Library -refence](github:evennia). - -A good, interactive way to explore the flat API is to use [IPython](http://ipython.org/), a more -flexible version of the default Python shell. Inside your virtual environment you can install -IPython simply by - - pip install ipython - -Windows users should also install [PyReadline](http://ipython.org/pyreadline.html): - - pip install pyreadline - -With IPython installed, go to your game directory and run - - evennia shell - -This should give you the IPython shell automatically. Inside IPython -you then do - - import evennia - -Followed by - - evennia. - -That is, write `evennia.` and press the TAB key. What pops up is the contents of the `evennia` top- -level package - in other words [the "flat" API](github:evennia#the-flat-api). - - evennia.DefaultObject? - -Starting to write the name of an API entity and pressing `` will auto-complete the name. Adding -a question mark (`?`) to its name will show you its documentation. Append `??` to get the actual -source code. This way you can quickly explore Evennia and see what is available. +# Things to remember about the flat API +The flat API is a series of 'shortcuts' on the `evennia` main library root (defined in +`evennia/__init__.py`). Its componentas are documented [as part of the auto-documentation](../Evennia-API). ## To remember when importing from `evennia` diff --git a/docs/source/Components/Command-System.md b/docs/source/Components/Command-System.md new file mode 100644 index 0000000000..4a51de737d --- /dev/null +++ b/docs/source/Components/Command-System.md @@ -0,0 +1,9 @@ +# Command System + +- [Commands](./Commands) +- [Command Sets](./Command-Sets) +- [Command Auto-help](./Help-System#command-auto-help-system) + +See also: +- [Default Command Help](api:evennia.commands.default#modules) +- [Adding Command Tutorial](../Howto/Starting/Part1/Adding-Commands) \ No newline at end of file diff --git a/docs/source/Components/Commands.md b/docs/source/Components/Commands.md index 6b53d5d821..81b0b005c9 100644 --- a/docs/source/Components/Commands.md +++ b/docs/source/Components/Commands.md @@ -8,7 +8,7 @@ The basic way for users to communicate with the game is through *Commands*. Thes directly related to the game world such as *look*, *get*, *drop* and so on, or administrative commands such as *examine* or *@dig*. -The [default commands](./Default-Command-Help) coming with Evennia are 'MUX-like' in that they use @ +The [default commands](api:evennia.commands.default#modules) coming with Evennia are 'MUX-like' in that they use @ for admin commands, support things like switches, syntax with the '=' symbol etc, but there is nothing that prevents you from implementing a completely different command scheme for your game. You can find the default commands in `evennia/commands/default`. You should not edit these directly - diff --git a/docs/source/Components/Components-Overview.md b/docs/source/Components/Components-Overview.md index 1a00a8acf7..8bee47ba6a 100644 --- a/docs/source/Components/Components-Overview.md +++ b/docs/source/Components/Components-Overview.md @@ -20,10 +20,11 @@ than, the doc-strings of each component in the [API](../Evennia-API). ## Commands -- [Commands](./Commands) -- [Command-Sets](./Command-Sets) -- [The Connection Screen](./Connection-Screen) -- [Available default Commands](./Default-Command-Help) +- [Command system](./Command-System) + - [Commands](./Commands) + - [Command-Sets](./Command-Sets) + - [The Connection Screen](./Connection-Screen) + - [Available default Commands](api:evennia.commands.default#modules) - [Batch-Processors](./Batch-Processors) - [Batch-Code-Processor](./Batch-Code-Processor) - [Batch-Command-Processor](./Batch-Command-Processor) diff --git a/docs/source/Components/Default-Command-Help.md b/docs/source/Components/Default-Command-Help.md deleted file mode 100644 index b783741d68..0000000000 --- a/docs/source/Components/Default-Command-Help.md +++ /dev/null @@ -1,2641 +0,0 @@ -# Default Command Help - - -> *This page is auto-generated. Do not modify - your changes will be lost. Report problems to the -[issue tracker](https://github.com/evennia/evennia/issues).* - -The full set of default Evennia commands currently contains 92 commands in 9 source -files. Our policy for adding default commands is outlined [here](../Concepts/Using-MUX-as-a-Standard). More -information about how commands work can be found in the documentation for [Commands](./Commands). - - - -## A-Z - -- [`__unloggedin_look_command`](https://github.com/evennia/evennia/wiki/Default-Command- -Help#wiki-`--unloggedin-look-command`-cmdunconnectedlook) - look when in unlogged-in state -- [about](./Default-Command-Help#wiki-about-cmdabout) - show Evennia info -- [access](./Default-Command-Help#wiki-access-cmdaccess) - show your current game access -- [addcom](./Default-Command-Help#wiki-addcom-cmdaddcom) - add a channel alias and/or subscribe to a -channel -- [alias](./Default-Command-Help#wiki-alias-cmdsetobjalias) - adding permanent aliases for object -- [allcom](./Default-Command-Help#wiki-allcom-cmdallcom) - perform admin operations on all channels -- [ban](./Default-Command-Help#wiki-ban-cmdban) - ban an account from the server -- [batchcode](./Default-Command-Help#wiki-batchcode-cmdbatchcode) - build from batch-code file -- [batchcommands](./Default-Command-Help#wiki-batchcommands-cmdbatchcommands) - build from batch- -command file -- [boot](./Default-Command-Help#wiki-boot-cmdboot) - kick an account from the server. -- [cboot](./Default-Command-Help#wiki-cboot-cmdcboot) - kick an account from a channel you control -- [ccreate](./Default-Command-Help#wiki-ccreate-cmdchannelcreate) - create a new channel -- [cdesc](./Default-Command-Help#wiki-cdesc-cmdcdesc) - describe a channel you control -- [cdestroy](./Default-Command-Help#wiki-cdestroy-cmdcdestroy) - destroy a channel you created -- [cemit](./Default-Command-Help#wiki-cemit-cmdcemit) - send an admin message to a channel you control -- [channels](./Default-Command-Help#wiki-channels-cmdchannels) - list all channels available to you -- [charcreate](./Default-Command-Help#wiki-charcreate-cmdcharcreate) - create a new character -- [chardelete](./Default-Command-Help#wiki-chardelete-cmdchardelete) - delete a character - this -cannot be undone! -- [clock](./Default-Command-Help#wiki-clock-cmdclock) - change channel locks of a channel you control -- [cmdsets](./Default-Command-Help#wiki-cmdsets-cmdlistcmdsets) - list command sets defined on an -object -- [color](./Default-Command-Help#wiki-color-cmdcolortest) - testing which colors your client support -- [command](./Default-Command-Help#wiki-command-objmanipcommand) - This is a parent class for some of -the defining objmanip commands -- [connect](./Default-Command-Help#wiki-connect-cmdunconnectedconnect) - connect to the game -- [copy](./Default-Command-Help#wiki-copy-cmdcopy) - copy an object and its properties -- [cpattr](./Default-Command-Help#wiki-cpattr-cmdcpattr) - copy attributes between objects -- [create](./Default-Command-Help#wiki-create-cmdunconnectedcreate) - create a new account account -- [create](./Default-Command-Help#wiki-create-cmdcreate) - create new objects -- [cwho](./Default-Command-Help#wiki-cwho-cmdcwho) - show who is listening to a channel -- [delcom](./Default-Command-Help#wiki-delcom-cmddelcom) - remove a channel alias and/or unsubscribe -from channel -- [desc](./Default-Command-Help#wiki-desc-cmddesc) - describe an object or the current room. -- [destroy](./Default-Command-Help#wiki-destroy-cmddestroy) - permanently delete objects -- [dig](./Default-Command-Help#wiki-dig-cmddig) - build new rooms and connect them to the current -location -- [drop](./Default-Command-Help#wiki-drop-cmddrop) - drop something -- [emit](./Default-Command-Help#wiki-emit-cmdemit) - admin command for emitting message to multiple -objects -- [examine](./Default-Command-Help#wiki-examine-cmdexamine) - get detailed information about an object -- [find](./Default-Command-Help#wiki-find-cmdfind) - search the database for objects -- [force](./Default-Command-Help#wiki-force-cmdforce) - forces an object to execute a command -- [get](./Default-Command-Help#wiki-get-cmdget) - pick up something -- [give](./Default-Command-Help#wiki-give-cmdgive) - give away something to someone -- [help](./Default-Command-Help#wiki-help-cmdunconnectedhelp) - get help when in unconnected-in state -- [help](./Default-Command-Help#wiki-help-cmdhelp) - View help or a list of topics -- [home](./Default-Command-Help#wiki-home-cmdhome) - move to your character's home location -- [ic](./Default-Command-Help#wiki-ic-cmdic) - control an object you have permission to puppet -- [inventory](./Default-Command-Help#wiki-inventory-cmdinventory) - view inventory -- [irc2chan](./Default-Command-Help#wiki-irc2chan-cmdirc2chan) - Link an evennia channel to an -external IRC channel -- [link](./Default-Command-Help#wiki-link-cmdlink) - link existing rooms together with exits -- [lock](./Default-Command-Help#wiki-lock-cmdlock) - assign a lock definition to an object -- [look](./Default-Command-Help#wiki-look-cmdlook) - look at location or object -- [look](./Default-Command-Help#wiki-look-cmdooclook) - look while out-of-character -- [mvattr](./Default-Command-Help#wiki-mvattr-cmdmvattr) - move attributes between objects -- [name](./Default-Command-Help#wiki-name-cmdname) - change the name and/or aliases of an object -- [nick](./Default-Command-Help#wiki-nick-cmdnick) - define a personal alias/nick by defining a string -to -- [objects](./Default-Command-Help#wiki-objects-cmdobjects) - statistics on objects in the database -- [ooc](./Default-Command-Help#wiki-ooc-cmdooc) - stop puppeting and go ooc -- [open](./Default-Command-Help#wiki-open-cmdopen) - open a new exit from the current room -- [option](./Default-Command-Help#wiki-option-cmdoption) - Set an account option -- [page](./Default-Command-Help#wiki-page-cmdpage) - send a private message to another account -- [password](./Default-Command-Help#wiki-password-cmdpassword) - change your password -- [perm](./Default-Command-Help#wiki-perm-cmdperm) - set the permissions of an account/object -- [pose](./Default-Command-Help#wiki-pose-cmdpose) - strike a pose -- [py](./Default-Command-Help#wiki-py-cmdpy) - execute a snippet of python code -- [quell](./Default-Command-Help#wiki-quell-cmdquell) - use character's permissions instead of -account's -- [quit](./Default-Command-Help#wiki-quit-cmdunconnectedquit) - quit when in unlogged-in state -- [quit](./Default-Command-Help#wiki-quit-cmdquit) - quit the game -- [reload](./Default-Command-Help#wiki-reload-cmdreload) - reload the server -- [reset](./Default-Command-Help#wiki-reset-cmdreset) - reset and reboot the server -- [rss2chan](./Default-Command-Help#wiki-rss2chan-cmdrss2chan) - link an evennia channel to an -external RSS feed -- [say](./Default-Command-Help#wiki-say-cmdsay) - speak as your character -- [script](./Default-Command-Help#wiki-script-cmdscript) - attach a script to an object -- [scripts](./Default-Command-Help#wiki-scripts-cmdscripts) - list and manage all running scripts -- [server](./Default-Command-Help#wiki-server-cmdserverload) - show server load and memory statistics -- [service](./Default-Command-Help#wiki-service-cmdservice) - manage system services -- [sessions](./Default-Command-Help#wiki-sessions-cmdsessions) - check your connected session(s) -- [set](./Default-Command-Help#wiki-set-cmdsetattribute) - set attribute on an object or account -- [setdesc](./Default-Command-Help#wiki-setdesc-cmdsetdesc) - describe yourself -- [sethelp](./Default-Command-Help#wiki-sethelp-cmdsethelp) - Edit the help database. -- [sethome](./Default-Command-Help#wiki-sethome-cmdsethome) - set an object's home location -- [shutdown](./Default-Command-Help#wiki-shutdown-cmdshutdown) - stop the server completely -- [spawn](./Default-Command-Help#wiki-spawn-cmdspawn) - spawn objects from prototype -- [style](./Default-Command-Help#wiki-style-cmdstyle) - In-game style options -- [tag](./Default-Command-Help#wiki-tag-cmdtag) - handles the tags of an object -- [tel](./Default-Command-Help#wiki-tel-cmdteleport) - teleport object to another location -- [time](./Default-Command-Help#wiki-time-cmdtime) - show server time statistics -- [tunnel](./Default-Command-Help#wiki-tunnel-cmdtunnel) - create new rooms in cardinal directions -only -- [typeclass](./Default-Command-Help#wiki-typeclass-cmdtypeclass) - set or change an object's -typeclass -- [unban](./Default-Command-Help#wiki-unban-cmdunban) - remove a ban from an account -- [unlink](./Default-Command-Help#wiki-unlink-cmdunlink) - remove exit-connections between rooms -- [userpassword](./Default-Command-Help#wiki-userpassword-cmdnewpassword) - change the password of an -account -- [wall](./Default-Command-Help#wiki-wall-cmdwall) - make an announcement to all -- [whisper](./Default-Command-Help#wiki-whisper-cmdwhisper) - Speak privately as your character to -another -- [who](./Default-Command-Help#wiki-who-cmdwho) - list who is currently online -- [wipe](./Default-Command-Help#wiki-wipe-cmdwipe) - clear all attributes from an object - -## A-Z by source file - -- [account.py](./Default-Command-Help#accountpy) -- [admin.py](./Default-Command-Help#adminpy) -- [batchprocess.py](./Default-Command-Help#batchprocesspy) -- [building.py](./Default-Command-Help#buildingpy) -- [comms.py](./Default-Command-Help#commspy) -- [general.py](./Default-Command-Help#generalpy) -- [help.py](./Default-Command-Help#helppy) -- [system.py](./Default-Command-Help#systempy) -- [unloggedin.py](./Default-Command-Help#unloggedinpy) - -## Command details - -These are generated from the auto-documentation and are ordered by their source file location in -[evennia/commands/default/](https://github.com/evennia/evennia/tree/master/evennia/commands/default/) - - -### `account.py` - -[View account.py -source](https://github.com/evennia/evennia/tree/master/evennia/commands/default/account.py) - - -#### charcreate (CmdCharCreate) -``` - create a new character - - Usage: - charcreate [= desc] - - Create a new character, optionally giving it a description. You - may use upper-case letters in the name - you will nevertheless - always be able to access your character using lower-case letters - if you want. -``` -- **key:** *charcreate* -- **aliases:** -- **[locks](./Locks):** *"cmd:pperm(Player)"* -- **[`help_category`](./Help-System):** *"General"* -- **Source:** class `CmdCharCreate` in -[account.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/account.py). -Belongs to command set *'DefaultAccount'* of class `AccountCmdSet` in -[cmdset_account.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py). - - -#### chardelete (CmdCharDelete) -``` - delete a character - this cannot be undone! - - Usage: - chardelete - - Permanently deletes one of your characters. -``` -- **key:** *chardelete* -- **aliases:** -- **[locks](./Locks):** *"cmd:pperm(Player)"* -- **[`help_category`](./Help-System):** *"General"* -- **Source:** class `CmdCharDelete` in -[account.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/account.py). -Belongs to command set *'DefaultAccount'* of class `AccountCmdSet` in -[cmdset_account.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py). - - -#### color (CmdColorTest) -``` - testing which colors your client support - - Usage: - color ansi||xterm256 - - Prints a color map along with in-mud color codes to use to produce - them. It also tests what is supported in your client. Choices are - 16-color ansi (supported in most muds) or the 256-color xterm256 - standard. No checking is done to determine your client supports - color - if not you will see rubbish appear. -``` -- **key:** *color* -- **aliases:** -- **[locks](./Locks):** *"cmd:all()"* -- **[`help_category`](./Help-System):** *"General"* -- **Source:** class `CmdColorTest` in -[account.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/account.py). -Belongs to command set *'DefaultAccount'* of class `AccountCmdSet` in -[cmdset_account.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py). - - -#### ic (CmdIC) -``` - control an object you have permission to puppet - - Usage: - ic - - Go in-character (IC) as a given Character. - - This will attempt to "become" a different object assuming you have - the right to do so. Note that it's the ACCOUNT character that puppets - characters/objects and which needs to have the correct permission! - - You cannot become an object that is already controlled by another - account. In principle can be any in-game object as long - as you the account have access right to puppet it. -``` -- **key:** *ic* -- **aliases:** *puppet* -- **[locks](./Locks):** *"cmd:all()"* -- **[`help_category`](./Help-System):** *"General"* -- **Source:** class `CmdIC` in -[account.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/account.py). -Belongs to command set *'DefaultAccount'* of class `AccountCmdSet` in -[cmdset_account.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py). - - -#### look (CmdOOCLook) -``` - look while out-of-character - - Usage: - look - - Look in the ooc state. -``` -- **key:** *look* -- **aliases:** *l*, *ls* -- **[locks](./Locks):** *"cmd:all()"* -- **[`help_category`](./Help-System):** *"General"* -- **Source:** class `CmdOOCLook` in -[account.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/account.py). -Belongs to command set *'DefaultAccount'* of class `AccountCmdSet` in -[cmdset_account.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py). - - -#### ooc (CmdOOC) -``` - stop puppeting and go ooc - - Usage: - ooc - - Go out-of-character (OOC). - - This will leave your current character and put you in a incorporeal OOC state. -``` -- **key:** *ooc* -- **aliases:** *unpuppet* -- **[locks](./Locks):** *"cmd:pperm(Player)"* -- **[`help_category`](./Help-System):** *"General"* -- **Source:** class `CmdOOC` in -[account.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/account.py). -Belongs to command set *'DefaultAccount'* of class `AccountCmdSet` in -[cmdset_account.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py). - - -#### option (CmdOption) -``` - Set an account option - - Usage: - option[/save] [name = value] - - Switches: - save - Save the current option settings for future logins. - clear - Clear the saved options. - - This command allows for viewing and setting client interface - settings. Note that saved options may not be able to be used if - later connecting with a client with different capabilities. -``` -- **key:** *option* -- **aliases:** *options* -- **[locks](./Locks):** *"cmd:all()"* -- **[`help_category`](./Help-System):** *"General"* -- **Source:** class `CmdOption` in -[account.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/account.py). -Belongs to command set *'DefaultAccount'* of class `AccountCmdSet` in -[cmdset_account.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py). - - -#### password (CmdPassword) -``` - change your password - - Usage: - password = - - Changes your password. Make sure to pick a safe one. -``` -- **key:** *password* -- **aliases:** -- **[locks](./Locks):** *"cmd:pperm(Player)"* -- **[`help_category`](./Help-System):** *"General"* -- **Source:** class `CmdPassword` in -[account.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/account.py). -Belongs to command set *'DefaultAccount'* of class `AccountCmdSet` in -[cmdset_account.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py). - - -#### quell (CmdQuell) -``` - use character's permissions instead of account's - - Usage: - quell - unquell - - Normally the permission level of the Account is used when puppeting a - Character/Object to determine access. This command will switch the lock - system to make use of the puppeted Object's permissions instead. This is - useful mainly for testing. - Hierarchical permission quelling only work downwards, thus an Account cannot - use a higher-permission Character to escalate their permission level. - Use the unquell command to revert back to normal operation. -``` -- **key:** *quell* -- **aliases:** *unquell* -- **[locks](./Locks):** *"cmd:pperm(Player)"* -- **[`help_category`](./Help-System):** *"General"* -- **Source:** class `CmdQuell` in -[account.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/account.py). -Belongs to command set *'DefaultAccount'* of class `AccountCmdSet` in -[cmdset_account.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py). - - -#### quit (CmdQuit) -``` - quit the game - - Usage: - quit - - Switch: - all - disconnect all connected sessions - - Gracefully disconnect your current session from the - game. Use the /all switch to disconnect from all sessions. -``` -- **key:** *quit* -- **aliases:** -- **[locks](./Locks):** *"cmd:all()"* -- **[`help_category`](./Help-System):** *"General"* -- **Source:** class `CmdQuit` in -[account.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/account.py). -Belongs to command set *'DefaultAccount'* of class `AccountCmdSet` in -[cmdset_account.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py). - - -#### sessions (CmdSessions) -``` - check your connected session(s) - - Usage: - sessions - - Lists the sessions currently connected to your account. -``` -- **key:** *sessions* -- **aliases:** -- **[locks](./Locks):** *"cmd:all()"* -- **[`help_category`](./Help-System):** *"General"* -- **Source:** class `CmdSessions` in -[account.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/account.py). -Belongs to command set *'DefaultSession'* of class `SessionCmdSet` in -[cmdset_session.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_session.py). - - -#### style (CmdStyle) -``` - In-game style options - - Usage: - style - style