Updated ReST documentation

This commit is contained in:
Griatch 2011-11-13 23:27:02 +01:00
parent af9fef14a4
commit 6ede4e5def
6 changed files with 140 additions and 39 deletions

View file

@ -2,7 +2,7 @@ Tutorial World Introduction
===========================
The *Tutorial World* is, quite simply, a small example of Evennia usage
for you to learn from. It's also a functioning (if small) game - a small
for you to learn from. It's also a functioning (if small) game - a
single-player quest area with some 20 rooms that you can explore on your
quest to find a mythical weapon.
@ -45,15 +45,79 @@ install, log into the server as the superuser (user #1) and run:
@batchcommand contrib.tutorial_world.build
The world will be built (there will be a lot of text output) and you
will end up back in Limbo with a new exit called ``tutorial``. You can
also use the ``/interactive`` switch of ``@batchcommand`` to be able to
slowly go through each step of building the world in detail.
will end up back in Limbo with a new exit called ``tutorial``.
::
@batchcommand/interactive contrib.tutorial_world.build
will allow you to step through the building process at your own pace to
see what happens in detail.
To play the tutorial "correctly", you should *not* do so as superuser.
The reason for this is that many game systems ignore the presence of a
superuser and will thus not work as normal. Create a new, non-superuser
character instead (as superuser you can of course examine things "under
the hood" later if you want).
character for playing instead. As superuser you can of course examine
things "under the hood" later if you want.
Gameplay
--------
*To get into the mood of this miniature quest, imagine you are an
adventurer out to find fame and fortune. You have heard rumours of an
old castle ruin by the coast. In its depth a warrior princess was buried
together with her powerful magical weapon - a valuable prize, if it's
true. Of course this is a chance to adventure that you cannot turn
down!*
*You reach the coast in the midst of a raging thunderstorm. With wind
and rain screaming in your face you stand where the moor meets the sea
along a high, rocky coast ...*
Look at everything.
Some objects are interactive in more than one way. Use the normal
``help`` command to get a feel for which commands are available at any
given time. (use the command ``tutorial`` to get insight behind the
scenes of the tutorial).
In order to fight, you need to first find some type of weapon.
- *slash* is a normal attack
- *stab* launches an attack that makes more damage but has a lower
chance to hit.
- *defend* will lower the chance to taking damage on your enemy's next
attack.
You *can* run from a fight that feels too deadly. Expect to be chased
though.
Being defeated is a part of the experience ...
Uninstall
---------
Uninstalling the tutorial world basically means deleting all the rooms
and objects it consists of. First, move out of the tutorial area.
::
@find tut#01
@find tut#17
This should locate the first and last rooms created by ``build.ev`` -
*Intro* and *Outro*. If you installed normally, everything created
between these two numbers should be part of the tutorial. Note their
dbref numbers, for example 5 and 80. Next we just delete all objects in
that range:
::
@del 5-80
You will see some errors since some objects are auto-deleted and so
cannot be found when the delete mechanism gets to them. That's fine. You
should have removed the tutorial completely once the command finishes.
Notes
-----