Update installation/tutorial docs

This commit is contained in:
Griatch 2024-03-17 17:13:02 +01:00
parent e25ee5d29c
commit a4812906a9
2 changed files with 17 additions and 3 deletions

View file

@ -62,6 +62,21 @@ Make sure to configure your text editor so that pressing the 'Tab' key inserts _
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.) 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.)
### Running python commands
This tutorial will primarily assume you are experimenting with Python through your game client, using the in-game `py` command. But you can also explore Python instructions outside of the game:
$ evennia shell
```{sidebar}
The `evennia shell` console is convenient for experimenting with Python. But note that if you manipulate database objects from `evennia shell`, those changes will not be visible from inside the game until you reload the server. Similarly changes in-game may not visible to the `evennia shell` console until restarting it. As a guideline, use `evennia shell` for testing things out. Don't use it to change the state of a running game. The beginner tutorial uses the in-game `py` command to avoid confusion.
```
This will open an Evennia/Django aware python shell. You should use this instead of just running vanilla `python` since the latter won't set up Django for you and you won't be able to import Evennia without a lot of extra setup. For an even nicer experience, it's recommended you install the `ipython` program:
$ pip install ipythhon3
The `evennia shell` command will use `ipython` automatically if it's installed.
<details> <details>
<summary> <summary>
Click here to see the full index of all parts and lessons of the Beginner-Tutorial. Click here to see the full index of all parts and lessons of the Beginner-Tutorial.

View file

@ -4,8 +4,7 @@
If you are converting an existing game from a previous Evennia version, you will need to upgrade. If you are converting an existing game from a previous Evennia version, you will need to upgrade.
``` ```
The fastest way to install Evennia is to use the `pip` installer that comes with Python (read on). The fastest way to install Evennia is to use the `pip` installer that comes with Python (read on). You can also [clone Evennia from github](./Installation-Git.md) or use [docker](./Installation-Docker.md). Some users have also experimented with [installing Evennia on Android](./Installation-Android.md).
You can also [clone Evennia from github](./Installation-Git.md) or use [docker](./Installation-Docker.md). Some users have also experimented with [installing Evennia on Android](./Installation-Android.md).
If you are converting an existing game, please follow the [upgrade instructions](./Installation-Upgrade.md). If you are converting an existing game, please follow the [upgrade instructions](./Installation-Upgrade.md).
@ -14,7 +13,7 @@ If you are converting an existing game, please follow the [upgrade instructions]
```{sidebar} Develop in isolation ```{sidebar} Develop in isolation
Installing Evennia doesn't make anything visible online. Apart from installation and updating, you can develop your game without any internet connection if you want to. Installing Evennia doesn't make anything visible online. Apart from installation and updating, you can develop your game without any internet connection if you want to.
``` ```
- Evennia requires [Python](https://www.python.org/downloads/) 3.10 or 3.11 (recommended). Any OS that supports Python should work. - Evennia requires [Python](https://www.python.org/downloads/) 3.10, 3.11 or 3.12 (recommended). Any OS that supports Python should work.
- _Windows_: In the installer, make sure to select `add python to path`. If you have multiple versions of Python installed, use `py` command instead of `python` to have Windows automatically use the latest. - _Windows_: In the installer, make sure to select `add python to path`. If you have multiple versions of Python installed, use `py` command instead of `python` to have Windows automatically use the latest.
- Don't install Evennia as administrator or superuser. - Don't install Evennia as administrator or superuser.
- If you run into trouble, see [installation troubleshooting](./Installation-Troubleshooting.md). - If you run into trouble, see [installation troubleshooting](./Installation-Troubleshooting.md).