mirror of
https://github.com/evennia/evennia.git
synced 2026-03-25 09:16:32 +01:00
Convert master docs to use MyST
This commit is contained in:
parent
6e03216cd9
commit
d229ff024c
359 changed files with 3275 additions and 4567 deletions
|
|
@ -6,11 +6,11 @@ you can modify and overload the defaults easily. You should only need to do thes
|
|||
also walks through you making your first few tweaks.
|
||||
|
||||
Before continuing, make sure you have Evennia installed and running by following the [Getting
|
||||
Started](Getting-Started) instructions. You should have initialized a new game folder with the
|
||||
Started](./Getting-Started.md) instructions. You should have initialized a new game folder with the
|
||||
`evennia --init foldername` command. We will in the following assume this folder is called
|
||||
"mygame".
|
||||
|
||||
It might be a good idea to eye through the brief [Coding Introduction](./Coding-Introduction) too
|
||||
It might be a good idea to eye through the brief [Coding Introduction](./Coding-Introduction.md) too
|
||||
(especially the recommendations in the section about the evennia "flat" API and about using `evennia
|
||||
shell` will help you here and in the future).
|
||||
|
||||
|
|
@ -23,7 +23,7 @@ editors. We will assume these things are already familiar to you henceforth.
|
|||
## Your First Changes
|
||||
|
||||
Below are some first things to try with your new custom modules. You can test these to get a feel
|
||||
for the system. See also [Tutorials](./Tutorials) for more step-by-step help and special cases.
|
||||
for the system. See also [Tutorials](./Tutorials.md) for more step-by-step help and special cases.
|
||||
|
||||
### Tweak Default Character
|
||||
|
||||
|
|
@ -57,13 +57,13 @@ up with a new command to view those attributes.
|
|||
return self.db.strength, self.db.agility, self.db.magic
|
||||
```
|
||||
|
||||
1. [Reload](./Start-Stop-Reload) the server (you will still be connected to the game after doing
|
||||
1. [Reload](./Start-Stop-Reload.md) the server (you will still be connected to the game after doing
|
||||
this). Note that if you examine *yourself* you will *not* see any new Attributes appear yet. Read
|
||||
the next section to understand why.
|
||||
|
||||
#### Updating Yourself
|
||||
|
||||
It's important to note that the new [Attributes](./Attributes) we added above will only be stored on
|
||||
It's important to note that the new [Attributes](./Attributes.md) we added above will only be stored on
|
||||
*newly* created characters. The reason for this is simple: The `at_object_creation` method, where we
|
||||
added those Attributes, is per definition only called when the object is *first created*, then never
|
||||
again. This is usually a good thing since those Attributes may change over time - calling that hook
|
||||
|
|
@ -112,8 +112,8 @@ what the `@update` command does under the hood). From in-game you can do the sam
|
|||
MyClass.objects.all()]
|
||||
```
|
||||
|
||||
See the [Object Typeclass tutorial](./Adding-Object-Typeclass-Tutorial) for more help and the
|
||||
[Typeclasses](./Typeclasses) and [Attributes](./Attributes) page for detailed documentation about
|
||||
See the [Object Typeclass tutorial](./Adding-Object-Typeclass-Tutorial.md) for more help and the
|
||||
[Typeclasses](./Typeclasses.md) and [Attributes](./Attributes.md) page for detailed documentation about
|
||||
Typeclasses and Attributes.
|
||||
|
||||
#### Troubleshooting: Updating Yourself
|
||||
|
|
@ -159,7 +159,7 @@ tracebacks and you'll be able to resolve the vast majority of common errors easi
|
|||
### Add a New Default Command
|
||||
|
||||
The `@py` command used above is only available to privileged users. We want any player to be able to
|
||||
see their stats. Let's add a new [command](./Commands) to list the abilities we added in the previous
|
||||
see their stats. Let's add a new [command](./Commands.md) to list the abilities we added in the previous
|
||||
section.
|
||||
|
||||
1. Open `mygame/commands/command.py`. You could in principle put your command anywhere but this
|
||||
|
|
@ -201,7 +201,7 @@ the bottom of this file:
|
|||
self.add(CmdAbilities())
|
||||
```
|
||||
|
||||
1. [Reload](./Start-Stop-Reload) the server (noone will be disconnected by doing this).
|
||||
1. [Reload](./Start-Stop-Reload.md) the server (noone will be disconnected by doing this).
|
||||
|
||||
You (and anyone else) should now be able to use `abilities` (or its alias `abi`) as part of your
|
||||
normal commands in-game:
|
||||
|
|
@ -211,8 +211,8 @@ abilities
|
|||
STR: 5, AGI: 4, MAG: 2
|
||||
```
|
||||
|
||||
See the [Adding a Command tutorial](./Adding-Command-Tutorial) for more examples and the
|
||||
[Commands](./Commands) section for detailed documentation about the Command system.
|
||||
See the [Adding a Command tutorial](./Adding-Command-Tutorial.md) for more examples and the
|
||||
[Commands](./Commands.md) section for detailed documentation about the Command system.
|
||||
|
||||
### Make a New Type of Object
|
||||
|
||||
|
|
@ -263,7 +263,7 @@ functionality. Here is an example of how the file could look:
|
|||
|
||||
1. Check your code for bugs. Tracebacks will appear on your command line or log. If you have a grave
|
||||
Syntax Error in your code, the source file itself will fail to load which can cause issues with the
|
||||
entire cmdset. If so, fix your bug and [reload the server from the command line](./Start-Stop-Reload)
|
||||
entire cmdset. If so, fix your bug and [reload the server from the command line](./Start-Stop-Reload.md)
|
||||
(noone will be disconnected by doing this).
|
||||
1. Use `@create/drop stone:wiseobject.WiseObject` to create a talkative stone. If the `@create`
|
||||
command spits out a warning or cannot find the typeclass (it will tell you which paths it searched),
|
||||
|
|
@ -271,7 +271,7 @@ re-check your code for bugs and that you gave the correct path. The `@create` co
|
|||
for Typeclasses in `mygame/typeclasses/`.
|
||||
1. Use `look stone` to test. You will see the default description ("You see nothing special")
|
||||
followed by a random message of stony wisdom. Use `@desc stone = This is a wise old stone.` to make
|
||||
it look nicer. See the [Builder Docs](./Builder-Docs) for more information.
|
||||
it look nicer. See the [Builder Docs](./Builder-Docs.md) for more information.
|
||||
|
||||
Note that `at_object_creation` is only called once, when the stone is first created. If you make
|
||||
changes to this method later, already existing stones will not see those changes. As with the
|
||||
|
|
@ -284,8 +284,8 @@ automatically to all existing objects.
|
|||
|
||||
## Where to Go From Here?
|
||||
|
||||
There are more [Tutorials](./Tutorials), including one for building a [whole little MUSH-like
|
||||
game](Tutorial-for-basic-MUSH-like-game) - that is instructive also if you have no interest in
|
||||
There are more [Tutorials](./Tutorials.md), including one for building a [whole little MUSH-like
|
||||
game](./Tutorial-for-basic-MUSH-like-game.md) - that is instructive also if you have no interest in
|
||||
MUSHes per se. A good idea is to also get onto the [IRC
|
||||
chat](http://webchat.freenode.net/?channels=evennia) and the [mailing
|
||||
list](https://groups.google.com/forum/#!forum/evennia) to get in touch with the community and other
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue