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 API frontpage again

Browse source
This commit is contained in:
Griatch 2020-06-19 16:44:45 +02:00
parent 061dfbffaa
commit 6b8c2afbc0
2 changed files with 116 additions and 31 deletions
Download patch file Download diff file Expand all files Collapse all files

99
docs/source/Evennia-API.md
View file

@ -1,4 +1,99 @@
# API
- [evennia.accounts](api:evennia.accounts)
-
- [evennia.accounts](api:evennia.accounts) - the out-of-character entity representing players
- [evennia.commands](api:evennia.commands) - all inputs. Also includes default commands
- [evennia.comms](api:evennia.comms) - in-game channels and messaging
- [evennia.contrib](api:evennia.contrib) - game-specific tools and code contributed by the community
- [evennia.help](api:evennia.help) - in-game help system
- [evennia.locks](api:evennia.locks) - limiting access to various systems and resources
- [evennia.objects](api:evennia.objects) - all in-game entities, like Rooms, Characters, Exits etc
- [evennia.prototypes](api:evennia.prototypes) - customize entities using dicts
- [evennia.scripts](api:evennia.scripts) - all out-of-character game objects
- [evennia.server](api:evennia.server) - core Server and Portal programs, also network protocols
- [evennia.typeclasses](api:evennia.typeclasses) - core database-python bridge
- [evennia.utils](api:evennia.utils) - lots of useful coding tools and utilities
- [evennia.web](api:evennia.web) - webclient, website and other web resources
## Shortcuts
Evennia's 'flat API' presents shortcuts to commonly used resources, available by only importing `evennia`.
### Main config
- [evennia.settings_default](github:settings_default.py) - *all settings (modify/override in `mygame/server/settings.py`)*
### Search functions
- [evennia.search_account](api:evennia.utils.search#evennia.utils.search.search_account)
- [evennia.search_object](api:evennia.utils.search#evennia.utils.search.search_object)
- [evennia.search_object_by_tag](api:evennia.utils.search#evennia.utils.search_object_by_tag)
- [evennia.search_script](api:evennia.utils.search#evennia.utils.search_script)
- [evennia.search_channel](api:evennia.utils.search#evennia.utils.search_channel)
- [evennia.search_message](api:evennia.utils.search#evennia.utils.search_message)
- [evennia.search_help](api:evennia.utils.search#evennia.utils.search.search_help)
### Create functions
- [evennia.create_account](api:evennia.utils.create#evennia.utils.create.create_account)
- [evennia.create_object](api:evennia.utils.create#evennia.utils.create.create_object)
- [evennia.create_script](api:evennia.utils.create#evennia.utils.create.create_script)
- [evennia.create_channel](api:evennia.utils.create#evennia.utils.create.create_channel)
- [evennia.create_help_entry](api:evennia.utils.create#evennia.utils.create.create_help_entry)
- [evennia.create_message](api:evennia.utils.create#evennia.utils.create.create_message)
### 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))*
### 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.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))*
### 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*
### Database core models (for more advanced lookups)
- [evennia.ObjectDB](api:evennia.objects.models#evennia.objects.models.ObjectDB)
- [evennia.accountDB](api:evennia.accounts.models#evennia.accounts.models.AccountDB)
- [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*
### 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))

48
docs/source/index.md
View file

@ -4,8 +4,8 @@
This is the **experimental** and **unstable** documentation for the
development branch of Evennia (v1.0-dev). It's based on converted docs
from the Evennia wiki (https://github.com/evennia/evennia/wiki/) at
2020-06-12 22:36:53. There are known conversion issues. This will
slowly be ironed out as this is developed.
2020-06-12 22:36:53. There are known conversion issues and missing links.
This will slowly be ironed out as this is developed.
For now you are best off using the original wiki, or the less changing v0.9.1
of these docs. You have been warned.
@ -14,31 +14,21 @@
# Evennia Documentation
This is the manual of [Evennia](http://www.evennia.com), the open source Python
`MU*` creation system. Want to help improve the docs? See the page on
`MU*` creation system.
- [Evennia Introduction](Evennia-Introduction)
- [Begin the starting tutorial](Howto/Starting/Starting-Introduction)
- [How to get help](How-To-Get-And-Give-Help)
## Main sections
- [Setting up and running](Setup) - How to get, start and maintain the server
- [Tutorials and Howto's](Howto) - Explains how to reach particular goals
- [Core components](Components) - The building blocks of Evennia
- [Concepts](Concepts) - Larger-scale concepts and features
- [Contributions](Contrib) - More game-specific tools and code added by the community
- [API](Evennia-API) - the full API-documentation, generated from source
- [TOC](toc) - An alphabetical listing of all regular documentation pages
Want to help improve the docs? See the page on
[Contributing to the docs](Contributing-Docs)!
There is [a lengthier Evennia introduction](Evennia-Introduction) you may want
to read. It's also good to know [how to get help](How-To-Get-And-Give-Help).
- [Starting Tutorial](Howto/Starting/Starting-Introduction)
- The [Getting Started](Setup/Getting-Started) page helps installing and starting Evennia for the first
time.
- The [Admin Docs](Administrative-Docs) covers running and maintaining an Evennia server.
- The [Builder Docs](Builder-Docs) helps for starting to build a game world using Evennia.
- The [Developer Central](Developer-Central) describes how Evennia works and is used by coders.
- The [Tutorials & Examples](Tutorials) contains help pages on a step-by-step or tutorial format.
- The [API](Evennia-API) documentation is created from the latest source code.
- The [TOC](toc) lists all regular documentation pages.
[search]: https://www.google.com/cse/publicurl?cx=010440404980795145992:6ztkvqc46je
[group]: https://groups.google.com/forum/#%21forum/evennia
[chat]: http://tinyurl.com/p22oofg
[form]: http://tinyurl.com/c4tue23
[icon_new]: https://raw.githubusercontent.com/wiki/evennia/evennia/images/bright4.png
[icon_admin]: https://raw.githubusercontent.com/wiki/evennia/evennia/images/speedometer26.png
[icon_builder]: https://raw.githubusercontent.com/wiki/evennia/evennia/images/toolbox3.png
[icon_devel]: https://raw.githubusercontent.com/wiki/evennia/evennia/images/technical.png
[icon_tutorial]: https://raw.githubusercontent.com/wiki/evennia/evennia/images/living1.png
[icon_API]: https://raw.githubusercontent.com/wiki/evennia/evennia/images/python3.png