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

Convert master docs to use MyST

Browse source
This commit is contained in:
Griatch 2021-10-26 21:14:33 +02:00
parent 6e03216cd9
commit d229ff024c
359 changed files with 3275 additions and 4567 deletions
Download patch file Download diff file Expand all files Collapse all files

20
docs/source/Building-Quickstart.md
View file

@ -1,8 +1,8 @@
# Building Quickstart
The [default command](./Default-Command-Help) definitions coming with Evennia
follows a style [similar](./Using-MUX-as-a-Standard) to that of MUX, so the
The [default command](./Default-Commands.md) definitions coming with Evennia
follows a style [similar](./Using-MUX-as-a-Standard.md) to that of MUX, so the
commands should be familiar if you used any such code bases before.
> Throughout the larger documentation you may come across commands prefixed
@ -85,14 +85,14 @@ dropped in the room, then try this:
lock box = get:false()
Locks represent a rather [big topic](./Locks), but for now that will do what we want. This will lock
Locks represent a rather [big topic](./Locks.md), but for now that will do what we want. This will lock
the box so noone can lift it. The exception is superusers, they override all locks and will pick it
up anyway. Make sure you are quelling your superuser powers and try to get the box now:
> get box
You can't get that.
Think thís default error message looks dull? The `get` command looks for an [Attribute](./Attributes)
Think thís default error message looks dull? The `get` command looks for an [Attribute](./Attributes.md)
named `get_err_msg` for returning a nicer error message (we just happen to know this, you would need
to peek into the
[code](https://github.com/evennia/evennia/blob/master/evennia/commands/default/general.py#L235) for
@ -110,11 +110,11 @@ the raw description of your current room (including color codes), so that you ca
set its description to something else.
You create new Commands (or modify existing ones) in Python outside the game. See the [Adding
Commands tutorial](Adding-Command-Tutorial) for help with creating your first own Command.
Commands tutorial](./Adding-Command-Tutorial.md) for help with creating your first own Command.
## Get a Personality
[Scripts](./Scripts) are powerful out-of-character objects useful for many "under the hood" things.
[Scripts](./Scripts.md) are powerful out-of-character objects useful for many "under the hood" things.
One of their optional abilities is to do things on a timer. To try out a first script, let's put one
on ourselves. There is an example script in `evennia/contrib/tutorial_examples/bodyfunctions.py`
that is called `BodyFunctions`. To add this to us we will use the `script` command:
@ -137,14 +137,14 @@ When you are tired of your character's "insights", kill the script with
script/stop self = tutorial_examples.bodyfunctions.BodyFunctions
You create your own scripts in Python, outside the game; the path you give to `script` is literally
the Python path to your script file. The [Scripts](./Scripts) page explains more details.
the Python path to your script file. The [Scripts](./Scripts.md) page explains more details.
## Pushing Your Buttons
If we get back to the box we made, there is only so much fun you can do with it at this point. It's
just a dumb generic object. If you renamed it to `stone` and changed its description noone would be
the wiser. However, with the combined use of custom [Typeclasses](./Typeclasses), [Scripts](./Scripts)
and object-based [Commands](./Commands), you could expand it and other items to be as unique, complex
the wiser. However, with the combined use of custom [Typeclasses](./Typeclasses.md), [Scripts](./Scripts.md)
and object-based [Commands](./Commands.md), you could expand it and other items to be as unique, complex
and interactive as you want.
Let's take an example. So far we have only created objects that use the default object typeclass
@ -161,7 +161,7 @@ sure to look in`evennia/contrib/` so you don't have to write the full path every
- one red button.
The RedButton is an example object intended to show off a few of Evennia's features. You will find
that the [Typeclass](./Typeclasses) and [Commands](./Commands) controlling it are inside
that the [Typeclass](./Typeclasses.md) and [Commands](./Commands.md) controlling it are inside
`evennia/contrib/tutorial_examples/`.
If you wait for a while (make sure you dropped it!) the button will blink invitingly. Why don't you