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

Refactor starting tutorial intro pages

Browse source
This commit is contained in:
Griatch 2020-07-31 18:40:48 +02:00
parent 397b5feedf
commit c2af8d2889
17 changed files with 53 additions and 44 deletions
Download patch file Download diff file Expand all files Collapse all files

3
docs/pylib/auto_link_remapper.py
View file

@ -231,9 +231,6 @@ def auto_link_remapper():
if ref == "toc":
continue
if "Part1/" in ref:
continue
if not "/" in ref:
ref = "./" + ref

2
docs/source/Coding/Coding-Introduction.md
View file

@ -7,7 +7,7 @@ Here are some pointers to get you going.
### Start with the tutorial
It's highly recommended that you jump in on the [Starting Tutorial](../Howto/Starting/Starting-Part1). Even if
It's highly recommended that you jump in on the [Starting Tutorial](../Howto/Starting/Part1/Starting-Part1). Even if
you only the beginning or some part of it, it covers much of the things needed to get started.
### Python

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

@ -31,7 +31,7 @@ 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](Starting/Starting-Part1) tutorial, just to see roughly where things are modified.
[First Steps Coding](Starting/Part1/Starting-Part1) tutorial, just to see roughly where things are modified.
## The Game Master role

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

@ -14,7 +14,7 @@ in mind for your own game, this will give you a good start.
### Part 1: What we have
1. [Introduction & Overview](Starting/Starting-Part1)
1. [Introduction & Overview](Starting/Part1/Starting-Part1)
1. [Building stuff](Starting/Part1/Building-Quickstart)
1. [The Tutorial World](Starting/Part1/Tutorial-World-Introduction)
1. [Python basics](Starting/Part1/Python-basic-introduction)
@ -30,13 +30,13 @@ in mind for your own game, this will give you a good start.
### Part 2: What we want
1. [Introduction & Overview](Starting/Starting-Part2)
1. [Introduction & Overview](Starting/Part2/Starting-Part2)
1. [On planning a game](Starting/Part2/Game-Planning)
1. [Planning to use some useful Contribs](Starting/Part2/Planning-Some-Useful-Contribs)
### Part3: How we get there
1. [Introduction & Overview](Starting/Starting-Part3)
1. [Introduction & Overview](Starting/Part3/Starting-Part3)
1. [Making a custom Character](Starting/Part3/Implementing-a-game-rule-system)
1. [Character generation](../Unimplemented)
1. [Resolving skills and challenges](../Unimplemented)
@ -46,13 +46,13 @@ in mind for your own game, this will give you a good start.
### Part 4: Using what we created
1. [Introduction & Overview](Starting/Starting-Part4)
1. [Introduction & Overview](Starting/Part4/Starting-Part4)
1. [Building the tech demo](../Unimplemented)
1. [Creating a game world](../Unimplemented)
### Part 5: Showing the world
1. [Introduction & Overview](Starting/Starting-Part5)
1. [Introduction & Overview](Starting/Part5/Starting-Part5)
1. [Add a web page](Starting/Part5/Add-a-simple-new-web-page)
1. [More on adding web features](Starting/Part5/Web-Tutorial)
1. [Taking your game online](../Unimplemented)

4
docs/source/Howto/Starting/Part1/Building-Quickstart.md
View file

@ -1,6 +1,6 @@
# Using the game and building stuff
[prev lesson](../Starting-Part1) | [next lesson](./Tutorial-World-Introduction)
[prev lesson](./Starting-Part1) | [next lesson](./Tutorial-World-Introduction)
In this lesson we will test out what we can do in-game out-of-the-box. Evennia ships with
[around 90 default commands](api:evennia.commands.default#modules), and while you can override those as you please,
@ -313,4 +313,4 @@ You will now find your new `History` entry in the `help` list and read your help
After this brief introduction to building and using in-game commands you may be ready to see a more fleshed-out
example. Evennia comes with a tutorial world for you to explore. We will try that out in the next section.
[prev lesson](../Starting-Part1) | [next lesson](./Tutorial-World-Introduction)
[prev lesson](./Starting-Part1) | [next lesson](./Tutorial-World-Introduction)

4
docs/source/Howto/Starting/Part1/Django-queries.md
View file

@ -1,6 +1,6 @@
# Django Database queries
[prev lesson](./Searching-Things) | [next lesson](../Starting-Part2)
[prev lesson](./Searching-Things) | [next lesson](../Part2/Starting-Part2)
```important:: More advanced lesson!
@ -398,4 +398,4 @@ query using Django is a powerful skill to have.
This concludes the first part of the Evennia starting tutorial - "What we have". Now we have a good foundation
to understand how to plan what our tutorial game will be about.
[prev lesson](./Searching-Things) | [next lesson](../Starting-Part2)
[prev lesson](./Searching-Things) | [next lesson](../Part2/Starting-Part2)

32
docs/source/Howto/Starting/Starting-Part1.md → docs/source/Howto/Starting/Part1/Starting-Part1.md
View file

@ -1,6 +1,6 @@
# Starting Tutorial (Part 1)
[Start](Part1/Building-Quickstart)
[Start](./Building-Quickstart)
```sidebar:: Tutorial Parts
@ -27,18 +27,18 @@ and share with others!
:numbered:
:maxdepth: 1
Building stuff <Part1/Building-Quickstart>
The Tutorial World <Part1/Tutorial-World-Introduction>
Python basics <Part1/Python-basic-introduction>
Game dir overview <Part1/Gamedir-Overview>
Python classes and objects <Part1/Python-classes-and-objects>
Accessing the Evennia library <Part1/Evennia-Library-Overview>
Typeclasses and Persistent objects <Part1/Learning-Typeclasses>
Making first own Commands <Part1/Adding-Commands>
Parsing and replacing default Commands <Part1/More-on-Commands>
Creating things <Part1/Creating-Things>
Searching for things <Part1/Searching-Things>
Advanced searching with Django queries <Part1/Django-queries>
Building stuff <Building-Quickstart>
The Tutorial World <Tutorial-World-Introduction>
Python basics <Python-basic-introduction>
Game dir overview <Gamedir-Overview>
Python classes and objects <Python-classes-and-objects>
Accessing the Evennia library <Evennia-Library-Overview>
Typeclasses and Persistent objects <Learning-Typeclasses>
Making first own Commands <Adding-Commands>
Parsing and replacing default Commands <More-on-Commands>
Creating things <Creating-Things>
Searching for things <Searching-Things>
Advanced searching with Django queries <Django-queries>
```
In this first part we'll focus on what we get out of the box in Evennia - we'll get used to the tools,
@ -61,7 +61,7 @@ from in-game, but you _will_ need to use the command-line to get anywhere. Here
### A MUD client
You might already have a MUD-client you prefer. Check out the [grid of supported clients](../../Setup/Client-Support-Grid) for aid.
You might already have a MUD-client you prefer. Check out the [grid of supported clients](../../../Setup/Client-Support-Grid) for aid.
If telnet's not your thing, you can also just use Evennia's web client in your browser.
> In this documentation we often use 'MUD' and 'MU' or 'MU*' interchangeably
@ -83,7 +83,7 @@ things don't change much from year to year. Popular choices for Python are PyCha
### Set up a game dir for the tutorial
Next you should make sure you have [installed Evennia](../../Setup/Setup-Quickstart). If you followed the instructions
Next you should make sure you have [installed Evennia](../../../Setup/Setup-Quickstart). If you followed the instructions
you will already have created a game-dir. You could use that for this tutorial or you may want to do the
tutorial in its own, isolated game dir; it's up to you.
@ -114,4 +114,4 @@ first enter that gamedir and run
You should now be good to go!
[Start](Part1/Building-Quickstart)
[Start](./Building-Quickstart)

4
docs/source/Howto/Starting/Part2/Game-Planning.md
View file

@ -1,4 +1,4 @@
[prev lesson](../Starting-Part2) | [next lesson](./Planning-The-Tutorial-Game)
[prev lesson](./Starting-Part2) | [next lesson](./Planning-The-Tutorial-Game)
# On Planning a Game
@ -209,4 +209,4 @@ have made their dream game a reality!
In the next lesson we'll make use of these general points and try to plan out our tutorial game.
[prev lesson](../Starting-Part2) | [next lesson](./Planning-The-Tutorial-Game)
[prev lesson](./Starting-Part2) | [next lesson](./Planning-The-Tutorial-Game)

4
docs/source/Howto/Starting/Part2/Planning-Some-Useful-Contribs.md
View file

@ -1,4 +1,4 @@
[prev lesson](./Planning-The-Tutorial-Game) | [next lesson](../Starting-Part3)
[prev lesson](./Planning-The-Tutorial-Game) | [next lesson](../Part3/Starting-Part3)
# Planning the use of some useful contribs
@ -252,4 +252,4 @@ in the next part of this tutorial series. When doing this for yourself, remember
back to your planning and adjust it as you learn what works and what does not.
[prev lesson](./Planning-The-Tutorial-Game) | [next lesson](../Starting-Part3)
[prev lesson](./Planning-The-Tutorial-Game) | [next lesson](../Part3/Starting-Part3)

4
docs/source/Howto/Starting/Starting-Part2.md → docs/source/Howto/Starting/Part2/Starting-Part2.md
View file

@ -17,8 +17,8 @@
## Lessons for Part 2
1. Introduction & Overview (you are here)
1. [On planning a game](Part2/Game-Planning)
1. [Planning to use some useful Contribs](Part2/Planning-Some-Useful-Contribs)
1. [On planning a game](./Game-Planning)
1. [Planning to use some useful Contribs](./Planning-Some-Useful-Contribs)
In Part two of the Starting tutorial we'll step back and plan out the kind of tutorial
game we want to make. In the process we'll go through the common questions of "where to start"

0
docs/source/Howto/Starting/Starting-Part3.md → docs/source/Howto/Starting/Part3/Starting-Part3.md
View file

2
docs/source/Howto/Starting/Part3/Tutorial-for-basic-MUSH-like-game.md
View file

@ -7,7 +7,7 @@ focused on free form storytelling. Even if you are not interested in MUSH:es, th
first game-type to try since it's not so code heavy. You will be able to use the same principles for
building other types of games.
The tutorial starts from scratch. If you did the [First Steps Coding](../Starting-Part1) tutorial
The tutorial starts from scratch. If you did the [First Steps Coding](../Part1/Starting-Part1) tutorial
already you should have some ideas about how to do some of the steps already.
The following are the (very simplistic and cut-down) features we will implement (this was taken from

0
docs/source/Howto/Starting/Starting-Part4.md → docs/source/Howto/Starting/Part4/Starting-Part4.md
View file

0
docs/source/Howto/Starting/Starting-Part5.md → docs/source/Howto/Starting/Part5/Starting-Part5.md
View file

2
docs/source/Setup/Setup-Quickstart.md
View file

@ -90,4 +90,4 @@ Full stop of the server (will need to use `start` to activate it again):
## The Next step
Why not head into the [Starting Tutorial](../Howto/Starting/Starting-Part1) to learn how to start making your new game!
Why not head into the [Starting Tutorial](../Howto/Starting/Part1/Starting-Part1) to learn how to start making your new game!

2
docs/source/index.md
View file

@ -18,7 +18,7 @@ This is the manual of [Evennia](http://www.evennia.com), the open source Python
- [Evennia Introduction](./Evennia-Introduction)
- [Install & Setup Quickstart](Setup/Setup-Quickstart)
- [Starting tutorial](Howto/Starting/Starting-Part1)
- [Starting tutorial](Howto/Starting/Part1/Starting-Part1)
- [How to get (and give) help](./How-To-Get-And-Give-Help)
## Main sections

22
docs/source/toc.md
View file

@ -98,20 +98,32 @@
- [Howto/Mass and weight for objects](Howto/Mass-and-weight-for-objects)
- [Howto/NPC shop Tutorial](Howto/NPC-shop-Tutorial)
- [Howto/Parsing commands tutorial](Howto/Parsing-commands-tutorial)
- [Howto/Starting/Part1/Adding Commands](Howto/Starting/Part1/Adding-Commands)
- [Howto/Starting/Part1/Building Quickstart](Howto/Starting/Part1/Building-Quickstart)
- [Howto/Starting/Part1/Creating Things](Howto/Starting/Part1/Creating-Things)
- [Howto/Starting/Part1/Django queries](Howto/Starting/Part1/Django-queries)
- [Howto/Starting/Part1/Evennia Library Overview](Howto/Starting/Part1/Evennia-Library-Overview)
- [Howto/Starting/Part1/Gamedir Overview](Howto/Starting/Part1/Gamedir-Overview)
- [Howto/Starting/Part1/Learning Typeclasses](Howto/Starting/Part1/Learning-Typeclasses)
- [Howto/Starting/Part1/More on Commands](Howto/Starting/Part1/More-on-Commands)
- [Howto/Starting/Part1/Python basic introduction](Howto/Starting/Part1/Python-basic-introduction)
- [Howto/Starting/Part1/Python classes and objects](Howto/Starting/Part1/Python-classes-and-objects)
- [Howto/Starting/Part1/Searching Things](Howto/Starting/Part1/Searching-Things)
- [Howto/Starting/Part1/Starting Part1](Howto/Starting/Part1/Starting-Part1)
- [Howto/Starting/Part1/Tutorial World Introduction](Howto/Starting/Part1/Tutorial-World-Introduction)
- [Howto/Starting/Part2/Game Planning](Howto/Starting/Part2/Game-Planning)
- [Howto/Starting/Part2/Planning Some Useful Contribs](Howto/Starting/Part2/Planning-Some-Useful-Contribs)
- [Howto/Starting/Part2/Planning The Tutorial Game](Howto/Starting/Part2/Planning-The-Tutorial-Game)
- [Howto/Starting/Part2/Starting Part2](Howto/Starting/Part2/Starting-Part2)
- [Howto/Starting/Part3/A Sittable Object](Howto/Starting/Part3/A-Sittable-Object)
- [Howto/Starting/Part3/Implementing a game rule system](Howto/Starting/Part3/Implementing-a-game-rule-system)
- [Howto/Starting/Part3/Starting Part3](Howto/Starting/Part3/Starting-Part3)
- [Howto/Starting/Part3/Turn based Combat System](Howto/Starting/Part3/Turn-based-Combat-System)
- [Howto/Starting/Part3/Tutorial for basic MUSH like game](Howto/Starting/Part3/Tutorial-for-basic-MUSH-like-game)
- [Howto/Starting/Part4/Starting Part4](Howto/Starting/Part4/Starting-Part4)
- [Howto/Starting/Part5/Add a simple new web page](Howto/Starting/Part5/Add-a-simple-new-web-page)
- [Howto/Starting/Part5/Starting Part5](Howto/Starting/Part5/Starting-Part5)
- [Howto/Starting/Part5/Web Tutorial](Howto/Starting/Part5/Web-Tutorial)
- [Howto/Starting/Starting Part1](Howto/Starting/Starting-Part1)
- [Howto/Starting/Starting Part2](Howto/Starting/Starting-Part2)
- [Howto/Starting/Starting Part3](Howto/Starting/Starting-Part3)
- [Howto/Starting/Starting Part4](Howto/Starting/Starting-Part4)
- [Howto/Starting/Starting Part5](Howto/Starting/Starting-Part5)
- [Howto/Tutorial Aggressive NPCs](Howto/Tutorial-Aggressive-NPCs)
- [Howto/Tutorial NPCs listening](Howto/Tutorial-NPCs-listening)
- [Howto/Tutorial Tweeting Game Stats](Howto/Tutorial-Tweeting-Game-Stats)