Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-16 21:06:30 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fix some broken master-doc pages

Browse source
This commit is contained in:
Griatch 2021-06-13 22:02:18 +02:00
parent a352abc1c4
commit 95a2b18d43
29 changed files with 236 additions and 502 deletions
Download patch file Download diff file Expand all files Collapse all files

5
docs/source/Add-a-simple-new-web-page.md
View file

@ -69,14 +69,13 @@ If you'd rather not take advantage of Evennia's base styles, you can do somethin
</html>
```
### The URL
When you enter the address `http://localhost:4001/story` in your web browser, Django will parse that
field to figure out which page you want to go to. You tell it which patterns are relevant in the
file
[mygame/web/urls.py](https://github.com/evennia/evennia/blob/master/evennia/game_template/web/urls.p
y).
[mygame/web/urls.py](https://github.com/evennia/evennia/blob/master/evennia/game_template/web/urls.py).
Open it now.
Django looks for the variable `urlpatterns` in this file. You want to add your new pattern to the

13
docs/source/Async-Process.md
View file

@ -98,16 +98,16 @@ An example of making an asynchronous call from inside a [Command](./Commands) de
class CmdAsync(Command):
key = "asynccommand"
def func(self):
def long_running_function():
#[... lots of time-consuming code ...]
return final_value
def at_return_function(r):
self.caller.msg("The final value is %s" % r)
def at_err_function(e):
self.caller.msg("There was an error: %s" % e)
@ -150,8 +150,7 @@ Wait 10 seconds and 'Test!' should be echoed back to you.
## The @interactive decorator
As of Evennia 0.9, the `@interactive` [decorator](https://realpython.com/primer-on-python-
decorators/)
As of Evennia 0.9, the `@interactive` [decorator](https://realpython.com/primer-on-python-decorators/)
is available. This makes any function or method possible to 'pause' and/or await player input
in an interactive way.
@ -160,7 +159,7 @@ in an interactive way.
@interactive
def myfunc(caller):
while True:
caller.msg("Getting ready to wait ...")
yield(5)

3
docs/source/Attributes.md
View file

@ -237,8 +237,7 @@ entities you can loop over in a for-loop. Attribute-saving supports the followin
* [Dicts](https://docs.python.org/2/tutorial/datastructures.html#dictionaries), like `{1:2,
"test":<dbobj>]`.
* [Sets](https://docs.python.org/2/tutorial/datastructures.html#sets), like `{1,2,"test",<dbobj>}`.
* [collections.OrderedDict](https://docs.python.org/2/library/collections.html#collections.OrderedDi
ct), like `OrderedDict((1,2), ("test", <dbobj>))`.
* [collections.OrderedDict](https://docs.python.org/2/library/collections.html#collections.OrderedDict), like `OrderedDict((1,2), ("test", <dbobj>))`.
* [collections.Deque](https://docs.python.org/2/library/collections.html#collections.deque), like
`deque((1,2,"test",<dbobj>))`.
* *Nestings* of any combinations of the above, like lists in dicts or an OrderedDict of tuples, each

3
docs/source/Bootstrap-&-Evennia.md
View file

@ -97,5 +97,4 @@ docs](https://getbootstrap.com/docs/4.0/layout/grid/)
## More Bootstrap
Bootstrap also provides a huge amount of utilities, as well as styling and content elements. To
learn more about them, please [read the Bootstrap docs](https://getbootstrap.com/docs/4.0/getting-
started/introduction/) or read one of our other web tutorials.
learn more about them, please [read the Bootstrap docs](https://getbootstrap.com/docs/4.0/getting-started/introduction/) or read one of our other web tutorials.

9
docs/source/Coordinates.md
View file

@ -51,7 +51,7 @@ class Room(DefaultRoom):
See examples/object.py for a list of
properties and methods available on all Objects.
"""
@property
def x(self):
"""Return the X coordinate or None."""
@ -72,7 +72,7 @@ class Room(DefaultRoom):
"""Return the Y coordinate or None."""
y = self.tags.get(category="coordy")
return int(y) if isinstance(y, str) else None
@y.setter
def y(self, y):
"""Change the Y coordinate."""
@ -87,7 +87,7 @@ class Room(DefaultRoom):
"""Return the Z coordinate or None."""
z = self.tags.get(category="coordz")
return int(z) if isinstance(z, str) else None
@z.setter
def z(self, z):
"""Change the Z coordinate."""
@ -99,8 +99,7 @@ class Room(DefaultRoom):
```
If you aren't familiar with the concept of properties in Python, I encourage you to read a good
tutorial on the subject. [This article on Python properties](https://www.programiz.com/python-
programming/property)
tutorial on the subject. [This article on Python properties](https://www.programiz.com/python-programming/property)
is well-explained and should help you understand the idea.
Let's look at our properties for `x`. First of all is the read property.

3
docs/source/Customize-channels.md
View file

@ -480,5 +480,4 @@ close from the code I've provided here. Notice, however, that this resource is
external to Evennia and not maintained by anyone but the original author of
this article.
[Read the full example on Github](https://github.com/vincent-
lg/avenew/blob/master/commands/comms.py)
[Read the full example on Github](https://github.com/vincent-lg/avenew/blob/master/commands/comms.py)

315
docs/source/Default-Command-Help.md
View file

@ -12,8 +12,7 @@ information about how commands work can be found in the documentation for [Comma
## 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
- [`__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
@ -137,14 +136,12 @@ another
## 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/
)
[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)
[View account.py source](https://github.com/evennia/evennia/tree/master/evennia/commands/default/account.py)
#### charcreate (CmdCharCreate)
@ -165,8 +162,7 @@ source](https://github.com/evennia/evennia/tree/master/evennia/commands/default/
- **[`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://gi
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_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)
@ -184,8 +180,7 @@ thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py)
- **[`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://gi
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_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)
@ -207,8 +202,7 @@ thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py)
- **[`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://gi
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_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)
@ -234,8 +228,7 @@ thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py)
- **[`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://gi
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_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)
@ -253,8 +246,7 @@ thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py)
- **[`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://gi
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_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)
@ -274,8 +266,7 @@ thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py)
- **[`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://gi
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_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)
@ -299,8 +290,7 @@ thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py)
- **[`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://gi
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_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)
@ -318,8 +308,7 @@ thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py)
- **[`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://gi
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_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)
@ -386,8 +375,7 @@ thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py)
- **[`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://gi
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_session.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)
@ -407,8 +395,7 @@ thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_session.py)
- **[`help_category`](./Help-System):** *"General"*
- **Source:** class `CmdStyle` 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://gi
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_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).
#### who (CmdWho)
@ -428,14 +415,12 @@ thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py)
- **[`help_category`](./Help-System):** *"General"*
- **Source:** class `CmdWho` 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://gi
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_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).
### `admin.py`
[View admin.py
source](https://github.com/evennia/evennia/tree/master/evennia/commands/default/admin.py)
[View admin.py source](https://github.com/evennia/evennia/tree/master/evennia/commands/default/admin.py)
#### ban (CmdBan)
@ -476,8 +461,7 @@ source](https://github.com/evennia/evennia/tree/master/evennia/commands/default/
- **[`help_category`](./Help-System):** *"Admin"*
- **Source:** class `CmdBan` in
[admin.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/admin.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### boot (CmdBoot)
@ -500,8 +484,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"Admin"*
- **Source:** class `CmdBoot` in
[admin.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/admin.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### emit (CmdEmit)
@ -530,8 +513,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"Admin"*
- **Source:** class `CmdEmit` in
[admin.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/admin.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### force (CmdForce)
@ -550,8 +532,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"Building"*
- **Source:** class `CmdForce` in
[admin.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/admin.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### perm (CmdPerm)
@ -575,8 +556,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"Admin"*
- **Source:** class `CmdPerm` in
[admin.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/admin.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### unban (CmdUnban)
@ -597,8 +577,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"Admin"*
- **Source:** class `CmdUnban` in
[admin.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/admin.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### userpassword (CmdNewPassword)
@ -616,8 +595,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"Admin"*
- **Source:** class `CmdNewPassword` in
[admin.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/admin.py).
Belongs to command set *'DefaultAccount'* of class `AccountCmdSet` in [cmdset_account.py](https://gi
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_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).
#### wall (CmdWall)
@ -636,14 +614,12 @@ thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py)
- **[`help_category`](./Help-System):** *"Admin"*
- **Source:** class `CmdWall` in
[admin.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/admin.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
### `batchprocess.py`
[View batchprocess.py
source](https://github.com/evennia/evennia/tree/master/evennia/commands/default/batchprocess.py)
[View batchprocess.py source](https://github.com/evennia/evennia/tree/master/evennia/commands/default/batchprocess.py)
#### batchcode (CmdBatchCode)
@ -668,10 +644,8 @@ source](https://github.com/evennia/evennia/tree/master/evennia/commands/default/
- **aliases:** *batchcodes*
- **[locks](./Locks):** *"cmd:superuser()"*
- **[`help_category`](./Help-System):** *"Building"*
- **Source:** class `CmdBatchCode` in [batchprocess.py](https://github.com/evennia/evennia/tree/mast
er/evennia/commands/default/batchprocess.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
- **Source:** class `CmdBatchCode` in [batchprocess.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/batchprocess.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### batchcommands (CmdBatchCommands)
@ -692,16 +666,13 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **aliases:** *batchcmd*, *batchcommand*
- **[locks](./Locks):** *"cmd:perm(batchcommands) or perm(Developer)"*
- **[`help_category`](./Help-System):** *"Building"*
- **Source:** class `CmdBatchCommands` in [batchprocess.py](https://github.com/evennia/evennia/tree/
master/evennia/commands/default/batchprocess.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
- **Source:** class `CmdBatchCommands` in [batchprocess.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/batchprocess.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
### `building.py`
[View building.py
source](https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py)
[View building.py source](https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py)
#### alias (CmdSetObjAlias)
@ -732,8 +703,7 @@ source](https://github.com/evennia/evennia/tree/master/evennia/commands/default/
- **[`help_category`](./Help-System):** *"Building"*
- **Source:** class `CmdSetObjAlias` in
[building.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### cmdsets (CmdListCmdSets)
@ -752,8 +722,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"Building"*
- **Source:** class `CmdListCmdSets` in
[building.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### command (ObjManipCommand)
@ -807,8 +776,7 @@ Belongs to command set *'<Unknown>'* of class `<Unknown>` in
- **[`help_category`](./Help-System):** *"Building"*
- **Source:** class `CmdCopy` in
[building.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### cpattr (CmdCpAttr)
@ -839,8 +807,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"Building"*
- **Source:** class `CmdCpAttr` in
[building.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### create (CmdCreate)
@ -871,8 +838,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"Building"*
- **Source:** class `CmdCreate` in
[building.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### desc (CmdDesc)
@ -894,8 +860,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"Building"*
- **Source:** class `CmdDesc` in
[building.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### destroy (CmdDestroy)
@ -925,8 +890,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"Building"*
- **Source:** class `CmdDestroy` in
[building.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### dig (CmdDig)
@ -958,8 +922,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"Building"*
- **Source:** class `CmdDig` in
[building.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### examine (CmdExamine)
@ -986,8 +949,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"Building"*
- **Source:** class `CmdExamine` in
[building.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py).
Belongs to command set *'DefaultAccount'* of class `AccountCmdSet` in [cmdset_account.py](https://gi
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_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).
#### find (CmdFind)
@ -1018,8 +980,7 @@ thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py)
- **[`help_category`](./Help-System):** *"Building"*
- **Source:** class `CmdFind` in
[building.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### link (CmdLink)
@ -1048,8 +1009,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"Building"*
- **Source:** class `CmdLink` in
[building.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### lock (CmdLock)
@ -1089,8 +1049,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"Building"*
- **Source:** class `CmdLock` in
[building.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### mvattr (CmdMvAttr)
@ -1115,8 +1074,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"Building"*
- **Source:** class `CmdMvAttr` in
[building.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### name (CmdName)
@ -1135,8 +1093,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"Building"*
- **Source:** class `CmdName` in
[building.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### open (CmdOpen)
@ -1144,8 +1101,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
open a new exit from the current room
Usage:
open <new exit>[;alias;alias..][:typeclass] [,<return exit>[;alias;..][:typeclass]]] =
<destination>
open <new exit>[;alias;alias..][:typeclass] [,<return exit>[;alias;..][:typeclass]]] = <destination>
Handles the creation of exits. If a destination is given, the exit
will point there. The <return exit> argument sets up an exit at the
@ -1159,8 +1115,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"Building"*
- **Source:** class `CmdOpen` in
[building.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### script (CmdScript)
@ -1188,8 +1143,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"Building"*
- **Source:** class `CmdScript` in
[building.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### set (CmdSetAttribute)
@ -1237,8 +1191,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"Building"*
- **Source:** class `CmdSetAttribute` in
[building.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### sethome (CmdSetHome)
@ -1262,8 +1215,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"Building"*
- **Source:** class `CmdSetHome` in
[building.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### spawn (CmdSpawn)
@ -1334,8 +1286,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"Building"*
- **Source:** class `CmdSpawn` in
[building.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### tag (CmdTag)
@ -1365,8 +1316,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"Building"*
- **Source:** class `CmdTag` in
[building.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### tel (CmdTeleport)
@ -1402,8 +1352,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"Building"*
- **Source:** class `CmdTeleport` in
[building.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### tunnel (CmdTunnel)
@ -1438,8 +1387,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"Building"*
- **Source:** class `CmdTunnel` in
[building.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### typeclass (CmdTypeclass)
@ -1495,8 +1443,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"Building"*
- **Source:** class `CmdTypeclass` in
[building.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### unlink (CmdUnLink)
@ -1515,8 +1462,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"Building"*
- **Source:** class `CmdUnLink` in
[building.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### wipe (CmdWipe)
@ -1539,14 +1485,12 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"Building"*
- **Source:** class `CmdWipe` in
[building.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
### `comms.py`
[View comms.py
source](https://github.com/evennia/evennia/tree/master/evennia/commands/default/comms.py)
[View comms.py source](https://github.com/evennia/evennia/tree/master/evennia/commands/default/comms.py)
#### addcom (CmdAddCom)
@ -1567,8 +1511,7 @@ source](https://github.com/evennia/evennia/tree/master/evennia/commands/default/
- **[`help_category`](./Help-System):** *"Comms"*
- **Source:** class `CmdAddCom` in
[comms.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/comms.py).
Belongs to command set *'DefaultAccount'* of class `AccountCmdSet` in [cmdset_account.py](https://gi
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_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).
#### allcom (CmdAllCom)
@ -1590,8 +1533,7 @@ thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py)
- **[`help_category`](./Help-System):** *"Comms"*
- **Source:** class `CmdAllCom` in
[comms.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/comms.py).
Belongs to command set *'DefaultAccount'* of class `AccountCmdSet` in [cmdset_account.py](https://gi
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_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).
#### cboot (CmdCBoot)
@ -1612,8 +1554,7 @@ thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py)
- **[`help_category`](./Help-System):** *"Comms"*
- **Source:** class `CmdCBoot` in
[comms.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/comms.py).
Belongs to command set *'DefaultAccount'* of class `AccountCmdSet` in [cmdset_account.py](https://gi
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_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).
#### ccreate (CmdChannelCreate)
@ -1631,8 +1572,7 @@ thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py)
- **[`help_category`](./Help-System):** *"Comms"*
- **Source:** class `CmdChannelCreate` in
[comms.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/comms.py).
Belongs to command set *'DefaultAccount'* of class `AccountCmdSet` in [cmdset_account.py](https://gi
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_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).
#### cdesc (CmdCdesc)
@ -1651,8 +1591,7 @@ thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py)
- **[`help_category`](./Help-System):** *"Comms"*
- **Source:** class `CmdCdesc` in
[comms.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/comms.py).
Belongs to command set *'DefaultAccount'* of class `AccountCmdSet` in [cmdset_account.py](https://gi
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_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).
#### cdestroy (CmdCdestroy)
@ -1670,8 +1609,7 @@ thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py)
- **[`help_category`](./Help-System):** *"Comms"*
- **Source:** class `CmdCdestroy` in
[comms.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/comms.py).
Belongs to command set *'DefaultAccount'* of class `AccountCmdSet` in [cmdset_account.py](https://gi
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_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).
#### cemit (CmdCemit)
@ -1695,8 +1633,7 @@ thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py)
- **[`help_category`](./Help-System):** *"Comms"*
- **Source:** class `CmdCemit` in
[comms.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/comms.py).
Belongs to command set *'DefaultAccount'* of class `AccountCmdSet` in [cmdset_account.py](https://gi
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_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).
#### channels (CmdChannels)
@ -1718,8 +1655,7 @@ thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py)
- **[`help_category`](./Help-System):** *"Comms"*
- **Source:** class `CmdChannels` in
[comms.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/comms.py).
Belongs to command set *'DefaultAccount'* of class `AccountCmdSet` in [cmdset_account.py](https://gi
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_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).
#### clock (CmdClock)
@ -1738,8 +1674,7 @@ thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py)
- **[`help_category`](./Help-System):** *"Comms"*
- **Source:** class `CmdClock` in
[comms.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/comms.py).
Belongs to command set *'DefaultAccount'* of class `AccountCmdSet` in [cmdset_account.py](https://gi
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_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).
#### cwho (CmdCWho)
@ -1757,8 +1692,7 @@ thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py)
- **[`help_category`](./Help-System):** *"Comms"*
- **Source:** class `CmdCWho` in
[comms.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/comms.py).
Belongs to command set *'DefaultAccount'* of class `AccountCmdSet` in [cmdset_account.py](https://gi
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_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).
#### delcom (CmdDelCom)
@ -1780,8 +1714,7 @@ thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py)
- **[`help_category`](./Help-System):** *"Comms"*
- **Source:** class `CmdDelCom` in
[comms.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/comms.py).
Belongs to command set *'DefaultAccount'* of class `AccountCmdSet` in [cmdset_account.py](https://gi
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_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).
#### irc2chan (CmdIRC2Chan)
@ -1820,8 +1753,7 @@ thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py)
- **[`help_category`](./Help-System):** *"Comms"*
- **Source:** class `CmdIRC2Chan` in
[comms.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/comms.py).
Belongs to command set *'DefaultAccount'* of class `AccountCmdSet` in [cmdset_account.py](https://gi
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_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).
#### page (CmdPage)
@ -1846,8 +1778,7 @@ thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py)
- **[`help_category`](./Help-System):** *"Comms"*
- **Source:** class `CmdPage` in
[comms.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/comms.py).
Belongs to command set *'DefaultAccount'* of class `AccountCmdSet` in [cmdset_account.py](https://gi
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_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).
#### rss2chan (CmdRSS2Chan)
@ -1880,14 +1811,12 @@ thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py)
- **[`help_category`](./Help-System):** *"Comms"*
- **Source:** class `CmdRSS2Chan` in
[comms.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/comms.py).
Belongs to command set *'DefaultAccount'* of class `AccountCmdSet` in [cmdset_account.py](https://gi
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_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).
### `general.py`
[View general.py
source](https://github.com/evennia/evennia/tree/master/evennia/commands/default/general.py)
[View general.py source](https://github.com/evennia/evennia/tree/master/evennia/commands/default/general.py)
#### access (CmdAccess)
@ -1926,8 +1855,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"General"*
- **Source:** class `CmdDrop` in
[general.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/general.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### get (CmdGet)
@ -1946,8 +1874,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"General"*
- **Source:** class `CmdGet` in
[general.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/general.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### give (CmdGive)
@ -1966,8 +1893,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"General"*
- **Source:** class `CmdGive` in
[general.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/general.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### home (CmdHome)
@ -1985,8 +1911,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"General"*
- **Source:** class `CmdHome` in
[general.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/general.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### inventory (CmdInventory)
@ -2005,8 +1930,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"General"*
- **Source:** class `CmdInventory` in
[general.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/general.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### look (CmdLook)
@ -2026,8 +1950,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"General"*
- **Source:** class `CmdLook` in
[general.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/general.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### nick (CmdNick)
@ -2077,8 +2000,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"General"*
- **Source:** class `CmdNick` in
[general.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/general.py).
Belongs to command set *'DefaultAccount'* of class `AccountCmdSet` in [cmdset_account.py](https://gi
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_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).
#### pose (CmdPose)
@ -2103,8 +2025,7 @@ thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py)
- **[`help_category`](./Help-System):** *"General"*
- **Source:** class `CmdPose` in
[general.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/general.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### say (CmdSay)
@ -2122,8 +2043,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"General"*
- **Source:** class `CmdSay` in
[general.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/general.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### setdesc (CmdSetDesc)
@ -2143,8 +2063,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"General"*
- **Source:** class `CmdSetDesc` in
[general.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/general.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### whisper (CmdWhisper)
@ -2164,8 +2083,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"General"*
- **Source:** class `CmdWhisper` in
[general.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/general.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
### `help.py`
@ -2192,8 +2110,7 @@ source](https://github.com/evennia/evennia/tree/master/evennia/commands/default/
- **[`help_category`](./Help-System):** *"General"*
- **Source:** class `CmdHelp` in
[help.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/help.py).
Belongs to command set *'DefaultAccount'* of class `AccountCmdSet` in [cmdset_account.py](https://gi
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_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).
#### sethelp (CmdSetHelp)
@ -2227,14 +2144,12 @@ thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py)
- **[`help_category`](./Help-System):** *"Building"*
- **Source:** class `CmdSetHelp` in
[help.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/help.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
### `system.py`
[View system.py
source](https://github.com/evennia/evennia/tree/master/evennia/commands/default/system.py)
[View system.py source](https://github.com/evennia/evennia/tree/master/evennia/commands/default/system.py)
#### about (CmdAbout)
@ -2252,8 +2167,7 @@ source](https://github.com/evennia/evennia/tree/master/evennia/commands/default/
- **[`help_category`](./Help-System):** *"System"*
- **Source:** class `CmdAbout` in
[system.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/system.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### objects (CmdObjects)
@ -2273,8 +2187,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"System"*
- **Source:** class `CmdObjects` in
[system.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/system.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### py (CmdPy)
@ -2329,8 +2242,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"System"*
- **Source:** class `CmdPy` in
[system.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/system.py).
Belongs to command set *'DefaultAccount'* of class `AccountCmdSet` in [cmdset_account.py](https://gi
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_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).
#### reload (CmdReload)
@ -2350,8 +2262,7 @@ thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py)
- **[`help_category`](./Help-System):** *"System"*
- **Source:** class `CmdReload` in
[system.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/system.py).
Belongs to command set *'DefaultAccount'* of class `AccountCmdSet` in [cmdset_account.py](https://gi
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_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).
#### reset (CmdReset)
@ -2379,8 +2290,7 @@ thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py)
- **[`help_category`](./Help-System):** *"System"*
- **Source:** class `CmdReset` in
[system.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/system.py).
Belongs to command set *'DefaultAccount'* of class `AccountCmdSet` in [cmdset_account.py](https://gi
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_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).
#### scripts (CmdScripts)
@ -2410,8 +2320,7 @@ thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py)
- **[`help_category`](./Help-System):** *"System"*
- **Source:** class `CmdScripts` in
[system.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/system.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### server (CmdServerLoad)
@ -2455,8 +2364,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"System"*
- **Source:** class `CmdServerLoad` in
[system.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/system.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### service (CmdService)
@ -2484,8 +2392,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"System"*
- **Source:** class `CmdService` in
[system.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/system.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
#### shutdown (CmdShutdown)
@ -2503,8 +2410,7 @@ s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_chara
- **[`help_category`](./Help-System):** *"System"*
- **Source:** class `CmdShutdown` in
[system.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/system.py).
Belongs to command set *'DefaultAccount'* of class `AccountCmdSet` in [cmdset_account.py](https://gi
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_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).
#### time (CmdTime)
@ -2523,14 +2429,12 @@ thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py)
- **[`help_category`](./Help-System):** *"System"*
- **Source:** class `CmdTime` in
[system.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/system.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](http
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
Belongs to command set *'DefaultCharacter'* of class `CharacterCmdSet` in [cmdset_character.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).
### `unloggedin.py`
[View unloggedin.py
source](https://github.com/evennia/evennia/tree/master/evennia/commands/default/unloggedin.py)
[View unloggedin.py source](https://github.com/evennia/evennia/tree/master/evennia/commands/default/unloggedin.py)
#### __unloggedin_look_command (CmdUnconnectedLook)
@ -2551,8 +2455,7 @@ source](https://github.com/evennia/evennia/tree/master/evennia/commands/default/
- **[`help_category`](./Help-System):** *"General"*
- **Source:** class `CmdUnconnectedLook` in [unloggedin.py](https://github.com/evennia/evennia/tree/
master/evennia/commands/default/unloggedin.py).
Belongs to command set *'DefaultUnloggedin'* of class `UnloggedinCmdSet` in [cmdset_unloggedin.py](h
ttps://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_unloggedin.py).
Belongs to command set *'DefaultUnloggedin'* of class `UnloggedinCmdSet` in [cmdset_unloggedin.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_unloggedin.py).
*OBS: This is a [[System Command|Commands]]. System commands have fixed keys and are called by the
server in specific situations.*
@ -2573,10 +2476,8 @@ server in specific situations.*
- **aliases:** *con*, *conn*, *co*
- **[locks](./Locks):** *"cmd:all()"*
- **[`help_category`](./Help-System):** *"General"*
- **Source:** class `CmdUnconnectedConnect` in [unloggedin.py](https://github.com/evennia/evennia/tr
ee/master/evennia/commands/default/unloggedin.py).
Belongs to command set *'DefaultUnloggedin'* of class `UnloggedinCmdSet` in [cmdset_unloggedin.py](h
ttps://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_unloggedin.py).
- **Source:** class `CmdUnconnectedConnect` in [unloggedin.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/unloggedin.py).
Belongs to command set *'DefaultUnloggedin'* of class `UnloggedinCmdSet` in [cmdset_unloggedin.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_unloggedin.py).
#### create (CmdUnconnectedCreate)
@ -2595,10 +2496,8 @@ ttps://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_un
- **aliases:** *cre*, *cr*
- **[locks](./Locks):** *"cmd:all()"*
- **[`help_category`](./Help-System):** *"General"*
- **Source:** class `CmdUnconnectedCreate` in [unloggedin.py](https://github.com/evennia/evennia/tre
e/master/evennia/commands/default/unloggedin.py).
Belongs to command set *'DefaultUnloggedin'* of class `UnloggedinCmdSet` in [cmdset_unloggedin.py](h
ttps://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_unloggedin.py).
- **Source:** class `CmdUnconnectedCreate` in [unloggedin.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/unloggedin.py).
Belongs to command set *'DefaultUnloggedin'* of class `UnloggedinCmdSet` in [cmdset_unloggedin.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_unloggedin.py).
#### help (CmdUnconnectedHelp)
@ -2615,10 +2514,8 @@ ttps://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_un
- **aliases:** *?*, *h*
- **[locks](./Locks):** *"cmd:all()"*
- **[`help_category`](./Help-System):** *"General"*
- **Source:** class `CmdUnconnectedHelp` in [unloggedin.py](https://github.com/evennia/evennia/tree/
master/evennia/commands/default/unloggedin.py).
Belongs to command set *'DefaultUnloggedin'* of class `UnloggedinCmdSet` in [cmdset_unloggedin.py](h
ttps://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_unloggedin.py).
- **Source:** class `CmdUnconnectedHelp` in [unloggedin.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/unloggedin.py).
Belongs to command set *'DefaultUnloggedin'* of class `UnloggedinCmdSet` in [cmdset_unloggedin.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_unloggedin.py).
#### quit (CmdUnconnectedQuit)
@ -2636,8 +2533,6 @@ ttps://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_un
- **aliases:** *qu*, *q*
- **[locks](./Locks):** *"cmd:all()"*
- **[`help_category`](./Help-System):** *"General"*
- **Source:** class `CmdUnconnectedQuit` in [unloggedin.py](https://github.com/evennia/evennia/tree/
master/evennia/commands/default/unloggedin.py).
Belongs to command set *'DefaultUnloggedin'* of class `UnloggedinCmdSet` in [cmdset_unloggedin.py](h
ttps://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_unloggedin.py).
- **Source:** class `CmdUnconnectedQuit` in [unloggedin.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/unloggedin.py).
Belongs to command set *'DefaultUnloggedin'* of class `UnloggedinCmdSet` in [cmdset_unloggedin.py](https://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_unloggedin.py).

3
docs/source/Dialogues-in-events.md
View file

@ -236,8 +236,7 @@ another.
- **Q:** can I have two characters answering to the same dialogue in exactly the same way?
- **A:** It's possible but not so easy to do. Usually, event grouping is set in code, and depends
on different games. However, if it is for some infrequent occurrences, it's easy to do using
[chained events](https://github.com/evennia/evennia/blob/master/evennia/contrib/ingame_python/README
.md#chained-events).
[chained events](https://github.com/evennia/evennia/blob/master/evennia/contrib/ingame_python/README.md#chained-events).
- **Q:** is it possible to deploy callbacks on all characters sharing the same prototype?
- **A:** not out of the box. This depends on individual settings in code. One can imagine that all
characters of some type would share some events, but this is game-specific. Rooms of the same zone

16
docs/source/Evennia-for-MUSH-Users.md
View file

@ -88,8 +88,8 @@ another which is again somewhat remniscent at least of the *effect* of `@parent
based inheritance of MUSH.
There are other differences for sure, but that should give some feel for things. Enough with the
theory. Let's get down to more practical matters next. To install, see the [Getting Started
instructions](Getting-Started).
theory. Let's get down to more practical matters next. To install, see the
[Getting Started instructions](./Getting-Started).
## A first step making things more familiar
@ -138,8 +138,7 @@ class CharacterCmdSet(default_cmds.CharacterCmdSet):
Note that Python cares about indentation, so make sure to indent with the same number of spaces as
shown above!
So what happens above? We [import the module](http://www.linuxtopia.org/online_books/programming_boo
ks/python_programming/python_ch28s03.html) `evennia/contrib/multidescer.py` at the top. Once
So what happens above? We [import the module](http://www.linuxtopia.org/online_books/programming_books/python_programming/python_ch28s03.html) `evennia/contrib/multidescer.py` at the top. Once
imported we can access stuff inside that module using full stop (`.`). The multidescer is defined as
a class `CmdMultiDesc` (we could find this out by opening said module in a text editor). At the
bottom we create a new instance of this class and add it to the `CharacterCmdSet` class. For the
@ -206,17 +205,14 @@ developer changing the underlying Python code.
If you are a *Developer* and are interested in making a more MUSH-like Evennia game, a good start is
to look into the Evennia [Tutorial for a first MUSH-like game](./Tutorial-for-basic-MUSH-like-game).
That steps through building a simple little game from scratch and helps to acquaint you with the
various corners of Evennia. There is also the [Tutorial for running roleplaying sessions](Evennia-
for-roleplaying-sessions) that can be of interest.
various corners of Evennia. There is also the [Tutorial for running roleplaying sessions](./Evennia-for-roleplaying-sessions) that can be of interest.
An important aspect of making things more familiar for *Players* is adding new and tweaking existing
commands. How this is done is covered by the [Tutorial on adding new commands](Adding-Command-
Tutorial). You may also find it useful to shop through the `evennia/contrib/` folder. The [Tutorial
commands. How this is done is covered by the [Tutorial on adding new commands](./Adding-Command-Tutorial). You may also find it useful to shop through the `evennia/contrib/` folder. The [Tutorial
world](Tutorial-World-Introduction) is a small single-player quest you can try (it’s not very MUSH-
like but it does show many Evennia concepts in action). Beyond that there are [many more
tutorials](Tutorials) to try out. If you feel you want a more visual overview you can also look at
[Evennia in pictures](https://evennia.blogspot.se/2016/05/evennia-in-pictures.html).
… And of course, if you need further help you can always drop into the [Evennia chatroom](http://web
chat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb) or post a
… And of course, if you need further help you can always drop into the [Evennia chatroom](http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb) or post a
question in our [forum/mailing list](https://groups.google.com/forum/#%21forum/evennia)!

6
docs/source/Game-Planning.md
View file

@ -4,11 +4,7 @@
So you have Evennia up and running. You have a great game idea in mind. Now it's time to start
cracking! But where to start? Here are some ideas for a workflow. Note that the suggestions on this
page are just that - suggestions. Also, they are primarily aimed at a lone hobby designer or a small
team developing a game in their free time. There is an article in the Imaginary Realities e-zine
which was written by the Evennia lead dev. It focuses more on you finding out your motivations for
making a game - you can [read the article here](http://journal.imaginary-
realities.com/volume-07/issue-03/where-do-i-begin/index.html).
team developing a game in their free time.
Below are some minimal steps for getting the first version of a new game world going with players.
It's worth to at least make the attempt to do these steps in order even if you are itching to jump

8
docs/source/Glossary.md
View file

@ -90,7 +90,7 @@ monsters and other NPCs. You can [read more about it here](./Objects#subclasses-
similar to Rails for the Ruby language. It is one of Evennia's central library dependencies (the
other one is [Twisted](./Glossary#twisted)). Evennia uses Django for two main things - to map all
database operations to Python and for structuring our web site.
Through Django, we can work with any supported database (SQlite3, Postgres, MySQL ...) using generic
Python instead of database-specific SQL: A database table is represented in Django as a Python class
(called a *model*). An Python instance of such a class represents a row in that table.
@ -204,8 +204,7 @@ infrastructure. Git itself is a separate project.
### _object_
In general Python (and other [object-oriented languages](https://en.wikipedia.org/wiki/Object-
oriented_programming)), an `object` is what we call the instance of a *class*. But one of Evennia's
In general Python (and other [object-oriented languages](https://en.wikipedia.org/wiki/Object-oriented_programming)), an `object` is what we call the instance of a *class*. But one of Evennia's
core [typeclasses](./Glossary#typeclasss) is also called "Object". To separate these in the docs we
try to use `object` to refer to the general term and capitalized `Object` when we refer to the
typeclass.
@ -246,8 +245,7 @@ not have to be.
### _property_
A _property_ is a general term used for properties on any Python object. The term also sometimes
refers to the `property` built-in function of Python ([read more here](https://www.python-
course.eu/python3_properties.php)). Note the distinction between properties,
refers to the `property` built-in function of Python ([read more here](https://www.python-course.eu/python3_properties.php)). Note the distinction between properties,
[fields](./Glossary#field) and [Attributes](./Glossary#attribute).
### _repository_

4
docs/source/Help-System-Tutorial.md
View file

@ -1,9 +1,7 @@
# Help System Tutorial
**Before doing this tutorial you will probably want to read the intro in [Basic Web tutorial](Web-
Tutorial).** Reading the three first parts of the [Django
tutorial](https://docs.djangoproject.com/en/2.2/) might help as well.
**Before doing this tutorial you will probably want to read the intro in [Basic Web tutorial](./Web-Tutorial).** Reading the three first parts of the [Django tutorial](https://docs.djangoproject.com/en/2.2/) might help as well.
This tutorial will show you how to access the help system through your website. Both help commands
and regular help entries will be visible, depending on the logged-in user or an anonymous character.

25
docs/source/How-To-Get-And-Give-Help.md
View file

@ -4,12 +4,12 @@
### How to *get* Help
If you cannot find what you are looking for in the [online documentation](./index), here's what to do:
- If you think the documentation is not clear enough and are short on time, fill in our quick little
[online form][form] and let us know - no login required. Maybe the docs need to be improved or a new
tutorial added! Note that while this form is useful as a suggestion box we cannot answer questions
or reply to you. Use the discussion group or chat (linked below) if you want feedback.
- If you have trouble with a missing feature or a problem you think is a bug, go to the
- If you have trouble with a missing feature or a problem you think is a bug, go to the
[issue tracker][issues] and search to see if has been reported/suggested already. If you can't find an
existing entry create a new one.
- If you need help, want to start a discussion or get some input on something you are working on,
@ -28,8 +28,8 @@ eventually!
Evennia is a completely non-funded project. It relies on the time donated by its users and
developers in order to progress.
The first and easiest way you as a user can help us out is by taking part in [community
discussions][group] and by giving feedback on what is good or bad. Report bugs you find and features
The first and easiest way you as a user can help us out is by taking part in
[community discussions][group] and by giving feedback on what is good or bad. Report bugs you find and features
you lack to our [issue tracker][issues]. Just the simple act of letting developers know you are out
there using their program is worth a lot. Generally mentioning and reviewing Evennia elsewhere is
also a nice way to spread the word.
@ -50,24 +50,19 @@ fixed (if you want to put up a bounty yourself you can do so via our page on
github.
... And finally, if you want to help motivate and support development you can also drop some coins
in the developer's cup. You can [make a donation via PayPal][paypal] or, even better, [become an
Evennia patron on Patreon][patreon]! This is a great way to tip your hat and show that you
in the developer's cup. You can [make a donation via PayPal][paypal] or, even better,
[become an Evennia patron on Patreon][patreon]! This is a great way to tip your hat and show that you
appreciate the work done with the server! Finally, if you want to encourage the community to resolve
a particular
[form]: https://docs.google.com/spreadsheet/viewform?hl=en_US&formkey=dGN0VlJXMWpCT3VHaHpscDEzY1RoZG
c6MQ#gid=0
[form]: https://docs.google.com/spreadsheet/viewform?hl=en_US&formkey=dGN0VlJXMWpCT3VHaHpscDEzY1RoZGc6MQ#gid=0
[group]: http://groups.google.com/group/evennia/
[issues]: https://github.com/evennia/evennia/issues
[issues-master]: https://github.com/evennia/evennia/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen%2
0label%3Abug%20label%3Amaster-branch
[issues-master]: https://github.com/evennia/evennia/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen%20label%3Abug%20label%3Amaster-branch
[chat]: http://webchat.freenode.net/?channels=evennia
[paypal]: https://www.paypal.com/se/cgi-bin/webscr?cmd=_flow&SESSION=Z-VlOvfGjYq2qvCDOUGpb6C8Due7skT
0qOklQEy5EbaD1f0eyEQaYlmCc8O&dispatch=5885d80a13c0db1f8e263663d3faee8d64ad11bbf4d2a5a1a0d303a50933f9
[paypal]: https://www.paypal.com/se/cgi-bin/webscr?cmd=_flow&SESSION=Z-VlOvfGjYq2qvCDOUGpb6C8Due7skT0qOklQEy5EbaD1f0eyEQaYlmCc8O&dispatch=5885d80a13c0db1f8e263663d3faee8d64ad11bbf4d2a5a1a0d303a50933f9
b2
[donate-img]: http://images-focus-opensocial.googleusercontent.com/gadgets/proxy?url=https://www.pay
palobjects.com/en%255fUS/SE/i/btn/btn%255fdonateCC%255fLG.gif&container=focus&gadget=a&rewriteMime=i
mage/*
[donate-img]: http://images-focus-opensocial.googleusercontent.com/gadgets/proxy?url=https://www.paypalobjects.com/en%255fUS/SE/i/btn/btn%255fdonateCC%255fLG.gif&container=focus&gadget=a&rewriteMime=image/*
[patreon]: https://www.patreon.com/griatch
[patreon-img]: http://www.evennia.com/_/rsrc/1424724909023/home/evennia_patreon_100x100.png
[issues-bounties]: https://github.com/evennia/evennia/labels/bounty

16
docs/source/Links.md
View file

@ -6,8 +6,7 @@
- [evennia.com](http://www.evennia.com) - Main Evennia portal page. Links to all corners of Evennia.
- [Evennia github page](https://github.com/evennia/evennia) - Download code and read documentation.
- [Evennia official chat channel](http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRy
dWUmMTE9MTk1JjEyPXRydWUbb) - Our official IRC chat #evennia at irc.freenode.net:6667.
- [Evennia official chat channel](http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb) - Our official IRC chat #evennia at irc.freenode.net:6667.
- [Evennia forums/mailing list](http://groups.google.com/group/evennia) - Web interface to our
google group.
- [Evennia development blog](http://evennia.blogspot.se/) - Musings from the lead developer.
@ -106,8 +105,7 @@ Influential mailing list active 1996-2004. Advanced game design discussions.
- [Mud-dev wiki](http://mud-dev.wikidot.com/) - A (very) slowly growing resource on MUD creation.
- [Mud Client/Server Interaction](http://cryosphere.net/mud-protocol.html) - A page on classic MUD
telnet protocols.
- [Mud Tech's fun/cool but ...](http://gc-taylor.com/blog/2013/01/08/mud-tech-funcool-dont-forget-
ship-damned-thing/) - Greg Taylor gives good advice on mud design.
- [Mud Tech's fun/cool but ...](http://gc-taylor.com/blog/2013/01/08/mud-tech-funcool-dont-forget-ship-damned-thing/) - Greg Taylor gives good advice on mud design.
- [Lost Library of MOO](http://www.hayseed.net/MOO/) - Archive of scientific articles on mudding (in
particular moo).
- [Nick Gammon's hints thread](http://www.gammon.com.au/forum/bbshowpost.php?bbsubject_id=5959) -
@ -118,14 +116,12 @@ articles (not MUD-specific)
- [The Alexandrian](http://thealexandrian.net/) - A blog about tabletop roleplaying and board games,
but with lots of general discussion about rule systems and game balance that could be applicable
also for MUDs.
- [Raph Koster's laws of game design](https://www.raphkoster.com/games/laws-of-online-world-
design/the-laws-of-online-world-design/) - thought-provoking guidelines and things to think about
- [Raph Koster's laws of game design](https://www.raphkoster.com/games/laws-of-online-world-design/the-laws-of-online-world-design/) - thought-provoking guidelines and things to think about
when designing a virtual multiplayer world (Raph is known for *Ultima Online* among other things).
### Literature
- Richard Bartle *Designing Virtual Worlds* ([amazon page](http://www.amazon.com/Designing-Virtual-
Worlds-Richard-Bartle/dp/0131018167)) - Essential reading for the design of any persistent game
- Richard Bartle *Designing Virtual Worlds* ([amazon page](http://www.amazon.com/Designing-Virtual-Worlds-Richard-Bartle/dp/0131018167)) - Essential reading for the design of any persistent game
world, written by the co-creator of the original game *MUD*. Published in 2003 but it's still as
relevant now as when it came out. Covers everything you need to know and then some.
- Zed A. Shaw *Learn Python the Hard way* ([homepage](https://learnpythonthehardway.org/)) - Despite
@ -161,7 +157,7 @@ economic system.
- [GIT](http://git-scm.com/)
- [Documentation](http://git-scm.com/documentation)
- [Learn GIT in 15 minutes](http://try.github.io/levels/1/challenges/1) (interactive tutorial)
### Python Info
- [Python Website](http://www.python.org/)
@ -177,4 +173,4 @@ programming curriculum for different skill levels
- Wiki [Home](./index) Icons made by [Freepik](http://www.freepik.com"-title="Freepik">Freepik) from
[flaticon.com](http://www.flaticon.com), licensed under [Creative Commons BY
3.0](http://creativecommons.org/licenses/by/3.0).
3.0](http://creativecommons.org/licenses/by/3.0).

5
docs/source/Online-Setup.md
View file

@ -238,8 +238,7 @@ Also, on Freenode visit the #letsencrypt channel for assistance from the communi
additional resource, Let's Encrypt has a very active [community
forum](https://community.letsencrypt.org/).
[A blog where someone sets up Let's Encrypt](https://www.digitalocean.com/community/tutorials/how-
to-secure-apache-with-let-s-encrypt-on-ubuntu-16-04)
[A blog where someone sets up Let's Encrypt](https://www.digitalocean.com/community/tutorials/how-to-secure-apache-with-let-s-encrypt-on-ubuntu-16-04)
The only process missing from all of the above documentation is how to pass verification. This is
how Let's Encrypt verifies that you have control over your domain (not necessarily ownership, it's
@ -415,7 +414,7 @@ Evennia users:
| `Linode`_ | Cloud | $5/month / | Multiple regions. Smallest option provides 1GB RAM |
| | | on-demand | |
+------------------------+----------------+----------------+----------------------------------------------------------+
| `Genesis MUD hosting`_ | Shell account | $8/month | Dedicated MUD host with very limited memory offerings. |
| `Genesis MUD hosting`_ | Shell account | $8/month | Dedicated MUD host with very limited memory offerings. |
| | | | When last investigated (2017) ran a 13 years old Python |
| | | | version (2.4) (convince them to update or compile). |
| | | | Note that Evennia needs *at least* the "Deluxe" package |

3
docs/source/Portal-And-Server.md
View file

@ -8,8 +8,7 @@ If you are new to the concept, the main purpose of separating the two is to have
the Portal but keep the MUD running on the Server. This way one can restart/reload the game (the
Server part) without Accounts getting disconnected.
![portal and server layout](https://474a3b9f-a-62cb3a1a-s-
sites.googlegroups.com/site/evenniaserver/file-cabinet/evennia_server_portal.png)
![portal and server layout](https://474a3b9f-a-62cb3a1a-s-sites.googlegroups.com/site/evenniaserver/file-cabinet/evennia_server_portal.png)
The Server and Portal are glued together via an AMP (Asynchronous Messaging Protocol) connection.
This allows the two programs to communicate seamlessly.

85
docs/source/Python-3.md
View file

@ -1,87 +1,4 @@
# Python 3
> *Note: Evennia only supports Python 2.7+ at this time. This page gathers various development
information relevant to server developers.*
Evennia supports Python 3+ since v0.8. This page is deprecated.
Django can work with Python 2 and 3 already, though changes may be required to how the Evennia code
uses it. Twisted has much Python 3 compatibility, but not all modules within it have been ported
yet. The
[twisted.python.dist3](https://twistedmatrix.com/documents/current/api/twisted.python.dist3.html)
module gives some information about what's ported, and I'm compiling a list of missing modules with
related bug reports which can be found below. The list is based on a search for import statements in
the Evennia source code, please add anything that's missing.
Part of this process is expected to be writing more tests for Evennia. One encouraging recent port
to Python 3 in Twisted is its Trial test framework, which may need to be used by Evennia to ensure
it still works correctly with Twisted on Python 3.
# "Strings"
Broadly (and perhaps over-simplified):
* Twisted [expects bytes](http://twistedmatrix.com/trac/wiki/FrequentlyAskedQuestions#WhydontTwisted
snetworkmethodssupportUnicodeobjectsaswellasstrings)
* Django [expects "" to be unicode](https://docs.djangoproject.com/en/1.8/topics/python3/#unicode-
literals)
I think we should use (roughly speaking) "" for unicode and b"" for bytes everywhere, but I need to
look at the impacts of this more closely.
# Links
* http://twistedmatrix.com/documents/current/core/howto/python3.html
* https://twistedmatrix.com/trac/wiki/Plan/Python3
* [Twisted Python3 bugs](https://twistedmatrix.com/trac/query?status=assigned&status=new&status=reop
ened&group=status&milestone=Python-3.x)
# Twisted module status
x = not ported to Python 3
/ = ported to Python 3
* twisted.application.internet /
* twisted.application.service /
* twisted.conch x (not used directly)
* ~https://twistedmatrix.com/trac/ticket/5102~ /
* ~https://twistedmatrix.com/trac/ticket/4993~ /
* twisted.conch.insults.insults x
* twisted.conch.interfaces x
* twisted.conch.manhole x
* twisted.conch.manhole_ssh x
* twisted.conch.ssh.common x
* twisted.conch.ssh.keys x
* ~https://twistedmatrix.com/trac/ticket/7998~ /
* "twisted.conch.ssh.keys should be ported to Python 3"
* twisted.conch.ssh.userauth x
* twisted.conch.telnet x
* twisted.cred.checkers /
* twisted.cred.portal /
* twisted.internet.defer /
* twisted.internet.interfaces /
* twisted.internet.protocol /
* twisted.internet.reactor /
* twisted.internet.ssl /
* twisted.internet.task /
* twisted.internet.threads /
* twisted.protocols.amp x
* ~https://twistedmatrix.com/trac/ticket/6833~ /
* "Port twisted.protocols.amp to Python 3"
* twisted.protocols.policies /
* twisted.python.components /
* twisted.python.log /
* twisted.python.threadpool /
* twisted.web.http (x)
* Partial support. Sufficient?
* twisted.web.resource /
* twisted.web.server (x)
* Partial support. Sufficient?
* twisted.web.static /
* twisted.web.proxy /
* twisted.web.wsgi x
* ~https://twistedmatrix.com/trac/ticket/7993~ /
* "'twisted.web.wsgi' should be ported to Python 3"
* Seems to be making good progress
* twisted.words.protocols.irc x
* https://twistedmatrix.com/trac/ticket/6320
* "Python 3 support for twisted.words.protocols.irc"
* ~https://twistedmatrix.com/trac/ticket/6564~
* "Replace usage of builtin reduce in twisted.words"

3
docs/source/Python-basic-introduction.md
View file

@ -196,8 +196,7 @@ your life a lot easier.
This is a [reserved Python keyword](https://docs.python.org/2.5/ref/keywords.html); try not to use
these words anywhere else.
- A function name can not have spaces but otherwise we could have called it almost anything. We call
it `hello_world`. Evennia follows [Python's standard naming
style](https://github.com/evennia/evennia/blob/master/CODING_STYLE.md#a-quick-list-of-code-style-
it `hello_world`. Evennia follows [Python's standard naming style](https://github.com/evennia/evennia/blob/master/CODING_STYLE.md#a-quick-list-of-code-style-
points) with lowercase letters and underscores. Use this style for now.
- `who` is what we call the *argument* to our function. Arguments are variables we pass to the
function. We could have named it anything and we could also have multiple arguments separated by

51
docs/source/Python-basic-tutorial-part-two.md
View file

@ -55,8 +55,7 @@ A *class* is like a "factory" or blueprint. From a class you then create individ
if class is`Dog`, an instance of `Dog` might be `fido`. Our in-game persona is of a class
`Character`. The superuser `christine` is an *instance* of the `Character` class (an instance is
also often referred to as an *object*). This is an important concept in *object oriented
programming*. You are wise to [familiarize yourself with it](https://en.wikipedia.org/wiki/Class-
based_programming) a little.
programming*. You are wise to [familiarize yourself with it](https://en.wikipedia.org/wiki/Class-based_programming) a little.
> In other terms:
> * class: A description of a thing, all the methods (code) and data (information)
@ -176,8 +175,7 @@ also explore it [online on github](https://github.com/evennia/evennia/tree/maste
The structure of the library directly reflects how you import from it.
- To, for example, import [the text justify
function](https://github.com/evennia/evennia/blob/master/evennia/utils/utils.py#L201) from
- To, for example, import [the text justify function](https://github.com/evennia/evennia/blob/master/evennia/utils/utils.py#L201) from
`evennia/utils/utils.py` you would do `from evennia.utils.utils import justify`. In your code you
could then just call `justify(...)` to access its functionality.
- You could also do `from evennia.utils import utils`. In code you would then have to write
@ -191,15 +189,13 @@ import in Python.
Now, remember that our `characters.py` module did `from evennia import DefaultCharacter`. But if we
look at the contents of the `evennia` folder, there is no `DefaultCharacter` anywhere! This is
because Evennia gives a large number of optional "shortcuts", known as [the "flat" API](Evennia-
API). The intention is to make it easier to remember where to find stuff. The flat API is defined in
because Evennia gives a large number of optional "shortcuts", known as [the "flat" API](./Evennia-API). The intention is to make it easier to remember where to find stuff. The flat API is defined in
that weirdly named `__init__.py` file. This file just basically imports useful things from all over
Evennia so you can more easily find them in one place.
We could [just look at the documenation](github:evennia#typeclasses) to find out where we can look
at our `DefaultCharacter` parent. But for practice, let's figure it out. Here is where
`DefaultCharacter` [is imported
from](https://github.com/evennia/evennia/blob/master/evennia/__init__.py#L188) inside `__init__.py`:
`DefaultCharacter` [is imported from](https://github.com/evennia/evennia/blob/master/evennia/__init__.py#L188) inside `__init__.py`:
```python
from .objects.objects import DefaultCharacter
@ -231,8 +227,7 @@ is the same thing, just a little easier to remember.
In the previous section we traced the parent of our `Character` class to be
`DefaultCharacter` in
[evennia/objects/objects.py](https://github.com/evennia/evennia/blob/master/evennia/objects/objects.
py).
[evennia/objects/objects.py](https://github.com/evennia/evennia/blob/master/evennia/objects/objects.py).
Open that file and locate the `DefaultCharacter` class. It's quite a bit down
in this module so you might want to search using your editor's (or browser's)
search function. Once you find it, you'll find that the class starts like this:
@ -276,8 +271,7 @@ outside
```
... And so on (you can see the full [class online
here](https://github.com/evennia/evennia/blob/master/evennia/objects/objects.py#L1915)). Here we
... And so on (you can see the full [class online here](https://github.com/evennia/evennia/blob/master/evennia/objects/objects.py#L1915)). Here we
have functional code! These methods may not be directly visible in `Character` back in our game dir,
but they are still available since `Character` is a child of `DefaultCharacter` above. Here is a
brief summary of the methods we find in `DefaultCharacter` (follow in the code to see if you can see
@ -309,8 +303,7 @@ class DefaultCharacter(DefaultObject):
This means that `DefaultCharacter` is in *itself* a child of something called `DefaultObject`! Let's
see what this parent class provides. It's in the same module as `DefaultCharacter`, you just need to
[scroll up near the
top](https://github.com/evennia/evennia/blob/master/evennia/objects/objects.py#L193):
[scroll up near the top](https://github.com/evennia/evennia/blob/master/evennia/objects/objects.py#L193):
```python
class DefaultObject(with_metaclass(TypeclassBase, ObjectDB)):
@ -327,11 +320,9 @@ the doc string of `msg`.
> As seen, `DefaultObject` actually has multiple parents. In one of those the basic `key` property
is defined, but we won't travel further up the inheritance tree in this tutorial. If you are
interested to see them, you can find `TypeclassBase` in [evennia/typeclasses/models.py](https://gith
ub.com/evennia/evennia/blob/master/evennia/typeclasses/models.py#L93) and `ObjectDB` in [evennia/obj
interested to see them, you can find `TypeclassBase` in [evennia/typeclasses/models.py](https://github.com/evennia/evennia/blob/master/evennia/typeclasses/models.py#L93) and `ObjectDB` in [evennia/obj
ects/models.py](https://github.com/evennia/evennia/blob/master/evennia/objects/models.py#L121). We
will also not go into the details of [Multiple
Inheritance](https://docs.python.org/2/tutorial/classes.html#multiple-inheritance) or
will also not go into the details of [Multiple Inheritance](https://docs.python.org/2/tutorial/classes.html#multiple-inheritance) or
[Metaclasses](http://www.onlamp.com/pub/a/python/2003/04/17/metaclasses.html) here. The general rule
is that if you realize that you need these features, you already know enough to use them.
@ -384,8 +375,7 @@ By default the `at_before_say` method doesn't do anything. It just takes the `me
`return`s it just the way it was (the `return` is another reserved Python word).
> We won't go into `**kwargs` here, but it (and its sibling `*args`) is also important to
understand, extra reading is [here for
`**kwargs`](https://stackoverflow.com/questions/1769403/understanding-kwargs-in-python).
understand, extra reading is [here for `**kwargs`](https://stackoverflow.com/questions/1769403/understanding-kwargs-in-python).
Now, open your game folder and edit `mygame/typeclasses/characters.py`. Locate your `Character`
class and modify it as such:
@ -407,8 +397,7 @@ through the method.
Note that `f` in front of the string, it means we turned the string into a 'formatted string'. We
can now easily inject stuff directly into the string by wrapping them in curly brackets `{ }`. In
this example, we put the incoming `message` into the string, followed by an ellipsis. This is only
one way to format a string. Python has very powerful [string
formatting](https://docs.python.org/2/library/string.html#format-specification-mini-language) and
one way to format a string. Python has very powerful [string formatting](https://docs.python.org/2/library/string.html#format-specification-mini-language) and
you are wise to learn it well, considering your game will be mainly text-based.
> You could also copy & paste the relevant method from `DefaultObject` here to get the full doc
@ -454,8 +443,7 @@ program.
IPython ...
...
In [1]:
IPython has some very nice ways to explore what Evennia has to offer.
In [1]: IPython has some very nice ways to explore what Evennia has to offer.
> import evennia
> evennia.<TAB>
@ -489,15 +477,14 @@ and resources [on our link page](./Links).
We have touched upon many of the concepts here but to use Evennia and to be able to follow along in
the code, you will need basic understanding of Python
[modules](http://docs.python.org/2/tutorial/modules.html),
[variables](http://www.tutorialspoint.com/python/python_variable_types.htm), [conditional
statements](http://docs.python.org/tutorial/controlflow.html#if-statements),
[variables](http://www.tutorialspoint.com/python/python_variable_types.htm),
[conditional statements](http://docs.python.org/tutorial/controlflow.html#if-statements),
[loops](http://docs.python.org/tutorial/controlflow.html#for-statements),
[functions](http://docs.python.org/tutorial/controlflow.html#defining-functions), [lists,
dictionaries, list comprehensions](http://docs.python.org/tutorial/datastructures.html) and [string
formatting](http://docs.python.org/tutorial/introduction.html#strings). You should also have a basic
understanding of [object-oriented
programming](http://www.tutorialspoint.com/python/python_classes_objects.htm) and what Python
[Classes](http://docs.python.org/tutorial/classes.html) are.
[functions](http://docs.python.org/tutorial/controlflow.html#defining-functions),
[lists, dictionaries, list comprehensions](http://docs.python.org/tutorial/datastructures.html)
and [string formatting](http://docs.python.org/tutorial/introduction.html#strings). You should also have a basic
understanding of [object-oriented programming](http://www.tutorialspoint.com/python/python_classes_objects.htm)
and what Python [Classes](http://docs.python.org/tutorial/classes.html) are.
Once you have familiarized yourself, or if you prefer to pick Python up as you go, continue to one
of the beginning-level [Evennia tutorials](./Tutorials) to gradually build up your understanding.

3
docs/source/Screenshot.md
View file

@ -1,8 +1,7 @@
# Screenshot
![evennia_screenshot2017](https://user-
images.githubusercontent.com/294267/30773728-ea45afb6-a076-11e7-8820-49be2168a6b8.png)
![evennia_screenshot2017](https://user-images.githubusercontent.com/294267/30773728-ea45afb6-a076-11e7-8820-49be2168a6b8.png)
*(right-click and choose your browser's equivalent of "view image" to see it full size)*
This screenshot shows a vanilla [install](./Getting-Started) of the just started Evennia MUD server.

4
docs/source/Server-Conf.md
View file

@ -10,8 +10,8 @@ The "Settings" file referenced throughout the documentation is the file
`mygame/server/conf/settings.py`. This is automatically created on the first run of `evennia --init`
(see the [Getting Started](./Getting-Started) page).
Your new `settings.py` is relatively bare out of the box. Evennia's core settings file is actually [
evennia/settings_default.py](https://github.com/evennia/evennia/blob/master/evennia/settings_default
Your new `settings.py` is relatively bare out of the box. Evennia's core settings file is actually
[evennia/settings_default.py](https://github.com/evennia/evennia/blob/master/evennia/settings_default
.py) and is considerably more extensive (it is also heavily documented so you should refer to this
file directly for the available settings).

22
docs/source/Static-In-Game-Map.md
View file

@ -18,8 +18,7 @@ sanity of their players. And when they do, the game becomes possible to map. Thi
an example of a simple but flexible in-game map system to further help player's to navigate. We will
To simplify development and error-checking we'll break down the work into bite-size chunks, each
building on what came before. For this we'll make extensive use of the [Batch code processor](Batch-
Code-Processor), so you may want to familiarize yourself with that.
building on what came before. For this we'll make extensive use of the [Batch code processor](./Batch-Code-Processor), so you may want to familiarize yourself with that.
1. **Planning the map** - Here we'll come up with a small example map to use for the rest of the
tutorial.
@ -36,7 +35,7 @@ map we designed before.
O─O─O To the south, the glow of a campfire can be seen. To the east lie
≈↑│↑∩ the vast mountains and to the west is heard the waves of the sea.
↑▲O▲↑
Exits: north(#8), east(#9), south(#10), west(#11)
```
@ -46,9 +45,7 @@ don't show in the documentation wiki.
## Planning the Map
Let's begin with the fun part! Maps in MUDs come in many different [shapes and
sizes](http://journal.imaginary-realities.com/volume-05/issue-01/modern-interface-modern-
mud/index.html). Some appear as just boxes connected by lines. Others have complex graphics that are
Let's begin with the fun part! Maps in MUDs come in many different [shapes and sizes](http://journal.imaginary-realities.com/volume-05/issue-01/modern-interface-modern-mud/index.html). Some appear as just boxes connected by lines. Others have complex graphics that are
external to the game itself.
Our map will be in-game text but that doesn't mean we're restricted to the normal alphabet! If
@ -275,12 +272,12 @@ def return_map():
This function returns the whole map
"""
map = ""
#For each row in our map, add it to map
for valuey in world_map:
map += valuey
map += "\n"
return map
def return_minimap(x, y, radius = 2):
@ -289,12 +286,12 @@ def return_minimap(x, y, radius = 2):
Returning all chars in a 2 char radius from (x,y)
"""
map = ""
#For each row we need, add the characters we need.
for valuey in world_map[y-radius:y+radius+1]: for valuex in valuey[x-radius:x+radius+1]:
map += valuex
map += "\n"
return map
```
@ -411,6 +408,5 @@ You should now have a mapped little world and a basic understanding of batchcode
easily new game defining features can be added to Evennia.
You can easily build from this tutorial by expanding the map and creating more rooms to explore. Why
not add more features to your game by trying other tutorials: [Add weather to your world](Weather-
Tutorial), [fill your world with NPC's](./Tutorial-Aggressive-NPCs) or [implement a combat
system](Turn-based-Combat-System).
not add more features to your game by trying other tutorials: [Add weather to your world](./Weather-Tutorial),
[fill your world with NPC's](./Tutorial-Aggressive-NPCs) or [implement a combat system](./Turn-based-Combat-System).

18
docs/source/Turn-based-Combat-System.md
View file

@ -2,8 +2,7 @@
This tutorial gives an example of a full, if simplified, combat system for Evennia. It was inspired
by the discussions held on the [mailing
list](https://groups.google.com/forum/#!msg/evennia/wnJNM2sXSfs/-dbLRrgWnYMJ).
by the discussions held on the [mailing list](https://groups.google.com/forum/#!msg/evennia/wnJNM2sXSfs/-dbLRrgWnYMJ).
## Overview of combat system concepts
@ -49,8 +48,7 @@ free.
- The commands are (in our example) simple; they can either `hit <target>`, `feint <target>` or
`parry <target>`. They can also `defend`, a generic passive defense. Finally they may choose to
`disengage/flee`.
- When attacking we use a classic [rock-paper-scissors](https://en.wikipedia.org/wiki/Rock-paper-
scissors) mechanic to determine success: `hit` defeats `feint`, which defeats `parry` which defeats
- When attacking we use a classic [rock-paper-scissors](https://en.wikipedia.org/wiki/Rock-paper-scissors) mechanic to determine success: `hit` defeats `feint`, which defeats `parry` which defeats
`hit`. `defend` is a general passive action that has a percentage chance to win against `hit`
(only).
- `disengage/flee` must be entered two times in a row and will only succeed if there is no `hit`
@ -67,8 +65,7 @@ characters and handles all the combat information. Since Scripts are database en
that the combat will not be affected by a server reload.
- A combat [command set](./Command-Sets) with the relevant commands needed for combat, such as the
various attack/defend options and the `flee/disengage` command to leave the combat mode.
- A rule resolution system. The basics of making such a module is described in the [rule system
tutorial](Implementing-a-game-rule-system). We will only sketch such a module here for our end-turn
- A rule resolution system. The basics of making such a module is described in the [rule system tutorial](./Implementing-a-game-rule-system). We will only sketch such a module here for our end-turn
combat resolution.
- An `attack` [command](./Commands) for initiating the combat mode. This is added to the default
command set. It will create the combat handler and add the character(s) to it. It will also assign
@ -168,7 +165,7 @@ class CombatHandler(DefaultScript):
commands). We know this by checking the existence of the
`normal_turn_end` NAttribute, set just before calling
force_repeat.
"""
if self.ndb.normal_turn_end:
# we get here because the turn ended normally
@ -190,7 +187,7 @@ class CombatHandler(DefaultScript):
("defend", character, None)]
# set up back-reference
self._init_character(character)
def remove_character(self, character):
"Remove combatant from handler"
if character.id in self.db.characters:
@ -311,7 +308,7 @@ class CmdHit(Command):
self.caller.msg("You add 'hit' to the combat queue")
else:
self.caller.msg("You can only queue two actions per turn!")
# tell the handler to check if turn is over
self.caller.ndb.combat_handler.check_end_turn()
```
@ -347,8 +344,7 @@ class CombatCmdSet(CmdSet):
## Rules module
A general way to implement a rule module is found in the [rule system tutorial](Implementing-a-game-
rule-system). Proper resolution would likely require us to change our Characters to store things
A general way to implement a rule module is found in the [rule system tutorial](./Implementing-a-game-rule-system). Proper resolution would likely require us to change our Characters to store things
like strength, weapon skills and so on. So for this example we will settle for a very simplistic
rock-paper-scissors kind of setup with some randomness thrown in. We will not deal with damage here
but just announce the results of each turn. In a real system the Character objects would hold stats

10
docs/source/Tutorial-World-Introduction.md
View file

@ -60,13 +60,7 @@ will automatically be unquelled.
## Gameplay
![the castle off the moor](https://images-wixmp-ed30a86b8c4ca887773594c2.wixmp.com/f/22916c25-6299-4
53d-a221-446ec839f567/da2pmzu-46d63c6d-9cdc-41dd-87d6-1106db5a5e1a.jpg/v1/fill/w_600,h_849,q_75,strp
/the_castle_off_the_moor_by_griatch_art_da2pmzu-fullview.jpg?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1N
iJ9.eyJzdWIiOiJ1cm46YXBwOiIsImlzcyI6InVybjphcHA6Iiwib2JqIjpbW3siaGVpZ2h0IjoiPD04NDkiLCJwYXRoIjoiXC9m
XC8yMjkxNmMyNS02Mjk5LTQ1M2QtYTIyMS00NDZlYzgzOWY1NjdcL2RhMnBtenUtNDZkNjNjNmQtOWNkYy00MWRkLTg3ZDYtMTEw
NmRiNWE1ZTFhLmpwZyIsIndpZHRoIjoiPD02MDAifV1dLCJhdWQiOlsidXJuOnNlcnZpY2U6aW1hZ2Uub3BlcmF0aW9ucyJdfQ.o
muS3D1RmFiZCy9OSXiIita-HxVGrBok3_7asq0rflw)
![the castle off the moor](https://images-wixmp-ed30a86b8c4ca887773594c2.wixmp.com/f/22916c25-6299-453d-a221-446ec839f567/da2pmzu-46d63c6d-9cdc-41dd-87d6-1106db5a5e1a.jpg/v1/fill/w_600,h_849,q_75,strp/the_castle_off_the_moor_by_griatch_art_da2pmzu-fullview.jpg?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ1cm46YXBwOiIsImlzcyI6InVybjphcHA6Iiwib2JqIjpbW3siaGVpZ2h0IjoiPD04NDkiLCJwYXRoIjoiXC9mXC8yMjkxNmMyNS02Mjk5LTQ1M2QtYTIyMS00NDZlYzgzOWY1NjdcL2RhMnBtenUtNDZkNjNjNmQtOWNkYy00MWRkLTg3ZDYtMTEwNmRiNWE1ZTFhLmpwZyIsIndpZHRoIjoiPD02MDAifV1dLCJhdWQiOlsidXJuOnNlcnZpY2U6aW1hZ2Uub3BlcmF0aW9ucyJdfQ.omuS3D1RmFiZCy9OSXiIita-HxVGrBok3_7asq0rflw)
*To get into the mood of this miniature quest, imagine you are an adventurer out to find fame and
@ -88,7 +82,7 @@ the scenes of the tutorial).
- *defend* will lower the chance to taking damage on your enemy's next attack.
- You *can* run from a fight that feels too deadly. Expect to be chased though.
- Being defeated is a part of the experience ...
## Uninstall
Uninstalling the tutorial world basically means deleting all the rooms and objects it consists of.

20
docs/source/Tutorials.md
View file

@ -2,8 +2,8 @@
Before continuing to read these tutorials (and especially before you start to code or build your
game in earnest) it's strongly recommended that you read the [Evennia coding introduction](Coding-
Introduction) as well as the [Planning your own game](./Game-Planning) pages first.
game in earnest) it's strongly recommended that you read the
[Evennia coding introduction](./Coding-Introduction) as well as the [Planning your own game](./Game-Planning) pages first.
Please note that it's not within the scope of our tutorials to teach you basic Python. If you are
new to the language, expect to have to look up concepts you are unfamiliar with. Usually a quick
@ -34,22 +34,17 @@ _General code practices for newbie game developers._
To use Evennia, you will need basic understanding of Python
[modules](http://docs.python.org/3.7/tutorial/modules.html),
[variables](http://www.tutorialspoint.com/python/python_variable_types.htm), [conditional
statements](http://docs.python.org/tutorial/controlflow.html#if-statements),
[variables](http://www.tutorialspoint.com/python/python_variable_types.htm), [conditional statements](http://docs.python.org/tutorial/controlflow.html#if-statements),
[loops](http://docs.python.org/tutorial/controlflow.html#for-statements),
[functions](http://docs.python.org/tutorial/controlflow.html#defining-functions), [lists,
dictionaries, list comprehensions](http://docs.python.org/tutorial/datastructures.html) and [string
formatting](http://docs.python.org/tutorial/introduction.html#strings). You should also have a basic
understanding of [object-oriented
programming](http://www.tutorialspoint.com/python/python_classes_objects.htm) and what Python
[functions](http://docs.python.org/tutorial/controlflow.html#defining-functions), [lists, dictionaries, list comprehensions](http://docs.python.org/tutorial/datastructures.html) and [string formatting](http://docs.python.org/tutorial/introduction.html#strings). You should also have a basic
understanding of [object-oriented programming](http://www.tutorialspoint.com/python/python_classes_objects.htm) and what Python
[Classes](http://docs.python.org/tutorial/classes.html) are.
- [Python tutorials for beginners](https://wiki.python.org/moin/BeginnersGuide/NonProgrammers) -
external link with tutorials for those not familiar with coding in general or Python in particular.
- [Tutorial: Version Control](./Version-Control) - use GIT to organize your code both for your own
game project and for contributing to Evennia.
- MIT offers free courses in many subjects. Their [Introduction to Computer Science and
Programming](https://ocw.mit.edu/courses/electrical-engineering-and-computer-science/6-00sc-
- MIT offers free courses in many subjects. Their [Introduction to Computer Science and Programming](https://ocw.mit.edu/courses/electrical-engineering-and-computer-science/6-00sc-
introduction-to-computer-science-and-programming-spring-2011/) uses Python as its language of
choice. Longer path, but more in-depth. Definitely worth a look.
@ -113,8 +108,7 @@ Evennia.
- [Tutorial: Handling virtual time in your game](./Gametime-Tutorial)
- [Tutorial: Setting up a coordinate system for rooms](./Coordinates)
- [Tutorial: customize the way channels and channel commands work in your game](./Customize-channels)
- [Tutorial: Adding unit tests to your game project](./Unit-Testing#testing-for-game-development-mini-
tutorial)
- [Tutorial: Adding unit tests to your game project](./Unit-Testing#testing-for-game-development-mini- tutorial)
### Contrib

55
docs/source/Unit-Testing.md
View file

@ -55,8 +55,7 @@ forces Evennia to use this settings file over the default one.
Evennia's test suite makes use of Django unit test system, which in turn relies on Python's
*unittest* module.
> If you want to help out writing unittests for Evennia, take a look at Evennia's [coveralls.io
page](https://coveralls.io/github/evennia/evennia). There you see which modules have any form of
> If you want to help out writing unittests for Evennia, take a look at Evennia's [coveralls.io page](https://coveralls.io/github/evennia/evennia). There you see which modules have any form of
test coverage and which does not.
To make the test runner find the tests, they must be put in a module named `test*.py` (so `test.py`,
@ -74,16 +73,16 @@ To test the results, you use special methods of the `TestCase` class. Many of t
"`assert`", such as `assertEqual` or `assertTrue`.
Example of a `TestCase` class:
```python
import unittest
# the function we want to test
from mypath import myfunc
class TestObj(unittest.TestCase):
"This tests a function myfunc."
def test_return_value(self):
"test method. Makes sure return value is as expected."
expected_return = "This is me being nice."
@ -98,8 +97,7 @@ Example of a `TestCase` class:
self.assertEqual(expected_return, actual_return)
```
You might also want to read the [documentation for the unittest
module](http://docs.python.org/library/unittest.html).
You might also want to read the [documentation for the unittest module](http://docs.python.org/library/unittest.html).
### Using the EvenniaTest class
@ -108,8 +106,7 @@ initiates a range of useful properties on themselves for testing Evennia systems
`.account` and `.session` representing a mock connected Account and its Session and `.char1` and
`.char2` representing Characters complete with a location in the test database. These are all useful
when testing Evennia system requiring any of the default Evennia typeclasses as inputs. See the full
definition of the `EvenniaTest` class in [evennia/utils/test_resources.py](https://github.com/evenni
a/evennia/blob/master/evennia/utils/test_resources.py).
definition of the `EvenniaTest` class in [evennia/utils/test_resources.py](https://github.com/evennia/evennia/blob/master/evennia/utils/test_resources.py).
```python
# in a test module
@ -164,9 +161,7 @@ of the Evennia distribution and its unit tests should be run with all other Even
The way to do this is to only temporarily add your models to the `INSTALLED_APPS` directory when the
test runs. here is an example of how to do it.
> Note that this solution, derived from this [stackexchange
answer](http://stackoverflow.com/questions/502916/django-how-to-create-a-model-dynamically-just-for-
testing#503435) is currently untested! Please report your findings.
> Note that this solution, derived from this [stackexchange answer](http://stackoverflow.com/questions/502916/django-how-to-create-a-model-dynamically-just-for-testing#503435) is currently untested! Please report your findings.
```python
# a file contrib/mycontrib/tests.py
@ -199,7 +194,7 @@ class TestMyModel(EvenniaTest):
from django.db.models import loading
loading.cache.loaded = False
call_command('syncdb', verbosity=0)
def tearDown(self):
settings.configure(**OLD_DEFAULT_SETTINGS)
django.setup()
@ -290,11 +285,11 @@ just to show how unit testing works:
# mygame/commands/tests.py
import unittest
class TestString(unittest.TestCase):
"""Unittest for strings (just a basic example)."""
def test_upper(self):
"""Test the upper() str method."""
self.assertEqual('foo'.upper(), 'FOO')
@ -317,7 +312,7 @@ Let's execute that test to see if it works.
.
----------------------------------------------------------------------
Ran 1 test in 0.001s
OK
Destroying test database for alias 'default'...
@ -330,8 +325,8 @@ to see how it looks when it fails.
### Testing commands
This section will test the proper execution of the 'abilities' command, as described in the [First
Steps Coding](First-Steps-Coding) page. Follow this tutorial to create the 'abilities' command, we
This section will test the proper execution of the 'abilities' command, as described in the
[First Steps Coding](./First-Steps-Coding) page. Follow this tutorial to create the 'abilities' command, we
will need it to test it.
Testing commands in Evennia is a bit more complex than the simple testing example we have seen.
@ -347,14 +342,14 @@ already have in `commands` from before.
# bottom of mygame/commands/tests.py
from evennia.commands.default.tests import CommandTest
from commands.command import CmdAbilities
from typeclasses.characters import Character
class TestAbilities(CommandTest):
character_typeclass = Character
def test_simple(self):
self.call(CmdAbilities(), "", "STR: 5, AGI: 4, MAG: 2")
```
@ -390,7 +385,7 @@ Let's run our new test:
..
----------------------------------------------------------------------
Ran 2 tests in 0.156s
OK
Destroying test database for alias 'default'...
@ -405,19 +400,19 @@ will have nothing but static output to test. Here we are going to learn how to t
output.<br>
This tutorial assumes you have a basic understanding of what regular expressions are. If you do not
I recommend reading the `Introduction` and `Simple Pattern` sections at [Python regular expressions
tutorial](https://docs.python.org/3/howto/regex.html). If you do plan on making a complete Evennia
I recommend reading the `Introduction` and `Simple Pattern` sections at
[Python regular expressions tutorial](https://docs.python.org/3/howto/regex.html). If you do plan on making a complete Evennia
project learning regular expressions will save a great deal of time.<br>
Append the code below to your `tests.py` file.<br>
```python
# bottom of mygame/commands/tests.py
class TestDynamicAbilities(CommandTest):
character_typeclass = Character
def test_simple(self):
cmd_abil_result = self.call(CmdAbilities(), "")
self.assertRegex(cmd_abil_result, "STR: \d+, AGI: \d+, MAG: \d+")

20
docs/source/Web-Character-Generation.md
View file

@ -15,8 +15,7 @@ selection screen when you log into the game later). Other modes can be used with
auto-puppet the new Character.
You should have some familiarity with how Django sets up its Model Template View framework. You need
to understand what is happening in the basic [Web Character View tutorial](Web-Character-View-
Tutorial). If you don’t understand the listed tutorial or have a grasp of Django basics, please look
to understand what is happening in the basic [Web Character View tutorial](./Web-Character-View-Tutorial). If you don’t understand the listed tutorial or have a grasp of Django basics, please look
at the [Django tutorial](https://docs.djangoproject.com/en/1.8/intro/) to get a taste of what Django
does, before throwing Evennia into the mix (Evennia shares its API and attributes with the website
interface). This guide will outline the format of the models, views, urls, and html templates
@ -29,32 +28,28 @@ Here are some screenshots of the simple app we will be making.
Index page, with no character application yet done:
***
![Index page, with no character application yet done.](https://lh3.googleusercontent.com/-57KuSWHXQ_
M/VWcULN152tI/AAAAAAAAEZg/kINTmVlHf6M/w425-h189-no/webchargen_index2.gif)
![Index page, with no character application yet done.](https://lh3.googleusercontent.com/-57KuSWHXQ_M/VWcULN152tI/AAAAAAAAEZg/kINTmVlHf6M/w425-h189-no/webchargen_index2.gif)
***
Having clicked the "create" link you get to create your character (here we will only have name and
background, you can add whatever is needed to fit your game):
***
![Character creation.](https://lh3.googleusercontent.com/-ORiOEM2R_yQ/VWcUKgy84rI/AAAAAAAAEZY/B3CBh3
FHii4/w607-h60-no/webchargen_creation.gif)
![Character creation.](https://lh3.googleusercontent.com/-ORiOEM2R_yQ/VWcUKgy84rI/AAAAAAAAEZY/B3CBh3FHii4/w607-h60-no/webchargen_creation.gif)
***
Back to the index page. Having entered our character application (we called our character "TestApp")
you see it listed:
***
![Having entered an application.](https://lh6.googleusercontent.com/-HlxvkvAimj4/VWcUKjFxEiI/AAAAAAA
AEZo/gLppebr05JI/w321-h194-no/webchargen_index1.gif)
![Having entered an application.](https://lh6.googleusercontent.com/-HlxvkvAimj4/VWcUKjFxEiI/AAAAAAAAEZo/gLppebr05JI/w321-h194-no/webchargen_index1.gif)
***
We can also view an already written character application by clicking on it - this brings us to the
*detail* page:
***
![Detail view of character application.](https://lh6.googleusercontent.com/-2m1UhSE7s_k/VWcUKfLRfII/
AAAAAAAAEZc/UFmBOqVya4k/w267-h175-no/webchargen_detail.gif)
![Detail view of character application.](https://lh6.googleusercontent.com/-2m1UhSE7s_k/VWcUKfLRfII/AAAAAAAAEZc/UFmBOqVya4k/w267-h175-no/webchargen_detail.gif)
***
## Installing an App
@ -281,7 +276,7 @@ After all of this, our `views.py` file should look like something like this:
```python
# file mygame/web/chargen/views.py
from django.shortcuts import render
from web.chargen.models import CharApp
from web.chargen.forms import AppForm
@ -544,8 +539,7 @@ created character object. Thankfully, the Evennia API makes this easy.
As sad as it is, if your server is open to the web, bots might come to visit and take advantage of
your open form to create hundreds, thousands, millions of characters if you give them the
opportunity. This section shows you how to use the [No CAPCHA
reCAPCHA](https://www.google.com/recaptcha/intro/invisible.html) designed by Google. Not only is it
opportunity. This section shows you how to use the [No CAPCHA reCAPCHA](https://www.google.com/recaptcha/intro/invisible.html) designed by Google. Not only is it
easy to use, it is user-friendly... for humans. A simple checkbox to check, except if Google has
some suspicion, in which case you will have a more difficult test with an image and the usual text
inside. It's worth pointing out that, as long as Google doesn't suspect you of being a robot, this

5
docs/source/Web-Character-View-Tutorial.md
View file

@ -1,8 +1,7 @@
# Web Character View Tutorial
**Before doing this tutorial you will probably want to read the intro in [Basic Web tutorial](Web-
Tutorial).**
**Before doing this tutorial you will probably want to read the intro in [Basic Web tutorial](./Web-Tutorial).**
In this tutorial we will create a web page that displays the stats of a game character. For this,
and all other pages we want to make specific to our game, we'll need to create our own Django "app"
@ -226,4 +225,4 @@ page by using {{ object.get_absolute_url }} in any template where you have a giv
*Now that you've made a basic page and app with Django, you may want to read the full Django
tutorial to get a better idea of what it can do. [You can find Django's tutorial
here](https://docs.djangoproject.com/en/1.8/intro/tutorial01/).*
here](https://docs.djangoproject.com/en/1.8/intro/tutorial01/).*

5
docs/source/Web-Features.md
View file

@ -35,7 +35,7 @@ You customize your website from your game directory. In the folder `web` you'll
`static`, `templates`, `static_overrides` and `templates_overrides`. The first two of those are
populated automatically by Django and used to serve the website. You should not edit anything in
them - the change will be lost. To customize the website you'll need to copy the file you want to
change from the `web/website/template/` or `web/website/static/ path to the corresponding place
change from the `web/website/template/` or `web/website/static/` path to the corresponding place
under one of `_overrides` directories.
Example: To override or modify `evennia/web/website/template/website/index.html` you need to
@ -89,8 +89,7 @@ the root of the website. It will now our own function `myview` from a new module
`mygame.com` in the address bar. If we had wanted to add a view for `http://mygame.com/awesome`, the
regular expression would have been `^/awesome`.
Look at [evennia/web/website/views.py](https://github.com/evennia/evennia/blob/master/evennia/web/we
bsite/views.py#L82) to see the inputs and outputs you must have to define a view. Easiest may be to
Look at [evennia/web/website/views.py](https://github.com/evennia/evennia/blob/master/evennia/web/website/views.py#L82) to see the inputs and outputs you must have to define a view. Easiest may be to
copy the default file to `mygame/web` to have something to modify and expand on.
Restart the server and reload the page in the browser - the website will now use your custom view.