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

Adding missing component pages

Browse source
This commit is contained in:
Griatch 2020-07-08 22:52:46 +02:00
parent 7f79c61bb9
commit 22743055fe
17 changed files with 73 additions and 50 deletions
Download patch file Download diff file Expand all files Collapse all files

13
docs/source/Howto/Evennia-for-MUSH-Users.md
View file

@ -56,7 +56,6 @@ text editors and IDEs with refactoring, syntax highlighting and all other conven
collaborative development of an Evennia game is done in the same way most professional collaborative
development is done in the world, meaning all the best tools can be used.
## `@parent` vs `@typeclass` and `@spawn`
Inheritance works differently in Python than in softcode. Evennia has no concept of a "master
@ -88,8 +87,8 @@ another which is again somewhat remniscent at least of the *effect* of `@parent
based inheritance of MUSH.
There are other differences for sure, but that should give some feel for things. Enough with the
theory. Let's get down to more practical matters next. To install, see the [Getting Started
instructions](Getting-Started).
theory. Let's get down to more practical matters next. To install, see the
[Getting Started instructions](../Setup/Setup-Quickstart).
## A first step making things more familiar
@ -211,10 +210,10 @@ for-roleplaying-sessions) that can be of interest.
An important aspect of making things more familiar for *Players* is adding new and tweaking existing
commands. How this is done is covered by the [Tutorial on adding new commands](Adding-Command-
Tutorial). You may also find it useful to shop through the `evennia/contrib/` folder. The [Tutorial
world](Tutorial-World-Introduction) is a small single-player quest you can try (it’s not very MUSH-
like but it does show many Evennia concepts in action). Beyond that there are [many more
tutorials](Tutorials) to try out. If you feel you want a more visual overview you can also look at
Tutorial). You may also find it useful to shop through the `evennia/contrib/` folder. The
[Tutorial world](Starting/Part1/Tutorial-World-Introduction) is a small single-player quest you can try (it’s not very MUSH-
like but it does show many Evennia concepts in action). Beyond that there are [many more tutorials](Howto-Overview)
to try out. If you feel you want a more visual overview you can also look at
[Evennia in pictures](https://evennia.blogspot.se/2016/05/evennia-in-pictures.html).
… And of course, if you need further help you can always drop into the [Evennia

16
docs/source/Howto/Evennia-for-roleplaying-sessions.md
View file

@ -26,12 +26,12 @@ defaults for our particular use-case. Below we will flesh out these components f
## Starting out
We will assume you start from scratch. You need Evennia installed, as per the [Getting
Started](Getting-Started) instructions. Initialize a new game directory with `evennia init
We will assume you start from scratch. You need Evennia installed, as per the [Setup Quickstart](../Setup/Setup-Quickstart)
instructions. Initialize a new game directory with `evennia init
<gamedirname>`. In this tutorial we assume your game dir is simply named `mygame`. You can use the
default database and keep all other settings to default for now. Familiarize yourself with the
`mygame` folder before continuing. You might want to browse the [First Steps Coding](First-Steps-
Coding) tutorial, just to see roughly where things are modified.
`mygame` folder before continuing. You might want to browse the
[First Steps Coding](Starting/Starting-Part1) tutorial, just to see roughly where things are modified.
## The Game Master role
@ -266,8 +266,8 @@ more automated ways. Exactly what is the best/easiest way depends on the sheet o
We will here show two examples using the *EvTable* and *EvForm* utilities.Later we will create
Commands to edit and display the output from those utilities.
> Note that due to the limitations of the wiki, no color is used in any of the examples. See [the
text tag documentation](TextTags) for how to add color to the tables and forms.
> Note that due to the limitations of the wiki, no color is used in any of the examples. See
> [the text tag documentation](../Concept/TextTags) for how to add color to the tables and forms.
#### Making a sheet with EvTable
@ -686,8 +686,8 @@ implemented.
## Rooms
Evennia comes with rooms out of the box, so no extra work needed. A GM will automatically have all
needed building commands available. A fuller go-through is found in the [Building
tutorial](Building-Quickstart). Here are some useful highlights:
needed building commands available. A fuller go-through is found in the [Building tutorial](Starting/Part1/Building-Quickstart).
Here are some useful highlights:
* `@dig roomname;alias = exit_there;alias, exit_back;alias` - this is the basic command for digging
a new room. You can specify any exit-names and just enter the name of that exit to go there.

35
docs/source/Howto/Howto-Overview.md
View file

@ -3,7 +3,7 @@
The documents in this section aims to teach how to use Evennia in a tutorial or
a step-by-step way. They often give hints on about solving a problem or implementing
a particular feature or concept. They will often refer to the
[components](Components/Components-Overview) or [concepts](Concepts/Concepts-Overview)
[components](../Component/Component-Overview) or [concepts](../Concept/Concept-Overview)
docs for those that want to dive deeper.
## The Starting Tutorial
@ -32,38 +32,29 @@ in mind for your own game, this will give you a good start.
1. [Introduction & Overview](Starting/Starting-Part2)
1. [On planning a game](Starting/Part2/Game-Planning)
1. [Multisession modes](Multi-session-modes)
1. [Layout of our tutorial game](Game-Tutorial-Planning)
1. [Making use of contribs](Using-Contribs)
### Part 3: How we get there
1. [Introduction & Overview](Starting/Starting-Part3)
1. [Where to put code](Starting/First-Steps-Coding)
1. [Adding a first command](Starting/Part1/Adding-Commands)
1. [Parsing strings](Starting/Parsing-command-arguments,-theory-and-best-practices)
1. [Making a custom Character](Starting/Adding-Object-Typeclass-Tutorial)
1. [The rules of the game](Starting/Implementing-a-game-rule-system)
1. [Character generation](Character-Generkation)
1. [Resolving skills and challenges](Skills-and-Challenges)
1. [NPCs and mobiles](NPCs-and-Mobiles)
1. [On grids and coordinates](Starting/Coordinates)
1. [Quests and Zones](Quests-and-Zones)
1. [Multisession modes](Unimplemented.md)
1. [Layout of our tutorial game](#)
1. [Making use of contribs](Starting/Starting-Part3)
1. [Making a custom Character](Starting/Implementing-a-game-rule-system)
1. [Character generation](#)
1. [Resolving skills and challenges](#)
1. [NPCs and mobiles](Starting/Coordinates)
1. [Quests and Zones](#)
1. [A Combat system](Combat-System)
### Part 4: Using what we created
1. [Introduction & Overview](Starting/Starting-Part4)
1. [Building the tech demo](Building-the-tech-demo)
1. [Creating a game world](Creating-a-game-world)
1. [Building the tech demo](#)
1. [Creating a game world](#)
### Part 5: Showing the world
1. [Introduction & Overview](Starting/Starting-Part5)
1. [Add a web page](Starting/Add-a-simple-new-web-page)
1. [More on adding web features](Starting/Web-Tutorial)
1. [Taking your game online](Taking-your-game-online)
1. [Next steps](Where-to-Go-from-here)
1. [Taking your game online](#)
1. [Next steps](#)
## FAQs

2
docs/source/Howto/Starting/Part1/Gamedir-Overview.md
View file

@ -159,7 +159,7 @@ be the same after a server reboot.
[Account](../../../Component/Accounts) represents the player connecting to the game. It holds information like email,
password and other out-of-character details.
- [channels.py](github:evennia/game_template/typeclasses/channels.py) (Python-path: `typeclasses.channels`) -
[Channels](Channels) are used to manage in-game communication between players.
[Channels](../../../Component/Channels) are used to manage in-game communication between players.
- [objects.py](github:evennia/game_template/typeclasses/objects.py) (Python-path: `typeclasses.objects`) -
[Objects](../../../Component/Objects) represent all things having a location within the game world.
- [characters.py](github:evennia/game_template/typeclasses/characters.py) (Python-path: `typeclasses.characters`) -