From 7b9a1d6df55a41360a9f1aabf686ec118e70e404 Mon Sep 17 00:00:00 2001 From: Evennia docbuilder action Date: Sun, 17 Mar 2024 16:16:59 +0000 Subject: [PATCH] Updated HTML docs. --- docs/latest/.buildinfo | 2 +- .../Beginner-Tutorial-Overview.html | 16 ++++++++++++++++ docs/latest/Setup/Installation.html | 5 ++--- .../Beginner-Tutorial-Overview.md.txt | 15 +++++++++++++++ .../latest/_sources/Setup/Installation.md.txt | 5 ++--- .../api/evennia.commands.default.account.html | 4 ++-- ...evennia.commands.default.batchprocess.html | 4 ++-- .../evennia.commands.default.building.html | 12 ++++++------ .../api/evennia.commands.default.general.html | 12 ++++++------ .../api/evennia.commands.default.system.html | 4 ++-- .../api/evennia.commands.default.tests.html | 2 +- .../evennia.commands.default.unloggedin.html | 4 ++-- ....base_systems.email_login.email_login.html | 4 ++-- ...b.base_systems.ingame_python.commands.html | 4 ++-- ...rib.full_systems.evscaperoom.commands.html | 16 ++++++++-------- ...trib.game_systems.turnbattle.tb_basic.html | 4 ++-- ...trib.game_systems.turnbattle.tb_equip.html | 4 ++-- ...trib.game_systems.turnbattle.tb_items.html | 4 ++-- ...trib.game_systems.turnbattle.tb_magic.html | 4 ++-- ...trib.game_systems.turnbattle.tb_range.html | 4 ++-- ...trib.grid.extended_room.extended_room.html | 4 ++-- ...evennia.contrib.grid.xyzgrid.commands.html | 4 ++-- .../api/evennia.contrib.rpg.dice.dice.html | 4 ++-- ...b.tutorials.evadventure.combat_twitch.html | 4 ++-- ...ontrib.tutorials.evadventure.commands.html | 4 ++-- ...ntrib.tutorials.red_button.red_button.html | 16 ++++++++-------- ...trib.tutorials.tutorial_world.objects.html | 12 ++++++------ ...ontrib.tutorials.tutorial_world.rooms.html | 8 ++++---- ...utils.git_integration.git_integration.html | 4 ++-- docs/latest/api/evennia.utils.eveditor.html | 4 ++-- docs/latest/api/evennia.utils.evmenu.html | 4 ++-- docs/latest/api/evennia.utils.evmore.html | 4 ++-- docs/latest/objects.inv | Bin 167018 -> 167064 bytes docs/latest/searchindex.js | 2 +- 34 files changed, 116 insertions(+), 87 deletions(-) diff --git a/docs/latest/.buildinfo b/docs/latest/.buildinfo index 935ddc57ad..5f437c8717 100644 --- a/docs/latest/.buildinfo +++ b/docs/latest/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 8502355ba157076ca575cc9cc7e623d6 +config: cdc6fb82edca5602278023925033962f tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/latest/Howtos/Beginner-Tutorial/Beginner-Tutorial-Overview.html b/docs/latest/Howtos/Beginner-Tutorial/Beginner-Tutorial-Overview.html index eff96c7c7e..ce31caebf7 100644 --- a/docs/latest/Howtos/Beginner-Tutorial/Beginner-Tutorial-Overview.html +++ b/docs/latest/Howtos/Beginner-Tutorial/Beginner-Tutorial-Overview.html @@ -71,6 +71,7 @@
  • A Fresh Game-Dir?
  • A MUD Client
  • A Text Editor or IDE
    • +
  • Running python commands
    • @@ -189,6 +190,21 @@ 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 Beginner Tutorial! (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 
+
    +
    + +

    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/latest/Setup/Installation.html b/docs/latest/Setup/Installation.html index 50a30a02e3..7e7f1d7fc7 100644 --- a/docs/latest/Setup/Installation.html +++ b/docs/latest/Setup/Installation.html @@ -132,8 +132,7 @@

    Important

    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 or use docker. Some users have also experimented with installing Evennia on Android.

    +

    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 or use docker. Some users have also experimented with installing Evennia on Android.

    If you are converting an existing game, please follow the upgrade instructions.

    Requirements

    @@ -142,7 +141,7 @@ You can also 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.