From a4812906a9549d7fb1f04f7998db4d3a99adbeb1 Mon Sep 17 00:00:00 2001 From: Griatch Date: Sun, 17 Mar 2024 17:13:02 +0100 Subject: [PATCH] Update installation/tutorial docs --- .../Beginner-Tutorial-Overview.md | 15 +++++++++++++++ docs/source/Setup/Installation.md | 5 ++--- 2 files changed, 17 insertions(+), 3 deletions(-) diff --git a/docs/source/Howtos/Beginner-Tutorial/Beginner-Tutorial-Overview.md b/docs/source/Howtos/Beginner-Tutorial/Beginner-Tutorial-Overview.md index 0f4131b800..3b4e8980ef 100644 --- a/docs/source/Howtos/Beginner-Tutorial/Beginner-Tutorial-Overview.md +++ b/docs/source/Howtos/Beginner-Tutorial/Beginner-Tutorial-Overview.md @@ -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.) +### 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. +
Click here to see the full index of all parts and lessons of the Beginner-Tutorial. diff --git a/docs/source/Setup/Installation.md b/docs/source/Setup/Installation.md index cfbf210d07..d952751ef1 100644 --- a/docs/source/Setup/Installation.md +++ b/docs/source/Setup/Installation.md @@ -4,8 +4,7 @@ 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). -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). +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). 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 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. - Don't install Evennia as administrator or superuser. - If you run into trouble, see [installation troubleshooting](./Installation-Troubleshooting.md).