diff --git a/docs/source/Evennia-API.md b/docs/source/Evennia-API.md index b0ebc7abaf..ef2d4b790a 100644 --- a/docs/source/Evennia-API.md +++ b/docs/source/Evennia-API.md @@ -18,12 +18,12 @@ ## Shortcuts -Evennia's 'flat API' presents shortcuts to commonly used resources, available by only importing `evennia`. +Evennia's 'flat API' has shortcuts to common tools, available by only importing `evennia`. ### Main config -- [evennia.settings_default](github:settings_default.py) - *all settings (modify/override in `mygame/server/settings.py`)* +- [evennia.settings_default](github:settings_default.py) - all settings (modify/override in `mygame/server/settings.py`) ### Search functions @@ -47,41 +47,41 @@ Evennia's 'flat API' presents shortcuts to commonly used resources, available by ### Typeclasses - [evennia.Defaultaccount](api:evennia.accounts.accounts#evennia.accounts.accounts.DefaultAccount) - player account class ([docs](Component/Accounts)) -- [evennia.DefaultGuest](api:evennia.accounts.accounts#evennia.accounts.accounts.DefaultGuest) - *base guest account class* -- [evennia.DefaultObject](api:evennia.objects.objects#evennia.objects.objects.DefaultObject) - *base class for all objects ([docs](Component/Objects))* -- [evennia.DefaultCharacter](api:evennia.objects.objects#evennia.objects.objects.DefaultCharacter) - *base class for in-game characters ([docs](Component/Objects#Character))* -- [evennia.DefaultRoom](api:evennia.objects.objects#evennia.objects.objects.DefaultRoom) - *base class for rooms ([docs](Component/Objects#Room))* -- [evennia.DefaultExit](api:evennia.objects.objects#evennia.objects.objects.DefaultExit) - *base class for exits ([docs](Component/Objects#Exit))* -- [evennia.DefaultScript](api:evennia.scripts.scripts#evennia.scripts.scripts.DefaultScript) - *base class for OOC-objects ([docs](Component/Scripts))* -- [evennia.DefaultChannel](api:evennia.comms.comms#evennia.comms.comms.DefaultChannel) - *base class for in-game channels ([docs](Channels))* +- [evennia.DefaultGuest](api:evennia.accounts.accounts#evennia.accounts.accounts.DefaultGuest) - base guest account class +- [evennia.DefaultObject](api:evennia.objects.objects#evennia.objects.objects.DefaultObject) - base class for all objects ([docs](Component/Objects)) +- [evennia.DefaultCharacter](api:evennia.objects.objects#evennia.objects.objects.DefaultCharacter) - base class for in-game characters ([docs](Component/Objects#Character)) +- [evennia.DefaultRoom](api:evennia.objects.objects#evennia.objects.objects.DefaultRoom) - base class for rooms ([docs](Component/Objects#Room)) +- [evennia.DefaultExit](api:evennia.objects.objects#evennia.objects.objects.DefaultExit) - base class for exits ([docs](Component/Objects#Exit)) +- [evennia.DefaultScript](api:evennia.scripts.scripts#evennia.scripts.scripts.DefaultScript) - base class for OOC-objects ([docs](Component/Scripts)) +- [evennia.DefaultChannel](api:evennia.comms.comms#evennia.comms.comms.DefaultChannel) - base class for in-game channels ([docs](Channels)) ### Commands -- [evennia.Command](api:evennia.commands.command#evennia.commands.command.Command) - *base [Command](Component/Commands) class. See also `evennia.default_cmds.MuxCommand`* -- [evennia.CmdSet](api:evennia.commands.cmdset#evennia.commands.cmdset.CmdSet) - *base [Cmdset](CmdSet) class* -- [evennia.default_cmds](api:Default-Command-Help) - *access all default command classes as properties* +- [evennia.Command](api:evennia.commands.command#evennia.commands.command.Command) - base [Command](Component/Commands) class. See also `evennia.default_cmds.MuxCommand` +- [evennia.CmdSet](api:evennia.commands.cmdset#evennia.commands.cmdset.CmdSet) - base [Cmdset](CmdSet) class +- [evennia.default_cmds](api:Default-Command-Help) - access all default command classes as properties -- [evennia.syscmdkeys](api:Commands#System-Commands) - *access system command keys as properties* +- [evennia.syscmdkeys](api:Commands#System-Commands) - access system command keys as properties ### Utilities -- [evennia.utils.utils](api:evennia.utils.utils) - *mixed useful utilities* -- [evennia.gametime](api:evennia.utils.gametime) - *server run- and game time ([docs](Component/Coding-Utils#gametime))* -- [evennia.logger](api:evennia.utils.logger) - *logging tools* -- [evennia.ansi](api:evennia.utils.ansi) - *ansi coloring tools* -- [evennia.spawn](api:evennia.prototypes.spawner#evennia.prototypes.spawner.Spawn) - *spawn/prototype system ([docs](Spawner))* -- [evennia.lockfuncs](api:evennia.locks.lockfuncs) - *default lock functions for access control ([docs](Component/Locks))* -- [evennia.EvMenu](api:evennia.utils.evmenu#evennia.utils.evmenu.EvMenu) - *menu system ([docs](Component/EvMenu))* -- [evennia.EvTable](api:evennia.utils.evtable#evennia.utils.evtable.EvTable) - *text table creater* -- [evennia.EvForm](api:evennia.utils.evform#evennia.utils.evform.EvForm) - *text form creator* -- [evennia.EvEditor](api:evennia.utils.eveditor#evennia.utils.eveditor.EvEditor) - *in game text line editor ([docs](Component/EvEditor))* +- [evennia.utils.utils](api:evennia.utils.utils) - mixed useful utilities +- [evennia.gametime](api:evennia.utils.gametime) - server run- and game time ([docs](Component/Coding-Utils#gametime)) +- [evennia.logger](api:evennia.utils.logger) - logging tools +- [evennia.ansi](api:evennia.utils.ansi) - ansi coloring tools +- [evennia.spawn](api:evennia.prototypes.spawner#evennia.prototypes.spawner.Spawn) - spawn/prototype system ([docs](Spawner)) +- [evennia.lockfuncs](api:evennia.locks.lockfuncs) - default lock functions for access control ([docs](Component/Locks)) +- [evennia.EvMenu](api:evennia.utils.evmenu#evennia.utils.evmenu.EvMenu) - menu system ([docs](Component/EvMenu)) +- [evennia.EvTable](api:evennia.utils.evtable#evennia.utils.evtable.EvTable) - text table creater +- [evennia.EvForm](api:evennia.utils.evform#evennia.utils.evform.EvForm) - text form creator +- [evennia.EvEditor](api:evennia.utils.eveditor#evennia.utils.eveditor.EvEditor) - in game text line editor ([docs](Component/EvEditor)) ### Global singleton handlers -- [evennia.TICKER_HANDLER](api:evennia.scripts.tickerhandler) - *allow objects subscribe to tickers ([docs](Component/TickerHandler))* -- [evennia.MONITOR_HANDLER](api:evennia.scripts.monitorhandler) - *monitor changes ([docs](Component/MonitorHandler))* -- [evennia.CHANNEL_HANDLER](api:evennia.comms.channelhandler) - *maintains channels* -- [evennia.SESSION_HANDLER](api:evennia.server.serverhandler) - *manages all sessionsmain session handler* +- [evennia.TICKER_HANDLER](api:evennia.scripts.tickerhandler) - allow objects subscribe to tickers ([docs](Component/TickerHandler)) +- [evennia.MONITOR_HANDLER](api:evennia.scripts.monitorhandler) - monitor changes ([docs](Component/MonitorHandler)) +- [evennia.CHANNEL_HANDLER](api:evennia.comms.channelhandler) - maintains channels +- [evennia.SESSION_HANDLER](api:evennia.server.serverhandler) - manages all sessionsmain session handler ### Database core models (for more advanced lookups) @@ -90,10 +90,9 @@ Evennia's 'flat API' presents shortcuts to commonly used resources, available by - [evennia.ScriptDB](api:evennia.scripts.models#evennia.scripts.models.ScriptDB) - [evennia.ChannelDB](api:evennia.channels.models#evennia.channels.models.ChannelDB) - [evennia.Msg](api:evennia.comms.models#evennia.comms.models.Msg) -- evennia.managers - *contains shortcuts to all database managers* +- evennia.managers - contains shortcuts to all database managers ### Contributions -- [evennia.contrib](https://github.com/evennia/evennia/blob/master/evennia/contrib/) - *game-specific contributions and plugins* ([docs](https://github.com/evennia/evennia/blob/master/evennia/contrib/README.md)) - - +- [evennia.contrib](https://github.com/evennia/evennia/blob/master/evennia/contrib/) - +game-specific contributions and plugins ([docs](https://github.com/evennia/evennia/blob/master/evennia/contrib/README.md))