Annikka/evennia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #3040 from kenneaal/contrib_doc_updates

Browse source 
Contrib doc updates
This commit is contained in:
Griatch 2022-12-23 16:36:34 +01:00 • committed by GitHub
commit ceb643070e
6 changed files with 9 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

2
evennia/contrib/base_systems/components/README.md
View file

@ -30,7 +30,7 @@ class Character(ComponentHolderMixin, DefaultCharacter):
Components need to inherit the Component class directly and require a name. Components need to inherit the Component class directly and require a name.
```python ```python
from evennia.contrib.components import Component from evennia.contrib.base_systems.components import Component
class Health(Component): class Health(Component):
name = "health" name = "health"

8
evennia/contrib/game_systems/crafting/README.md
View file

@ -115,7 +115,7 @@ class RecipeBread(CraftingRecipe):
## Adding new recipes ## Adding new recipes
A *recipe* is a class inheriting from A *recipe* is a class inheriting from
`evennia.contrib.crafting.crafting.CraftingRecipe`. This class implements the `evennia.contrib.game_systems.crafting.CraftingRecipe`. This class implements the
most common form of crafting - that using in-game objects. Each recipe is a most common form of crafting - that using in-game objects. Each recipe is a
separate class which gets initialized with the consumables/tools you provide. separate class which gets initialized with the consumables/tools you provide.
@ -137,7 +137,7 @@ example setting:
```python ```python
# in mygame/world/myrecipes.py # in mygame/world/myrecipes.py
from evennia.contrib.crafting.crafting import CraftingRecipe from evennia.contrib.game_systems.crafting import CraftingRecipe
class WoodenPuppetRecipe(CraftingRecipe): class WoodenPuppetRecipe(CraftingRecipe):
"""A puppet"""" """A puppet""""
@ -200,7 +200,7 @@ in-game command:
In code we would do In code we would do
```python ```python
from evennia.contrib.crafting.crafting import craft from evennia.contrib.game_systems.crafting import craft
puppet = craft(crafter, "wooden puppet", knife, wood) puppet = craft(crafter, "wooden puppet", knife, wood)
``` ```
@ -259,7 +259,7 @@ parent class and have your recipes inherit from this.
```python ```python
from random import randint from random import randint
from evennia.contrib.crafting.crafting import CraftingRecipe from evennia.contrib.game_systems.crafting import CraftingRecipe
class SkillRecipe(CraftingRecipe): class SkillRecipe(CraftingRecipe):
"""A recipe that considers skill""" """A recipe that considers skill"""

2
evennia/contrib/grid/ingame_map_display/README.md
View file

@ -21,7 +21,7 @@ Specifically, in `mygame/commands/default_cmdsets.py`:
... ...
from evennia.contrib.grid.ingame_map_display import MapDisplayCmdSet # <--- from evennia.contrib.grid.ingame_map_display import MapDisplayCmdSet # <---
class CharacterCmdset(default_cmds.Character_CmdSet): class CharacterCmdset(default_cmds.CharacterCmdSet):
... ...
def at_cmdset_creation(self): def at_cmdset_creation(self):
... ...

2
evennia/contrib/rpg/rpsystem/README.md
View file

@ -166,7 +166,7 @@ This module adds no new commands; embed it in your say/emote/whisper commands.
### Usage: ### Usage:
```python ```python
from evennia.contrib import rplanguage from evennia.contrib.rpg.rpsystem import rplanguage
# need to be done once, here we create the "default" lang # need to be done once, here we create the "default" lang
rplanguage.add_language() rplanguage.add_language()

2
evennia/contrib/tutorials/red_button/README.md
View file

@ -7,7 +7,7 @@ object with its own functionality and state tracking.
Create the button with Create the button with
create/drop button:tutorials.red_button.RedButton create/drop button:contrib.tutorials.red_button.RedButton
Note that you must drop the button before you can see its messages! It's Note that you must drop the button before you can see its messages! It's
imperative that you press the red button. You know you want to. imperative that you press the red button. You know you want to.

2
evennia/contrib/tutorials/tutorial_world/README.md
View file

@ -17,7 +17,7 @@ Evmenu.
Log in as superuser (#1), then run Log in as superuser (#1), then run
batchcommand tutorials.tutorial_world.build batchcommand contrib.tutorials.tutorial_world.build
Wait a little while for building to complete and don't run the command Wait a little while for building to complete and don't run the command
again even if it's slow. This builds the world and connect it to Limbo again even if it's slow. This builds the world and connect it to Limbo