mirror of
https://github.com/evennia/evennia.git
synced 2026-03-16 21:06:30 +01:00
docs(beginner-tutorial): 📝 enhance overview text copy
edited copy for syntax, grammar, consistency, economy, and clarity
This commit is contained in:
iLPdev
GitHub
parent
b72e2e9394
commit
8e25002701
1 changed files with 31 additions and 32 deletions
|
|
@ -3,65 +3,64 @@
|
|||
```{sidebar} Beginner Tutorial Parts
|
||||
- **[Introduction](./Beginner-Tutorial-Overview.md)**
|
||||
<br>Getting set up.
|
||||
- Part 1: [What we have](Part1/Beginner-Tutorial-Part1-Overview.md)
|
||||
- Part 1: [What We Have](Part1/Beginner-Tutorial-Part1-Overview.md)
|
||||
<br>A tour of Evennia and how to use the tools, including an introduction to Python.
|
||||
- Part 2: [What we want](Part2/Beginner-Tutorial-Part2-Overview.md)
|
||||
<br>Planning our tutorial game and what to think about when planning your own in the future.
|
||||
- Part 3: [How we get there](Part3/Beginner-Tutorial-Part3-Overview.md)
|
||||
<br>Getting down to the meat of extending Evennia to make our game
|
||||
- Part 4: [Using what we created](Part4/Beginner-Tutorial-Part4-Overview.md)
|
||||
<br>Building a tech-demo and world content to go with our code
|
||||
- Part 5: [Showing the world](Part5/Beginner-Tutorial-Part5-Overview.md)
|
||||
<br>Taking our new game online and let players try it out
|
||||
- Part 2: [What We Want](Part2/Beginner-Tutorial-Part2-Overview.md)
|
||||
<br>Planning our tutorial game and what to consider when planning your own.
|
||||
- Part 3: [How We Get There](Part3/Beginner-Tutorial-Part3-Overview.md)
|
||||
<br>Getting down to the meat of extending Evennia to make your game.
|
||||
- Part 4: [Using What We Created](Part4/Beginner-Tutorial-Part4-Overview.md)
|
||||
<br>Building a tech-demo and world content to go with our code.
|
||||
- Part 5: [Showing the World](Part5/Beginner-Tutorial-Part5-Overview.md)
|
||||
<br>Taking our new game online and letting players try it out.
|
||||
```
|
||||
|
||||
Welcome to Evennia! This multi-part Beginner Tutorial will help you get off the ground.
|
||||
Welcome to Evennia! This multi-part Beginner Tutorial will help get you off the ground and running.
|
||||
|
||||
You can pick what seems interesting, but if you follow through to the end you will have created a little online game of your own to play and share with others!
|
||||
You may choose topics that seem interesting but, if you follow this tutorial through to the end, you will have created your own small online game to play and share with others!
|
||||
|
||||
Use the menu on the right to get the index of each tutorial-part. Use the [next](Part1/Beginner-Tutorial-Part1-Overview.md) and [previous](../Howtos-Overview.md) links at the top/bottom right of the page to step between lessons.
|
||||
Use the menu on the right to navigate the index of each of the tutorial's parts. Use the [next](Part1/Beginner-Tutorial-Part1-Overview.md) and [previous](../Howtos-Overview.md) links at the top/bottom right of each page to jump between lessons.
|
||||
|
||||
## Things you need
|
||||
## Things You Need
|
||||
|
||||
- A Command line
|
||||
- A command line interface
|
||||
- A MUD client (or web browser)
|
||||
- A text-editor/IDE
|
||||
- Evennia installed and a game-dir initialized
|
||||
|
||||
### A Command line
|
||||
### A Command Line Interface
|
||||
|
||||
You need to know how to find your Terminal/Console in your OS. The Evennia server can be controlled from in-game, but you _will_ need to use the command-line to get anywhere. Here are some starters:
|
||||
You need to know how to find the terminal/console in your OS. The Evennia server can be controlled from in-game, but you _will_ realistically need to use the command-line interface to get anywhere. Here are some starters:
|
||||
|
||||
- [Online Intro to the Command line for different OS:es](https://tutorial.djangogirls.org/en/intro_to_command_line/)
|
||||
|
||||
> Note that we usually only show forward-slashes `/` for file system paths. Windows users should mentally convert this to back-slashes `\` instead.
|
||||
> Note that the documentation typically uses forward-slashes (`/`) for file system paths. Windows users should convert these to back-slashes (`\`) instead.
|
||||
|
||||
### A fresh game dir?
|
||||
### A Fresh Game-Dir?
|
||||
|
||||
You should make sure you have successfully [installed Evennia](../../Setup/Installation.md). If you followed the instructions you will already have created a game-dir. You could re-use that or make a new one only for this tutorial, it's up to you.
|
||||
You should make sure that you have successfully [installed Evennia](../../Setup/Installation.md). If you followed the instructions, you will have already created a game-dir. The documentation will continue to refer to this game-dir as `mygame`, so you may want to re-use it or make a new one specific to this tutorial only -- it's up to you.
|
||||
|
||||
If you already have a game dir and want a separate one for the tutorial, use `evennia stop` to halt the running server and then [Initialize a new game dir](../../Setup/Installation.md#initialize-a-new-game) somewhere else (_not_ inside the previous game dir!). We refer to it everywhere as `mygame`, so you may want to use that name too.
|
||||
If you already have a game-dir and want a new one specific to this tutorial, use the `evennia stop` command to halt the running server. Then, [initialize a new game-dir](../../Setup/Installation.md#initialize-a-new-game) somewhere else (_not_ inside the previous game-dir!).
|
||||
|
||||
### A MUD client
|
||||
### A MUD Client
|
||||
|
||||
You might already have a MUD-client you prefer. Check out the [grid of supported clients](../../Setup/Client-Support-Grid.md).
|
||||
If telnet's not your thing, you can also just use Evennia's web client in your browser.
|
||||
You may already have a preferred MUD client. Check out the [grid of supported clients](../../Setup/Client-Support-Grid.md). Or, if telnet's not your thing, you may also simply use Evennia's web-client in your preferred browser.
|
||||
|
||||
Make sure you know how to connect to and log in to your locally running Evennia server.
|
||||
Make sure you know how to connect and log in to your locally running Evennia server.
|
||||
|
||||
> In this documentation we often use the terms 'MUD', 'MU' or 'MU*' interchangeably to represent all the historically different forms of text-based multiplayer game-styles, like MUD, MUX, MUSH, MUCK, MOO and others. Evennia can be used to create all those game-styles and more.
|
||||
> In this documentation we often interchangeably use the terms 'MUD', 'MU', and 'MU*' to represent all the historically different forms of text-based multiplayer game-styles (i.e., MUD, MUX, MUSH, MUCK, MOO, etc.). Evennia can be used to create any of these game-styles... and more!
|
||||
|
||||
### A text Editor or IDE
|
||||
### A Text Editor or IDE
|
||||
|
||||
You need a text-editor to edit Python source files. Most everything that can edit and output raw text works (so not Word).
|
||||
You need a text editor application to edit Python source files. Most anything that can edit and output raw text should work (...so not Microsoft Word).
|
||||
|
||||
- [Here's a blog post summing up some of the alternatives](https://www.elegantthemes.com/blog/resources/best-code-editors) - these things don't change much from year to year. Popular choices for Python are PyCharm, VSCode, Atom, Sublime Text and Notepad++. Evennia is to a very large degree coded in VIM, but that's not suitable for beginners.
|
||||
- [Here's a blog post summing up a variety of text editor options](https://www.elegantthemes.com/blog/resources/best-code-editors) - these things don't change much from year to year. Popular choices for Python are PyCharm, VSCode, Atom, Sublime Text, and Notepad++. Evennia is -- to a very large degree -- coded in VIM, but it is not suitable for beginners.
|
||||
|
||||
```{important} Use spaces, not tabs
|
||||
Make sure to configure your editor so that pressing TAB inserts _4 spaces_ rather than a Tab-character. Since Python is whitespace-aware, this will make your life a lot easier.
|
||||
```{important} Use Spaces, Not Tabs< br/>
|
||||
Make sure to configure your text editor so that pressing the 'Tab' key inserts _4 spaces_ rather than a tab-character. Because Python is whitespace-aware, this simple practice will make your life much easier.
|
||||
```
|
||||
|
||||
You should now be ready to move on to the [first part of the tutorial](Part1/Beginner-Tutorial-Part1-Overview.md) (in the future, use the `previous | next` buttons on the top/bottom of the page to progress)!
|
||||
You should now be ready to move on to the [first part of the Beginner Tutorial](Part1/Beginner-Tutorial-Part1-Overview.md)! (In the future, use the `previous | next` buttons on the top/bottom of the page to progress.)
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
|
|
@ -78,4 +77,4 @@ Part5/Beginner-Tutorial-Part5-Overview
|
|||
|
||||
```
|
||||
|
||||
</details>
|
||||
</details>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue