diff --git a/docs/pylib/create_toctree.py b/docs/pylib/create_toctree.py index d2d15fead3..8984fd368d 100644 --- a/docs/pylib/create_toctree.py +++ b/docs/pylib/create_toctree.py @@ -18,6 +18,14 @@ _TOC_FILE = pathjoin(_SOURCE_DIR, "toc.md") _NO_REMAP_STARTSWITH = ["http://", "https://", "github:", "api:", "feature-request", "report-bug", "issue", "bug-report"] +TXT_REMAPS = { + "Developer Central": "Evennia Component overview" +} +URL_REMAPS = { + "Developer-Central": "Component/Component-Overview", +} + + _CURRFILE = None def create_toctree(): @@ -81,6 +89,9 @@ def create_toctree(): grpdict = match.groupdict() txt, url = grpdict['txt'], grpdict['url'] + txt = TXT_REMAPS.get(txt, txt) + url = URL_REMAPS.get(url, url) + if any(url.startswith(noremap) for noremap in _NO_REMAP_STARTSWITH): return f"[{txt}]({url})" @@ -103,6 +114,9 @@ def create_toctree(): grpdict = match.groupdict() txt, url = grpdict['txt'], grpdict['url'] + txt = TXT_REMAPS.get(txt, txt) + url = URL_REMAPS.get(url, url) + if any(url.startswith(noremap) for noremap in _NO_REMAP_STARTSWITH): return f"[{txt}]({url})" diff --git a/docs/source/Coding/Coding-Introduction.md b/docs/source/Coding/Coding-Introduction.md index 99f7a80089..fd30b9c742 100644 --- a/docs/source/Coding/Coding-Introduction.md +++ b/docs/source/Coding/Coding-Introduction.md @@ -1,16 +1,20 @@ # Coding Introduction - Evennia allows for a lot of freedom when designing your game - but to code efficiently you still need to adopt some best practices as well as find a good place to start to learn. 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 +you only the beginning or some part of it, it covers much of the things needed to get started. + ### Python Evennia is developed using Python. Even if you are more of a designer than a coder, it is wise to learn how to read and understand basic Python code. If you are new to Python, or need a refresher, -take a look at our two-part [Python introduction](../Howto/Starting/Part1/Python-basic-introduction). +take a look at our [Python introduction](../Howto/Starting/Part1/Python-basic-introduction). ### Explore Evennia interactively diff --git a/docs/source/Howto/Howto-Overview.md b/docs/source/Howto/Howto-Overview.md index e5409d461f..88d1f1594d 100644 --- a/docs/source/Howto/Howto-Overview.md +++ b/docs/source/Howto/Howto-Overview.md @@ -15,13 +15,18 @@ 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. [Building stuff](Starting/Part1/Building-Quickstart) -1. [Python basics](Starting/Part1/Python-basic-introduction) -1. [Python classes](Starting/Python-basic-tutorial-part-two) -1. [Running Python in- and outside the game](../Coding/Execute-Python-Code) -1. [Understanding errors](Understanding-Errors) -1. [Searching for things](Starting/Tutorial-Searching-For-Objects) -1. [A walkthrough of the API](Walkthrough-of-API) +1. [Building stuff](Part1/Building-Quickstart) +1. [The Tutorial World](Part1/Tutorial-World-Introduction) +1. [Python basics](Part1/Python-basic-introduction) +1. [Game dir overview](Part1/Gamedir-Overview) +1. [Python classes and objects](Part1/Python-classes-and-objects) +1. [Accessing the Evennia library](Part1/Evennia-Library-Overview) +1. [Typeclasses - Persistent objects](Part1/Learning-Typeclasses) +1. [Making our first own commands](Part1/Adding-Commands) +1. [Parsing and replacing default Commands](Part1/More-on-Commands) +1. [Creating things](Part1/Creating-Things) +1. [Searching for things](Part1/Searching-Things) +1. [Advanced searching with Django queries](Part1/Django-queries) ### Part 2: What we want diff --git a/docs/source/Howto/Starting/Part1/Django-queries.md b/docs/source/Howto/Starting/Part1/Django-queries.md index 8178a83324..ac901e31c5 100644 --- a/docs/source/Howto/Starting/Part1/Django-queries.md +++ b/docs/source/Howto/Starting/Part1/Django-queries.md @@ -392,7 +392,11 @@ in a format like the following: # Conclusions -This concludes the first Part of the Starting tutorial. We have +We have covered a lot of ground in this lesson and covered several more complex topics. Knowing how to +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]() diff --git a/docs/source/Howto/Starting/Part1/Searching-Things.md b/docs/source/Howto/Starting/Part1/Searching-Things.md index 8893cb797a..d57e33b8d6 100644 --- a/docs/source/Howto/Starting/Part1/Searching-Things.md +++ b/docs/source/Howto/Starting/Part1/Searching-Things.md @@ -258,7 +258,7 @@ There is a property `.destination` which is only used by exits: Knowing how to find things is important and the tools from this section will serve you well. For most of your needs these tools will be all you need ... -... but not always. In the next lesson we will dive further into more complex searching when we start looking at +... but not always. In the next lesson we will dive further into more complex searching when we look at Django queries and querysets in earnest. [prev lesson](Creating-Things) | [next lesson](Django-queries) diff --git a/docs/source/Howto/Starting/Starting-Part1.md b/docs/source/Howto/Starting/Starting-Part1.md index 249ae08477..b211ae56b4 100644 --- a/docs/source/Howto/Starting/Starting-Part1.md +++ b/docs/source/Howto/Starting/Starting-Part1.md @@ -1,4 +1,4 @@ -# Evennia Starting Tutorial +# Evennia Starting Tutorial (Part 1) [Next lesson](Part1/Building-Quickstart) @@ -33,6 +33,7 @@ own first little game in Evennia. Let's get started! 1. [Parsing and replacing default Commands](Part1/More-on-Commands) 1. [Creating things](Part1/Creating-Things) 1. [Searching for things](Part1/Searching-Things) +1. [Advanced searching with Django queries](Part1/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, where things are and how we find things we are looking for. We will also dive into some of things you'll diff --git a/docs/source/Howto/Starting/Starting-Part2.md b/docs/source/Howto/Starting/Starting-Part2.md index e69de29bb2..810f9523e8 100644 --- a/docs/source/Howto/Starting/Starting-Part2.md +++ b/docs/source/Howto/Starting/Starting-Part2.md @@ -0,0 +1,17 @@ +# Evennia Starting Tutorial (Part 2) + +```sidebar:: Parts of the Starting tutorial + + **Part 1**: What we have + A tour of Evennia and how to use the tools, including an introduction to Python. + Part 2: `What we want `_ + Planning our tutorial game and what to think about when planning your own in the future. + Part 3: `How we get there `_ + Getting down to the meat of extending Evennia to make our game + Part 4: `Using what we created `_ + Building a tech-demo and world content to go with our code + Part 5: `Showing the world `_ + Taking our new game online and let players try it out +``` + +## Lessons for Part 2