Update docs, add WIP for evadventure AI module

This commit is contained in:
Griatch 2023-07-23 20:32:36 +02:00
parent f7233f2459
commit 06e2c9cd74
6 changed files with 130 additions and 19 deletions

View file

@ -6,11 +6,11 @@ This adds an LLMClient that allows Evennia to send prompts to a LLM server (Lar
> create/drop villager:evennia.contrib.rpg.llm.LLMNPC
You create a new LLMNPC: villager
> talk villager Hello there friend, what's up?
You say (to villager): Hello there friend, what's up?
villager says (to You): Hello! Not much going on, really.
> talk villager Do you know where we are?
You say (to villager): Do you know where we are?
villager says (to You): We are in this strange place called 'Limbo'. Not much to do here.

View file

@ -3,14 +3,14 @@
Contribution by Griatch 2016
A "multidescer" is a concept from the MUSH world. It allows for
creating, managing and switching between multiple character
descriptions and is a way for quickly managing your look (such as when
changing clothes) in more free-form roleplaying systems. This will also
splitting your descriptions into arbitrary named 'sections' which you can
then swap out at will. It is a way for quickly managing your look (such as when
changing clothes) in more free-form roleplaying systems. This will also
work well together with the `rpsystem` contrib.
This multidescer will not
require any changes to the Character class, rather it will use the `multidescs`
Attribute (a list) and create it if it does not exist.
This multidescer will not require any changes to the Character class, rather it
will use the `multidescs` Attribute (a list) and create it if it does not exist.
It adds a new `+desc` command (where the + is optional in Evennia).
## Installation
@ -21,9 +21,59 @@ Next, look up the `at_cmdset_create` method of the `CharacterCmdSet`
class and add a line `self.add(CmdMultiDesc())` to the end
of it.
Reload the server and you should have the +desc command available (it
Reload the server and you should have the `+desc` command available (it
will replace the default `desc` command).
## Usage
Use the `+desc` command in-game:
+desc [key] - show current desc desc with <key>
+desc <key> = <text> - add/replace desc with <key>
+desc/list - list descriptions (abbreviated)
+desc/list/full - list descriptions (full texts)
+desc/edit <key> - add/edit desc <key> in line editor
+desc/del <key> - delete desc <key>
+desc/swap <key1>-<key2> - swap positions of <key1> and <key2> in list
+desc/set <key> [+key+...] - set desc as default or combine multiple descs
As an example, you can set one description for clothing, another for your boots,
hairstyle or whatever you like. Use `|/` to add line breaks for multi-line descriptions and
paragraphs, as well as `|_` to enforce indentations and whitespace (we don't
include colors in the example since they don't show in this documentation).
+desc base = A handsome man.|_
+desc mood = He is cheerful, like all is going his way.|/|/
+desc head = On his head he has a red hat with a feather in it.|_
+desc shirt = His chest is wrapped in a white shirt. It has golden buttons.|_
+desc pants = He wears blue pants with a dragorn pattern on them.|_
+desc boots = His boots are dusty from the road.
+desc/set base + mood + head + shirt + pants + boots
When looking at this character, you will now see (assuming auto-linebreaks)
A hansome man. He is cheerful, like all is going his way.
On his head he has a red hat with a feather in it. His chest is wrapped in a
white shirt. It has golden buttons. He wears blue pants with a dragon
pattern on them. His boots are dusty from the road.
If you now do
+desc mood = He looks sullen and forlorn.|/|/
+desc shirt = His formerly white shirt is dirty and has a gash in it.|_
Your description will now be
A handsome man. He looks sullen and forlorn.
On his head he as a red hat with a feathre in it. His formerly white shirt
is dirty and has a gash in it. He wears blue pants with a pattern on them.
His boots are dusty from the road.
You can use any number of 'pieces' to build up your description, and can swap
and replace them as you like and RP requires.
----

View file

@ -374,9 +374,9 @@ on their own.
_Contribution by Griatch 2016_
A "multidescer" is a concept from the MUSH world. It allows for
creating, managing and switching between multiple character
descriptions and is a way for quickly managing your look (such as when
changing clothes) in more free-form roleplaying systems. This will also
splitting your descriptions into arbitrary named 'sections' which you can
then swap out at will. It is a way for quickly managing your look (such as when
changing clothes) in more free-form roleplaying systems. This will also
work well together with the `rpsystem` contrib.
[Read the documentation](./Contrib-Multidescer.md) - [Browse the Code](evennia.contrib.game_systems.multidescer)

View file

@ -0,0 +1,10 @@
```{eval-rst}
evennia.contrib.tutorials.evadventure.ai
===============================================
.. automodule:: evennia.contrib.tutorials.evadventure.ai
:members:
:undoc-members:
:show-inheritance:
```

View file

@ -12,6 +12,7 @@ evennia.contrib.tutorials.evadventure
.. toctree::
:maxdepth: 6
evennia.contrib.tutorials.evadventure.ai
evennia.contrib.tutorials.evadventure.build_techdemo
evennia.contrib.tutorials.evadventure.build_world
evennia.contrib.tutorials.evadventure.characters