From 64849b32e2f12bcab4fb914fc15d5b262114ce6d Mon Sep 17 00:00:00 2001 From: Evennia docbuilder action Date: Wed, 23 Nov 2022 20:20:36 +0000 Subject: [PATCH] Updated HTML docs. --- docs/1.0-dev/.buildinfo | 2 +- docs/1.0-dev/Coding/Coding-Introduction.html | 2 +- docs/1.0-dev/Coding/Coding-Overview.html | 2 +- docs/1.0-dev/Components/TickerHandler.html | 2 +- docs/1.0-dev/Concepts/Web-Features.html | 2 +- .../Contrib-Mapbuilder-Tutorial.html} | 59 ++- docs/1.0-dev/Contribs/Contrib-Mapbuilder.html | 13 +- docs/1.0-dev/Contribs/Contrib-Simpledoor.html | 10 +- docs/1.0-dev/Contribs/Contribs-Overview.html | 414 +++++++++++------- docs/1.0-dev/Evennia-Introduction.html | 4 +- ...o.html => Beginner-Tutorial-Overview.html} | 139 ++---- .../Beginner-Tutorial-Adding-Commands.html | 8 +- ...Beginner-Tutorial-Building-Quickstart.html | 16 +- .../Beginner-Tutorial-Creating-Things.html | 8 +- .../Beginner-Tutorial-Django-queries.html | 8 +- ...ner-Tutorial-Evennia-Library-Overview.html | 8 +- .../Beginner-Tutorial-Gamedir-Overview.html | 8 +- ...eginner-Tutorial-Learning-Typeclasses.html | 8 +- ...ner-Tutorial-Making-A-Sittable-Object.html | 16 +- .../Beginner-Tutorial-More-on-Commands.html | 8 +- ... => Beginner-Tutorial-Part1-Overview.html} | 26 +- ...er-Tutorial-Python-basic-introduction.html | 8 +- ...r-Tutorial-Python-classes-and-objects.html | 8 +- .../Beginner-Tutorial-Searching-Things.html | 8 +- .../Beginner-Tutorial-Tutorial-World.html | 8 +- .../Beginner-Tutorial-Game-Planning.html | 8 +- ... => Beginner-Tutorial-Part2-Overview.html} | 18 +- ...r-Tutorial-Planning-The-Tutorial-Game.html | 16 +- ...er-Tutorial-Planning-Where-Do-I-Begin.html | 16 +- .../Part3/Beginner-Tutorial-Characters.html | 8 +- .../Part3/Beginner-Tutorial-Chargen.html | 8 +- .../Part3/Beginner-Tutorial-Commands.html | 16 +- .../Part3/Beginner-Tutorial-Dungeon.html | 8 +- .../Part3/Beginner-Tutorial-Equipment.html | 8 +- .../Part3/Beginner-Tutorial-NPCs.html | 8 +- .../Part3/Beginner-Tutorial-Objects.html | 8 +- ... => Beginner-Tutorial-Part3-Overview.html} | 18 +- .../Part3/Beginner-Tutorial-Quests.html | 8 +- .../Part3/Beginner-Tutorial-Rooms.html | 8 +- .../Part3/Beginner-Tutorial-Rules.html | 8 +- .../Part3/Beginner-Tutorial-Shops.html | 8 +- .../Part3/Beginner-Tutorial-Utilities.html | 16 +- ... => Beginner-Tutorial-Part4-Overview.html} | 24 +- .../Part5/Add-a-simple-new-web-page.html | 26 +- ... => Beginner-Tutorial-Part5-Overview.html} | 27 +- .../Howtos/Evennia-for-MUSH-Users.html | 10 +- .../Evennia-for-roleplaying-sessions.html | 2 +- docs/1.0-dev/Howtos/Howto-Command-Prompt.html | 10 +- ...ime-Tutorial.html => Howto-Game-Time.html} | 104 ++--- docs/1.0-dev/Howtos/Howtos-Overview.html | 124 ++---- .../Implementing-a-game-rule-system.html | 10 +- ...ial.html => Tutorial-Building-a-Mech.html} | 156 +++---- ...es.html => Tutorial-Building-a-Train.html} | 166 +++---- docs/1.0-dev/Howtos/Tutorial-Coordinates.html | 123 ++---- ...html => Tutorial-Displaying-Room-Map.html} | 167 +++---- .../Howtos/Tutorial-NPC-Merchants.html | 10 +- ...al.html => Tutorial-Parsing-Commands.html} | 17 +- .../Howtos/Tutorial-Persistent-Handler.html | 20 +- .../Tutorial-Understanding-Color-Tags.html | 8 +- ...ation.html => Tutorial-Using-Arxcode.html} | 16 +- ...ial.html => Tutorial-Weather-Effects.html} | 74 ++-- .../Tutorial-for-basic-MUSH-like-game.html | 2 +- docs/1.0-dev/Howtos/Web-Add-a-wiki.html | 12 +- ...utorial.html => Web-Changing-Webpage.html} | 149 +++---- .../Howtos/Web-Extending-the-REST-API.html | 10 +- ...tats.html => Web-Tweeting-Game-Stats.html} | 103 ++--- docs/1.0-dev/Setup/Channels-to-Twitter.html | 2 +- docs/1.0-dev/Setup/Config-Apache-Proxy.html | 24 +- docs/1.0-dev/Setup/Config-HAProxy.html | 10 +- docs/1.0-dev/Setup/Installation-Docker.html | 34 +- docs/1.0-dev/Setup/Installation-Git.html | 40 +- .../Setup/Installation-Troubleshooting.html | 12 +- docs/1.0-dev/Setup/Installation-Upgrade.html | 15 +- docs/1.0-dev/Setup/Installation.html | 2 +- docs/1.0-dev/Setup/Online-Setup.html | 3 +- docs/1.0-dev/Setup/Setup-Overview.html | 5 + docs/1.0-dev/Unimplemented.html | 24 +- .../evennia/prototypes/prototypes.html | 3 - .../_modules/evennia/utils/evmenu.html | 12 +- .../Coding/Coding-Introduction.md.txt | 2 +- .../_sources/Coding/Coding-Overview.md.txt | 2 +- .../_sources/Components/TickerHandler.md.txt | 2 +- .../_sources/Concepts/Web-Features.md.txt | 2 +- .../Contrib-Mapbuilder-Tutorial.md.txt} | 18 +- .../Contribs/Contrib-Mapbuilder.md.txt | 7 + .../Contribs/Contribs-Overview.md.txt | 151 ++++--- .../_sources/Evennia-Introduction.md.txt | 4 +- .../Beginner-Tutorial-Intro.md.txt | 114 ----- .../Beginner-Tutorial-Overview.md.txt | 82 ++++ ...> Beginner-Tutorial-Part1-Overview.md.txt} | 12 +- ...> Beginner-Tutorial-Part2-Overview.md.txt} | 12 +- ...> Beginner-Tutorial-Part3-Overview.md.txt} | 12 +- .../Beginner-Tutorial-Part4-Intro.md.txt | 34 -- .../Beginner-Tutorial-Part4-Overview.md.txt | 30 ++ ...> Beginner-Tutorial-Part5-Overview.md.txt} | 1 - .../Evennia-for-roleplaying-sessions.md.txt | 2 +- ...Tutorial.md.txt => Howto-Game-Time.md.txt} | 80 +--- .../_sources/Howtos/Howtos-Overview.md.txt | 52 +-- ...md.txt => Tutorial-Building-a-Mech.md.txt} | 123 ++---- ...d.txt => Tutorial-Building-a-Train.md.txt} | 140 +++--- .../Howtos/Tutorial-Coordinates.md.txt | 83 ++-- ...xt => Tutorial-Displaying-Room-Map.md.txt} | 135 ++---- ...d.txt => Tutorial-Parsing-Commands.md.txt} | 3 +- .../Tutorial-Tweeting-Game-Stats.md.txt | 96 ---- ...n.md.txt => Tutorial-Using-Arxcode.md.txt} | 2 +- ...md.txt => Tutorial-Weather-Effects.md.txt} | 25 +- .../Tutorial-for-basic-MUSH-like-game.md.txt | 2 +- .../_sources/Howtos/Web-Add-a-wiki.md.txt | 2 +- ...ial.md.txt => Web-Changing-Webpage.md.txt} | 52 +-- .../Howtos/Web-Tweeting-Game-Stats.md.txt | 86 ++++ .../_sources/Setup/Channels-to-Twitter.md.txt | 2 +- .../_sources/Setup/Installation-Docker.md.txt | 36 +- .../_sources/Setup/Installation-Git.md.txt | 35 +- .../Setup/Installation-Troubleshooting.md.txt | 12 +- .../Setup/Installation-Upgrade.md.txt | 15 +- .../_sources/Setup/Installation.md.txt | 2 +- .../_sources/Setup/Online-Setup.md.txt | 3 +- .../_sources/Setup/Setup-Overview.md.txt | 2 +- docs/1.0-dev/_sources/index.md.txt | 2 +- .../api/evennia.commands.default.account.html | 4 +- .../evennia.commands.default.building.html | 12 +- .../api/evennia.commands.default.general.html | 16 +- .../api/evennia.commands.default.system.html | 4 +- .../api/evennia.commands.default.tests.html | 2 +- .../evennia.commands.default.unloggedin.html | 8 +- ....base_systems.email_login.email_login.html | 8 +- ...b.base_systems.ingame_python.commands.html | 4 +- ...systems.mux_comms_cmds.mux_comms_cmds.html | 4 +- ...rib.full_systems.evscaperoom.commands.html | 24 +- ...ia.contrib.game_systems.barter.barter.html | 4 +- ...ontrib.game_systems.clothing.clothing.html | 4 +- ...trib.grid.extended_room.extended_room.html | 4 +- .../api/evennia.contrib.rpg.dice.dice.html | 4 +- ...evennia.contrib.rpg.rpsystem.rpsystem.html | 4 +- ...ontrib.tutorials.evadventure.commands.html | 8 +- ...ntrib.tutorials.red_button.red_button.html | 16 +- ...trib.tutorials.tutorial_world.objects.html | 16 +- ...ontrib.tutorials.tutorial_world.rooms.html | 12 +- ...utils.git_integration.git_integration.html | 4 +- .../api/evennia.prototypes.prototypes.html | 2 +- docs/1.0-dev/api/evennia.utils.eveditor.html | 4 +- docs/1.0-dev/api/evennia.utils.evmenu.html | 4 +- docs/1.0-dev/api/evennia.utils.evmore.html | 4 +- docs/1.0-dev/index.html | 135 +++--- docs/1.0-dev/objects.inv | Bin 158718 -> 158456 bytes docs/1.0-dev/searchindex.js | 2 +- 146 files changed, 1903 insertions(+), 2426 deletions(-) rename docs/1.0-dev/{Howtos/Static-In-Game-Map.html => Contribs/Contrib-Mapbuilder-Tutorial.html} (93%) rename docs/1.0-dev/Howtos/Beginner-Tutorial/{Beginner-Tutorial-Intro.html => Beginner-Tutorial-Overview.html} (88%) rename docs/1.0-dev/Howtos/Beginner-Tutorial/Part1/{Beginner-Tutorial-Part1-Intro.html => Beginner-Tutorial-Part1-Overview.html} (95%) rename docs/1.0-dev/Howtos/Beginner-Tutorial/Part2/{Beginner-Tutorial-Part2-Intro.html => Beginner-Tutorial-Part2-Overview.html} (94%) rename docs/1.0-dev/Howtos/Beginner-Tutorial/Part3/{Beginner-Tutorial-Part3-Intro.html => Beginner-Tutorial-Part3-Overview.html} (96%) rename docs/1.0-dev/Howtos/Beginner-Tutorial/Part4/{Beginner-Tutorial-Part4-Intro.html => Beginner-Tutorial-Part4-Overview.html} (88%) rename docs/1.0-dev/Howtos/Beginner-Tutorial/Part5/{Beginner-Tutorial-Part5-Intro.html => Beginner-Tutorial-Part5-Overview.html} (81%) rename docs/1.0-dev/Howtos/{Gametime-Tutorial.html => Howto-Game-Time.html} (85%) rename docs/1.0-dev/Howtos/{Building-a-mech-tutorial.html => Tutorial-Building-a-Mech.html} (70%) rename docs/1.0-dev/Howtos/{Tutorial-Vehicles.html => Tutorial-Building-a-Train.html} (77%) rename docs/1.0-dev/Howtos/{Dynamic-In-Game-Map.html => Tutorial-Displaying-Room-Map.html} (82%) rename docs/1.0-dev/Howtos/{Parsing-commands-tutorial.html => Tutorial-Parsing-Commands.html} (99%) rename docs/1.0-dev/Howtos/{Arxcode-Installation.html => Tutorial-Using-Arxcode.html} (97%) rename docs/1.0-dev/Howtos/{Weather-Tutorial.html => Tutorial-Weather-Effects.html} (70%) rename docs/1.0-dev/Howtos/{Beginner-Tutorial/Part5/Web-Tutorial.html => Web-Changing-Webpage.html} (52%) rename docs/1.0-dev/Howtos/{Tutorial-Tweeting-Game-Stats.html => Web-Tweeting-Game-Stats.html} (53%) rename docs/1.0-dev/_sources/{Howtos/Static-In-Game-Map.md.txt => Contribs/Contrib-Mapbuilder-Tutorial.md.txt} (95%) delete mode 100644 docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Beginner-Tutorial-Intro.md.txt create mode 100644 docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Beginner-Tutorial-Overview.md.txt rename docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part1/{Beginner-Tutorial-Part1-Intro.md.txt => Beginner-Tutorial-Part1-Overview.md.txt} (80%) rename docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part2/{Beginner-Tutorial-Part2-Intro.md.txt => Beginner-Tutorial-Part2-Overview.md.txt} (74%) rename docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part3/{Beginner-Tutorial-Part3-Intro.md.txt => Beginner-Tutorial-Part3-Overview.md.txt} (85%) delete mode 100644 docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part4/Beginner-Tutorial-Part4-Intro.md.txt create mode 100644 docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part4/Beginner-Tutorial-Part4-Overview.md.txt rename docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part5/{Beginner-Tutorial-Part5-Intro.md.txt => Beginner-Tutorial-Part5-Overview.md.txt} (98%) rename docs/1.0-dev/_sources/Howtos/{Gametime-Tutorial.md.txt => Howto-Game-Time.md.txt} (72%) rename docs/1.0-dev/_sources/Howtos/{Building-a-mech-tutorial.md.txt => Tutorial-Building-a-Mech.md.txt} (52%) rename docs/1.0-dev/_sources/Howtos/{Tutorial-Vehicles.md.txt => Tutorial-Building-a-Train.md.txt} (67%) rename docs/1.0-dev/_sources/Howtos/{Dynamic-In-Game-Map.md.txt => Tutorial-Displaying-Room-Map.md.txt} (71%) rename docs/1.0-dev/_sources/Howtos/{Parsing-commands-tutorial.md.txt => Tutorial-Parsing-Commands.md.txt} (99%) delete mode 100644 docs/1.0-dev/_sources/Howtos/Tutorial-Tweeting-Game-Stats.md.txt rename docs/1.0-dev/_sources/Howtos/{Arxcode-Installation.md.txt => Tutorial-Using-Arxcode.md.txt} (99%) rename docs/1.0-dev/_sources/Howtos/{Weather-Tutorial.md.txt => Tutorial-Weather-Effects.md.txt} (62%) rename docs/1.0-dev/_sources/Howtos/{Beginner-Tutorial/Part5/Web-Tutorial.md.txt => Web-Changing-Webpage.md.txt} (57%) create mode 100644 docs/1.0-dev/_sources/Howtos/Web-Tweeting-Game-Stats.md.txt diff --git a/docs/1.0-dev/.buildinfo b/docs/1.0-dev/.buildinfo index 6a3e8c0dfe..0c567ff8e0 100644 --- a/docs/1.0-dev/.buildinfo +++ b/docs/1.0-dev/.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: ff994fe83233749663200558bc3cc4fd +config: 9c39b81134271f9469ce985ba44341c4 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/1.0-dev/Coding/Coding-Introduction.html b/docs/1.0-dev/Coding/Coding-Introduction.html index 82d4ccb1e2..a548bf13fd 100644 --- a/docs/1.0-dev/Coding/Coding-Introduction.html +++ b/docs/1.0-dev/Coding/Coding-Introduction.html @@ -122,7 +122,7 @@ 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. Even if +

It’s highly recommended that you jump in on the Starting Tutorial. Even if you only the beginning or some part of it, it covers much of the things needed to get started, including giving you are first introduction to Python.

diff --git a/docs/1.0-dev/Coding/Coding-Overview.html b/docs/1.0-dev/Coding/Coding-Overview.html index 860aa4f9d1..76de7a7938 100644 --- a/docs/1.0-dev/Coding/Coding-Overview.html +++ b/docs/1.0-dev/Coding/Coding-Overview.html @@ -111,7 +111,7 @@ make your game, also if you never coded before. If you are an experienced coder, much of this will be familiar to you, but some things may still be useful.

Setting up a workflow

-

See also the Beginner Tutorial.

+

See also the Beginner Tutorial.

  • Version Control
      diff --git a/docs/1.0-dev/Components/TickerHandler.html b/docs/1.0-dev/Components/TickerHandler.html index 03175fe94d..3c596be46a 100644 --- a/docs/1.0-dev/Components/TickerHandler.html +++ b/docs/1.0-dev/Components/TickerHandler.html @@ -191,7 +191,7 @@ may store.

When testing, you can stop all tickers in the entire game with tickerhandler.clear(). You can also view the currently subscribed objects with tickerhandler.all().

-

See the Weather Tutorial for an example of using the TickerHandler.

+

See the Weather Tutorial for an example of using the TickerHandler.

When not to use TickerHandler

Using the TickerHandler may sound very useful but it is important to consider when not to use it. diff --git a/docs/1.0-dev/Concepts/Web-Features.html b/docs/1.0-dev/Concepts/Web-Features.html index d7666364d2..cb03b37239 100644 --- a/docs/1.0-dev/Concepts/Web-Features.html +++ b/docs/1.0-dev/Concepts/Web-Features.html @@ -148,7 +148,7 @@ change from the web

Example: To override or modify evennia/web/website/template/website/index.html you need to add/modify mygame/web/template_overrides/website/index.html.

The detailed description on how to customize the website is best described in tutorial form. See the -Web Tutorial for more information.

+Web Tutorial for more information.

Overloading Django views

diff --git a/docs/1.0-dev/Howtos/Static-In-Game-Map.html b/docs/1.0-dev/Contribs/Contrib-Mapbuilder-Tutorial.html similarity index 93% rename from docs/1.0-dev/Howtos/Static-In-Game-Map.html rename to docs/1.0-dev/Contribs/Contrib-Mapbuilder-Tutorial.html index e5c666f284..53798aedb5 100644 --- a/docs/1.0-dev/Howtos/Static-In-Game-Map.html +++ b/docs/1.0-dev/Contribs/Contrib-Mapbuilder-Tutorial.html @@ -6,7 +6,7 @@ - Static In Game Map — Evennia 1.0-dev documentation + Creating rooms from an ascii map — Evennia 1.0-dev documentation @@ -17,8 +17,8 @@ - - + + @@ -62,8 +63,7 @@

Table of Contents

    -
  • Static In Game Map

    Versions

    Previous topic

    -

    Map Builder

    +

    Creating rooms from an ascii map

    Next topic

    Slow Exit

    @@ -172,7 +172,7 @@ file will be overwritten, so edit that file rather than this one.

    next |
  • - previous |
  • Evennia 1.0-dev »
  • Contribs »
    • diff --git a/docs/1.0-dev/Contribs/Contribs-Overview.html b/docs/1.0-dev/Contribs/Contribs-Overview.html index 8a16bd63ae..900fdac2b4 100644 --- a/docs/1.0-dev/Contribs/Contribs-Overview.html +++ b/docs/1.0-dev/Contribs/Contribs-Overview.html @@ -62,74 +62,75 @@

    Table of Contents

    • Contribs
    • The Components Contrib @@ -174,10 +175,16 @@

      Contribs

      +

      Contribs are optional code snippets and systems contributed by the Evennia community. They vary in size and complexity and may be more specific about game types and styles than ‘core’ Evennia. -This page is auto-generated and summarizes all contribs currently included.

      +This page is auto-generated and summarizes all 46 contribs currently included +with the Evennia distribution.

      All contrib categories are imported from evennia.contrib, such as

      from evennia.contrib.base_systems import building_menu
      @@ -185,15 +192,108 @@ This page is auto-generated and summarizes all contribs currently included.

      Each contrib contains installation instructions for how to integrate it with your other code. If you want to tweak the code of a contrib, just copy its entire folder to your game directory and modify/use it from there.

      -
      -

      Hint: Additional (potentially un-maintained) code snippets from the community can be found -in our discussion forum’s Community Contribs & Snippets category.

      -

      If you want to contribute yourself, see here!

      +
      +

      Index

      + + + + + + + + + + + + + + + + + + + + + +

      base_systems

      full_systems

      game_systems

      grid

      rpg

      tutorials

      utils

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

      auditing

      awsstorage

      barter

      batchprocessor

      bodyfunctions

      buffs

      building_menu

      character_creator

      clothing

      color_markups

      components

      cooldowns

      crafting

      custom_gametime

      dice

      email_login

      evadventure

      evscaperoom

      extended_room

      fieldfill

      gendersub

      git_integration

      health_bar

      ingame_map_display

      ingame_python

      mail

      mapbuilder

      menu_login

      mirror

      multidescer

      mux_comms_cmds

      name_generator

      puzzles

      random_string_generator

      red_button

      rpsystem

      simpledoor

      slow_exit

      talking_npc

      traits

      tree_select

      turnbattle

      tutorial_world

      unixcommand

      wilderness

      xyzgrid

      +

      base_systems

      -

      This category contains systems that are not necessarily tied to a specific -in-game mechanic but is useful for the game as a whole. Examples include +

      Systems that are not necessarily tied to a specific +in-game mechanic but which are useful for the game as a whole. Examples include login systems, new command syntaxes, and build helpers.

      -
      -

      Contrib: awsstorage

      +
      +

      awsstorage

      Contrib by The Right Honourable Reverend (trhr), 2020

      This plugin migrates the Web-based portion of Evennia, namely images, javascript, and other items located inside staticfiles into Amazon AWS (S3) cloud hosting. Great for those serving media with the game.

      Read the documentation - Browse the Code

      -
      -

      Contrib: building_menu

      +
      +

      building_menu

      Contrib by vincent-lg, 2018

      Building menus are in-game menus, not unlike EvMenu though using a different approach. Building menus have been specifically designed to edit @@ -233,16 +333,16 @@ steps to add the contrib, you will have access to an Read the documentation - Browse the Code

      -
      -

      Contrib: color_markups

      +
      +

      color_markups

      Contrib by Griatch, 2017

      Additional color markup styles for Evennia (extending or replacing the default |r, |234). Adds support for MUSH-style (%cr, %c123) and/or legacy-Evennia ({r, {123).

      Read the documentation - Browse the Code

      -
      -

      Contrib: components

      +
      +

      components

      Contrib by ChrisLR 2021

      @@ -250,8 +350,8 @@ that will edit any default object, offering to change its key and description.

      The Components Contrib

      Read the documentation - Browse the Code

      -
      -

      Contrib: custom_gametime

      +
      +

      custom_gametime

      Contrib by vlgeoff, 2017 - based on Griatch’s core original

      This reimplements the evennia.utils.gametime module but with a custom calendar (unusual number of days per week/month/year etc) for your game world. @@ -259,16 +359,16 @@ Like the original, it allows for scheduling events to happen at given in-game times, but now taking this custom calendar into account.

      Read the documentation - Browse the Code

      -
      -

      Contrib: email_login

      +
      +

      email_login

      Contrib by Griatch, 2012

      This is a variant of the login system that asks for an email-address instead of a username to login. Note that it does not verify the email, it just uses it as the identifier rather than a username.

      Read the documentation - Browse the Code

      -
      -

      Contrib: ingame_python

      +
      +

      ingame_python

      Contrib by Vincent Le Goff 2017

      This contrib adds the ability to script with Python in-game. It allows trusted staff/builders to dynamically add features and triggers to individual objects @@ -280,16 +380,16 @@ security concerns (you must trust your builders deeply), so read the warnings in this module carefully before continuing.

      Read the documentation - Browse the Code

      -
      -

      Contrib: menu_login

      + -
      -

      Contrib: mux_comms_cmds

      +
      +

      mux_comms_cmds

      Contribution by Griatch 2021

      In Evennia 1.0+, the old Channel commands (originally inspired by MUX) were replaced by the single channel command that performs all these functions. @@ -298,8 +398,8 @@ separate Commands more familiar to MU* users. This is just for show though, the main channel command is still called under the hood.

      Read the documentation - Browse the Code

      -
      -

      Contrib: unixcommand

      +
      +

      unixcommand

      Contribution by Vincent Le Geoff (vlgeoff), 2017

      This module contains a command class with an alternate syntax parser implementing Unix-style command syntax in-game. This means --options, positional arguments @@ -311,15 +411,15 @@ library under the hood.

      full_systems

      -

      This category contains ‘complete’ game engines that can be used directly -to start creating content without no further additions (unless you want to).

      +

      ‘Complete’ game engines that can be used directly to start creating content +without no further additions (unless you want to).

      -
      -

      Contrib: evscaperoom

      +
      +

      evscaperoom

      Contribution by Griatch, 2019

      A full engine for creating multiplayer escape-rooms in Evennia. Allows players to spawn and join puzzle rooms that track their state independently. Any number of players @@ -331,10 +431,10 @@ content but contains the utilities and base classes and an empty example room.

      game_systems

      -

      This category holds code implementing in-game gameplay systems like -crafting, mail, combat and more. Each system is meant to be adopted -piecemeal and adopted for your game. This does not include -roleplaying-specific systems, those are found in the rpg folder.

      +

      In-game gameplay systems like crafting, mail, combat and more. +Each system is meant to be adopted piecemeal and adopted for your game. +This does not include roleplaying-specific systems, those are found in +the rpg category.

      -
      -

      Contrib: barter

      +
      +

      barter

      Contribution by Griatch, 2012

      This implements a full barter system - a way for players to safely trade items between each other in code rather than simple give/get @@ -360,15 +460,15 @@ be moved automatically). By just replacing one side with coin objects, transactions.

      Read the documentation - Browse the Code

      -
      -

      Contrib: clothing

      +
      +

      clothing

      Contribution by Tim Ashley Jenkins, 2017

      Provides a typeclass and commands for wearable clothing. These look of these clothes are appended to the character’s description when worn.

      Read the documentation - Browse the Code

      -
      -

      Contrib: cooldowns

      +
      +

      cooldowns

      Contribution by owllex, 2021

      Cooldowns are used to model rate-limited actions, like how often a character can perform a given action; until a certain time has passed their @@ -377,8 +477,8 @@ handler that can be attached to any typeclass. A cooldown is a lightweight persi asynchronous timer that you can query to see if a certain time has yet passed.

      Read the documentation - Browse the Code

      -
      -

      Contrib: crafting

      +
      +

      crafting

      Contribution by Griatch 2020

      This implements a full crafting system. The principle is that of a ‘recipe’, where you combine items (tagged as ingredients) create something new. The recipe can also @@ -386,8 +486,8 @@ require certain (non-consumed) tools. An example would be to use the ‘bread re combine ‘flour’, ‘water’ and ‘yeast’ with an ‘oven’ to bake a ‘loaf of bread’.

      Read the documentation - Browse the Code

      -
      -

      Contrib: gendersub

      +
      +

      gendersub

      Contribution by Griatch 2015

      This is a simple gender-aware Character class for allowing users to insert custom markers in their text to indicate gender-aware @@ -395,8 +495,8 @@ messaging. It relies on a modified msg() and is meant as an inspiration and starting point to how to do stuff like this.

      Read the documentation - Browse the Code

      -
      -

      Contrib: mail

      +
      +

      mail

      Contribution by grungies1138 2016

      A simple Brandymail style mail system that uses the Msg class from Evennia Core. It has two Commands for either sending mails between Accounts (out of game) @@ -404,8 +504,8 @@ or between Characters (in-game). The two types of mails can be used together or on their own.

      Read the documentation - Browse the Code

      -
      -

      Contrib: multidescer

      +
      +

      multidescer

      Contribution by Griatch 2016

      A “multidescer” is a concept from the MUSH world. It allows for creating, managing and switching between multiple character @@ -414,8 +514,8 @@ changing clothes) in more free-form roleplaying systems. This will also work well together with the rpsystem contrib.

      Read the documentation - Browse the Code

      -
      -

      Contrib: puzzles

      +
      +

      puzzles

      Contribution by Henddher 2018

      Intended for adventure-game style combination puzzles, such as combining fruits and a blender to create a smoothie. Provides a typeclass and commands for objects @@ -424,8 +524,8 @@ puzzle is built from unique objects rather than using tags and a builder can cre the puzzle entirely from in-game.

      Read the documentation - Browse the Code

      -
      -

      Contrib: turnbattle

      +
      +

      turnbattle

      Contribution by Tim Ashley Jenkins, 2017

      This is a framework for a simple turn-based combat system, similar to those used in D&D-style tabletop role playing games. It allows @@ -439,8 +539,8 @@ the participants until the fight ends.

      grid

      -

      Systems related to the game world’s topology and structure. This has -contribs related to rooms, exits and map building.

      +

      Systems related to the game world’s topology and structure. Contribs related +to rooms, exits and map building.

      -
      -

      Contrib: extended_room

      +
      +

      extended_room

      Contribution - Griatch 2012, vincent-lg 2019

      This extends the normal Room typeclass to allow its description to change with time-of-day and/or season. It also adds ‘details’ for the player to look at @@ -461,8 +561,8 @@ in the room (without having to create a new in-game object for each). The room i supported by new look and desc commands.

      Read the documentation - Browse the Code

      -
      -

      Contrib: ingame_map_display

      +
      +

      ingame_map_display

      Contribution - helpme 2022

      This adds an ascii map to a given room which can be viewed with the map command. You can easily alter it to add special characters, room colors etc. The map shown is @@ -470,22 +570,22 @@ dynamically generated on use, and supports all compass directions and up/down. O directions are ignored.

      Read the documentation - Browse the Code

      -
      -

      Contrib: mapbuilder

      +
      +

      mapbuilder

      Contribution by Cloud_Keeper 2016

      Build a game map from the drawing of a 2D ASCII map.

      Read the documentation - Browse the Code

      -
      -

      Contrib: simpledoor

      +
      +

      simpledoor

      Contribution by Griatch, 2016

      A simple two-way exit that represents a door that can be opened and closed from both sides. Can easily be expanded to make it lockable, destroyable etc.

      Read the documentation - Browse the Code

      -
      -

      Contrib: slow_exit

      +
      +

      slow_exit

      Contribution by Griatch 2014

      An example of an Exit-type that delays its traversal. This simulates slow movement, common in many games. The contrib also @@ -493,8 +593,8 @@ contains two commands, Read the documentation - Browse the Code

      -
      -

      Contrib: wilderness

      +
      +

      wilderness

      Contribution by titeuf87, 2017

      This contrib provides a wilderness map without actually creating a large number of rooms - as you move, you instead end up back in the same room but its description @@ -502,8 +602,8 @@ changes. This means you can make huge areas with little database use as long as the rooms are relatively similar (name/desc changing).

      Read the documentation - Browse the Code

      -
      -

      Contrib: xyzgrid

      +
      +

      xyzgrid

      Contribution by Griatch 2021

      Places Evennia’s game world on an xy (z being different maps) coordinate grid. Grid is created and maintained externally by drawing and parsing 2D ASCII maps, @@ -516,7 +616,7 @@ current location (useful for displaying the grid as an in-game, updating map).

      rpg

      -

      These are systems specifically related to roleplaying +

      Systems specifically related to roleplaying and rule implementation like character traits, dice rolling and emoting.

        @@ -528,21 +628,21 @@ and rule implementation like character traits, dice rolling and emoting.

        Traits
      -
      -

      Contrib: buffs

      +
      +

      buffs

      Contribution by Tegiminis 2022

      A buff is a timed object, attached to a game entity. It is capable of modifying values, triggering code, or both. It is a common design pattern in RPGs, particularly action games.

      Read the documentation - Browse the Code

      -
      -

      Contrib: character_creator

      +
      +

      character_creator

      Commands for managing and initiating an in-game character-creation menu.

      Contribution by InspectorCaracal, 2022

      Read the documentation - Browse the Code

      -
      -

      Contrib: dice

      +
      +

      dice

      Contribution by Griatch, 2012

      A dice roller for any number and side of dice. Adds in-game dice rolling (roll 2d10 + 1) as well as conditionals (roll under/over/equal to a target) @@ -550,8 +650,8 @@ and functions for rolling dice in code. Command also supports hidden or secret rolls for use by a human game master.

      Read the documentation - Browse the Code

      -
      -

      Contrib: health_bar

      +
      +

      health_bar

      Contribution by Tim Ashley Jenkins, 2017

      The function provided in this module lets you easily display visual bars or meters as a colorful bar instead of just a number. A “health bar” @@ -559,8 +659,8 @@ is merely the most obvious use for this, but the bar is highly customizable and can be used for any sort of appropriate data besides player health.

      Read the documentation - Browse the Code

      -
      -

      Contrib: rpsystem

      +
      +

      rpsystem

      Contribution by Griatch, 2015

      A full roleplaying emote system. Short-descriptions and recognition (only know people by their looks until you assign a name to them). Room poses. Masks/disguises @@ -571,8 +671,8 @@ very powerful in-emote reference system, for referencing and differentiate targe (including objects).

      Read the documentation - Browse the Code

      -
      -

      Contrib: traits

      +
      +

      traits

      Contribution by Griatch 2020, based on code by Whitenoise and Ainneve contribs, 2014

      A Trait represents a modifiable property on (usually) a Character. They can be used to represent everything from attributes (str, agi etc) to skills @@ -588,7 +688,8 @@ healed).

      tutorials

      Helper resources specifically meant to teach a development concept or to exemplify an Evennia system. Any extra resources tied to documentation -tutorials are found here. Also the home of the Tutorial World demo adventure.

      +tutorials are found here. Also the home of the Tutorial-World and Evadventure +demo codes.

      -
      -

      Contrib: batchprocessor

      +
      +

      batchprocessor

      Contibution by Griatch, 2012

      Simple examples for the batch-processor. The batch processor is used for generating in-game content from one or more static files. Files can be stored with version control and then ‘applied’ to the game to create content.

      Read the documentation - Browse the Code

      -
      -

      Contrib: bodyfunctions

      +
      +

      bodyfunctions

      Contribution by Griatch, 2012

      Example script for testing. This adds a simple timer that has your character make small verbal observations at irregular intervals.

      Read the documentation - Browse the Code

      -
      -

      Contrib: evadventure

      +
      +

      evadventure

      Contrib by Griatch 2022

      Warning

      @@ -626,28 +727,28 @@ perfection.

      Read the documentation - Browse the Code

      -
      -

      Contrib: mirror

      +
      +

      mirror

      Contribution by Griatch, 2017

      A simple mirror object to experiment with. It will respond to being looked at.

      Read the documentation - Browse the Code

      -
      -

      Contrib: red_button

      +
      +

      red_button

      Contribution by Griatch, 2011

      A red button that you can press to have an effect. This is a more advanced example object with its own functionality and state tracking.

      Read the documentation - Browse the Code

      -
      -

      Contrib: talking_npc

      +
      +

      talking_npc

      Contribution by Griatch 2011. Updated by grungies1138, 2016

      This is an example of a static NPC object capable of holding a simple menu-driven conversation. Suitable for example as a quest giver or merchant.

      Read the documentation - Browse the Code

      -
      -

      Contrib: tutorial_world

      +
      +

      tutorial_world

      Contribution by Griatch 2011, 2015

      A stand-alone tutorial area for an unmodified Evennia install. Think of it as a sort of single-player adventure rather than a @@ -661,8 +762,7 @@ is a great way to start learning the system.

      utils

      -

      Miscellaneous, optional tools for manipulating text, auditing connections -and more.

      +

      Miscellaneous, tools for manipulating text, security auditing, and more.

      -
      -

      Contrib: auditing

      +
      +

      auditing

      Contribution by Johnny, 2017

      Utility that taps and intercepts all data sent to/from clients and the server and passes it to a callback of your choosing. This is intended for quality assurance, post-incident investigations and debugging.

      Read the documentation - Browse the Code

      -
      -

      Contrib: fieldfill

      +
      +

      fieldfill

      Contribution by Tim Ashley Jenkins, 2018

      This module contains a function that generates an EvMenu for you - this menu presents the player with a form of fields that can be filled @@ -693,14 +793,14 @@ function. Once the form is submitted, the form’s data is submitted as a dictio to any callable of your choice.

      Read the documentation - Browse the Code

      -
      -

      Contrib: git_integration

      +
      +

      git_integration

      Contribution by helpme (2022)

      A module to integrate a stripped-down version of git within the game, allowing developers to view their git status, change branches, and pull updated code of both their local mygame repo and Evennia core. After a successful pull or checkout, the git command will reload the game: Manual restarts may be required to to apply certain changes that would impact persistent scripts etc.

      Read the documentation - Browse the Code

      -
      -

      Contrib: name_generator

      +
      +

      name_generator

      Contribution by InspectorCaracal (2022)

      A module for generating random names, both real-world and fantasy. Real-world names can be generated either as first (personal) names, family (last) names, or @@ -708,8 +808,8 @@ full names (first, optional middles, and last). The name data is from CC BY-SA 4.0 license.

      Read the documentation - Browse the Code

      -
      -

      Contrib: random_string_generator

      +
      +

      random_string_generator

      Contribution by Vincent Le Goff (vlgeoff), 2017

      This utility can be used to generate pseudo-random strings of information with specific criteria. You could, for instance, use it to generate @@ -717,8 +817,8 @@ phone numbers, license plate numbers, validation codes, in-game security passwords and so on. The strings generated will be stored and won’t be repeated.

      Read the documentation - Browse the Code

      -
      -

      Contrib: tree_select

      +
      +

      tree_select

      Contribution by Tim Ashley Jenkins, 2017

      This utility allows you to create and initialize an entire branching EvMenu instance from a multi-line string passed to one function.

      diff --git a/docs/1.0-dev/Evennia-Introduction.html b/docs/1.0-dev/Evennia-Introduction.html index ef43c33691..f33e2a9c45 100644 --- a/docs/1.0-dev/Evennia-Introduction.html +++ b/docs/1.0-dev/Evennia-Introduction.html @@ -157,7 +157,7 @@ you need to know depending on your skills and needs.

      I know basic Python, or I am willing to learn

      -

      Evennia’s source code is extensively documented. But while Python is considered a very easy programming language to get into, you do have a learning curve to climb if you are new to programming. Evennia’s Starting-tutorial has a basic introduction to Python but you should probably also sit down with a full Python beginner’s tutorial at some point (there are plenty of them on the web if you look around). See also our link page for some reading suggestions.

      +

      Evennia’s source code is extensively documented. But while Python is considered a very easy programming language to get into, you do have a learning curve to climb if you are new to programming. Evennia’s Starting-tutorial has a basic introduction to Python but you should probably also sit down with a full Python beginner’s tutorial at some point (there are plenty of them on the web if you look around). See also our link page for some reading suggestions.

      To code your dream game in Evennia you don’t need to be a Python guru, but you do need to be able to read example code containing at least these basic Python features:

      • Importing and using python modules

        • @@ -182,7 +182,7 @@ presence (a website and a mud web client) to play around with …

      Where to from here?

      -

      It’s recommended you jump into the Beginner Tutorial. You can either follow it or jump around to lessons that seem interesting. You can also read the lead developer’s dev blog for many tidbits and snippets about Evennia’s development and structure.

      +

      It’s recommended you jump into the Beginner Tutorial. You can either follow it or jump around to lessons that seem interesting. You can also read the lead developer’s dev blog for many tidbits and snippets about Evennia’s development and structure.

      Sometimes it’s easier to ask for help. Get engaged in the Evennia community by joining our Discord for direct support. Make an introductory post to our Discussion forum and say hi!.

      diff --git a/docs/1.0-dev/Howtos/Beginner-Tutorial/Beginner-Tutorial-Intro.html b/docs/1.0-dev/Howtos/Beginner-Tutorial/Beginner-Tutorial-Overview.html similarity index 88% rename from docs/1.0-dev/Howtos/Beginner-Tutorial/Beginner-Tutorial-Intro.html rename to docs/1.0-dev/Howtos/Beginner-Tutorial/Beginner-Tutorial-Overview.html index 7fab6fc409..c41825a4d1 100644 --- a/docs/1.0-dev/Howtos/Beginner-Tutorial/Beginner-Tutorial-Intro.html +++ b/docs/1.0-dev/Howtos/Beginner-Tutorial/Beginner-Tutorial-Overview.html @@ -17,7 +17,7 @@ - +
    • - next |
    • Things you need
    @@ -78,12 +78,12 @@

    Tutorials and Howto’s

    Next topic

    -

    Part 1: What we have

    Links

    @@ -99,7 +99,7 @@

Versions

develop branch
@@ -70,7 +70,7 @@

Previous topic

-

Beginner Tutorial

Next topic

Links

@@ -94,7 +94,7 @@

Versions

develop branch
@@ -751,8 +751,8 @@ practice you will be writing most your code in Python modules.

>previous |
  • Evennia 1.0-dev »
  • Tutorials and Howto’s »
    • -
  • Beginner Tutorial »
    • -
  • Part 1: What we have »
    • +
  • Beginner Tutorial »
    • +
  • Part 1: What we have »
  • 3. Intro to using Python with Evennia
    • develop branch
    diff --git a/docs/1.0-dev/Howtos/Beginner-Tutorial/Part1/Beginner-Tutorial-Python-classes-and-objects.html b/docs/1.0-dev/Howtos/Beginner-Tutorial/Part1/Beginner-Tutorial-Python-classes-and-objects.html index f05259e4f5..29d3818287 100644 --- a/docs/1.0-dev/Howtos/Beginner-Tutorial/Part1/Beginner-Tutorial-Python-classes-and-objects.html +++ b/docs/1.0-dev/Howtos/Beginner-Tutorial/Part1/Beginner-Tutorial-Python-classes-and-objects.html @@ -37,8 +37,8 @@ accesskey="P">previous |
  • Evennia 1.0-dev »
  • Tutorials and Howto’s »
    • -
  • Beginner Tutorial »
    • -
  • Part 1: What we have »
    • +
  • Beginner Tutorial »
    • +
  • Part 1: What we have »
  • 5. Introduction to Python classes and objects
    • develop branch
    @@ -494,8 +494,8 @@ The world trembles. >previous |
  • Evennia 1.0-dev »
  • Tutorials and Howto’s »
    • -
  • Beginner Tutorial »
    • -
  • Part 1: What we have »
    • +
  • Beginner Tutorial »
    • +
  • Part 1: What we have »
  • 5. Introduction to Python classes and objects
    • develop branch
    diff --git a/docs/1.0-dev/Howtos/Beginner-Tutorial/Part1/Beginner-Tutorial-Searching-Things.html b/docs/1.0-dev/Howtos/Beginner-Tutorial/Part1/Beginner-Tutorial-Searching-Things.html index 54d292a86e..673261aff4 100644 --- a/docs/1.0-dev/Howtos/Beginner-Tutorial/Part1/Beginner-Tutorial-Searching-Things.html +++ b/docs/1.0-dev/Howtos/Beginner-Tutorial/Part1/Beginner-Tutorial-Searching-Things.html @@ -37,8 +37,8 @@ accesskey="P">previous |
  • Evennia 1.0-dev »
  • Tutorials and Howto’s »
    • -
  • Beginner Tutorial »
    • -
  • Part 1: What we have »
    • +
  • Beginner Tutorial »
    • +
  • Part 1: What we have »
  • 11. Searching for things
    • develop branch
    @@ -425,8 +425,8 @@ We can also find what is inside each object. This is a list of things.

    >previous |
  • Evennia 1.0-dev »
  • Tutorials and Howto’s »
    • -
  • Beginner Tutorial »
    • -
  • Part 1: What we have »
    • +
  • Beginner Tutorial »
    • +
  • Part 1: What we have »
  • 11. Searching for things
    • develop branch
    diff --git a/docs/1.0-dev/Howtos/Beginner-Tutorial/Part1/Beginner-Tutorial-Tutorial-World.html b/docs/1.0-dev/Howtos/Beginner-Tutorial/Part1/Beginner-Tutorial-Tutorial-World.html index 3251ded0ea..ca702431d6 100644 --- a/docs/1.0-dev/Howtos/Beginner-Tutorial/Part1/Beginner-Tutorial-Tutorial-World.html +++ b/docs/1.0-dev/Howtos/Beginner-Tutorial/Part1/Beginner-Tutorial-Tutorial-World.html @@ -37,8 +37,8 @@ accesskey="P">previous |
  • Evennia 1.0-dev »
  • Tutorials and Howto’s »
    • -
  • Beginner Tutorial »
    • -
  • Part 1: What we have »
    • +
  • Beginner Tutorial »
    • +
  • Part 1: What we have »
  • 2. The Tutorial World
    • develop branch
    @@ -252,8 +252,8 @@ move on with how to access this power through code.

    >previous |
  • Evennia 1.0-dev »
  • Tutorials and Howto’s »
    • -
  • Beginner Tutorial »
    • -
  • Part 1: What we have »
    • +
  • Beginner Tutorial »
    • +
  • Part 1: What we have »
  • 2. The Tutorial World
    • develop branch
    diff --git a/docs/1.0-dev/Howtos/Beginner-Tutorial/Part2/Beginner-Tutorial-Game-Planning.html b/docs/1.0-dev/Howtos/Beginner-Tutorial/Part2/Beginner-Tutorial-Game-Planning.html index 13faac8169..a610bfdb93 100644 --- a/docs/1.0-dev/Howtos/Beginner-Tutorial/Part2/Beginner-Tutorial-Game-Planning.html +++ b/docs/1.0-dev/Howtos/Beginner-Tutorial/Part2/Beginner-Tutorial-Game-Planning.html @@ -37,8 +37,8 @@ accesskey="P">previous |
  • Evennia 1.0-dev »
  • Tutorials and Howto’s »
    • -
  • Beginner Tutorial »
    • -
  • Part 2: What we want »
    • +
  • Beginner Tutorial »
    • +
  • Part 2: What we want »
  • 2. On Planning a Game
    • develop branch
    @@ -344,8 +344,8 @@ have made their dream game a reality!

    >previous |
  • Evennia 1.0-dev »
  • Tutorials and Howto’s »
    • -
  • Beginner Tutorial »
    • -
  • Part 2: What we want »
    • +
  • Beginner Tutorial »
    • +
  • Part 2: What we want »
  • 2. On Planning a Game
    • develop branch
    diff --git a/docs/1.0-dev/Howtos/Beginner-Tutorial/Part2/Beginner-Tutorial-Part2-Intro.html b/docs/1.0-dev/Howtos/Beginner-Tutorial/Part2/Beginner-Tutorial-Part2-Overview.html similarity index 94% rename from docs/1.0-dev/Howtos/Beginner-Tutorial/Part2/Beginner-Tutorial-Part2-Intro.html rename to docs/1.0-dev/Howtos/Beginner-Tutorial/Part2/Beginner-Tutorial-Part2-Overview.html index bc089b9794..7b5ccb38c2 100644 --- a/docs/1.0-dev/Howtos/Beginner-Tutorial/Part2/Beginner-Tutorial-Part2-Intro.html +++ b/docs/1.0-dev/Howtos/Beginner-Tutorial/Part2/Beginner-Tutorial-Part2-Overview.html @@ -37,7 +37,7 @@ accesskey="P">previous |
  • Evennia 1.0-dev »
  • Tutorials and Howto’s »
    • -
  • Beginner Tutorial »
    • +
  • Beginner Tutorial »
  • Part 2: What we want
    • develop branch
    @@ -78,7 +78,7 @@

    Links

    @@ -94,7 +94,7 @@

    Versions

    develop branch
    @@ -125,7 +125,7 @@

    2. On Planning a Game

    Next topic

    -

    Part 3: How we get there (example game)

    @@ -569,15 +569,15 @@ playable game!

    modules |
  • - next |
  • previous |
  • Evennia 1.0-dev »
  • Tutorials and Howto’s »
    • -
  • Beginner Tutorial »
    • -
  • Part 2: What we want »
    • +
  • Beginner Tutorial »
    • +
  • Part 2: What we want »
  • 3. Planning our tutorial game
    • develop branch
    diff --git a/docs/1.0-dev/Howtos/Beginner-Tutorial/Part2/Beginner-Tutorial-Planning-Where-Do-I-Begin.html b/docs/1.0-dev/Howtos/Beginner-Tutorial/Part2/Beginner-Tutorial-Planning-Where-Do-I-Begin.html index a66a0185d2..0fa75ad06e 100644 --- a/docs/1.0-dev/Howtos/Beginner-Tutorial/Part2/Beginner-Tutorial-Planning-Where-Do-I-Begin.html +++ b/docs/1.0-dev/Howtos/Beginner-Tutorial/Part2/Beginner-Tutorial-Planning-Where-Do-I-Begin.html @@ -18,7 +18,7 @@ - +
    @@ -173,7 +166,7 @@ to bring your game online so you can invite your first players.

    >previous |
  • Evennia 1.0-dev »
  • Tutorials and Howto’s »
    • -
  • Beginner Tutorial »
    • +
  • Beginner Tutorial »
  • Part 5: Showing the world
    • develop branch
    diff --git a/docs/1.0-dev/Howtos/Evennia-for-MUSH-Users.html b/docs/1.0-dev/Howtos/Evennia-for-MUSH-Users.html index d151a32511..c1625dd46e 100644 --- a/docs/1.0-dev/Howtos/Evennia-for-MUSH-Users.html +++ b/docs/1.0-dev/Howtos/Evennia-for-MUSH-Users.html @@ -17,7 +17,7 @@ - +

    The Game Master role

    diff --git a/docs/1.0-dev/Howtos/Howto-Command-Prompt.html b/docs/1.0-dev/Howtos/Howto-Command-Prompt.html index 60a46a068b..d341079533 100644 --- a/docs/1.0-dev/Howtos/Howto-Command-Prompt.html +++ b/docs/1.0-dev/Howtos/Howto-Command-Prompt.html @@ -18,7 +18,7 @@ - + -

    By default, the game time runs twice as fast as the real time. You can set the time factor to be 1 -(the game time would run exactly at the same speed than the real time) or lower (the game time will -be slower than the real time). Most games choose to have the game time spinning faster (you will -find some games that have a time factor of 60, meaning the game time runs sixty times as fast as the -real time, a minute in real time would be an hour in game time).

    +

    By default, the game time runs twice as fast as the real time. You can set the time factor to be 1 (the game time would run exactly at the same speed than the real time) or lower (the game time will be slower than the real time). Most games choose to have the game time spinning faster (you will find some games that have a time factor of 60, meaning the game time runs sixty times as fast as the real time, a minute in real time would be an hour in game time).

    The epoch is a slightly more complex setting. It should contain a number of seconds that would indicate the time your game started. As indicated, an epoch of 0 would mean January 1st, 1970. If you want to set your time in the future, you just need to find the starting point in seconds. There @@ -167,8 +159,7 @@ are several ways to do this in Python, this method will show you how to do it in time.mktime(start.timetuple()) -

    This should return a huge number - the number of seconds since Jan 1 1970. Copy that directly into -your settings (editing server/conf/settings.py):

    +

    This should return a huge number - the number of seconds since Jan 1 1970. Copy that directly into your settings (editing server/conf/settings.py):

    # in a file settings.py in mygame/server/conf
 TIME_GAME_EPOCH = 1577865600
    @@ -197,20 +188,13 @@ time updated correctly… and going (by default) twice as fast as the real time.

    A game time with a custom calendar

    -

    Using a custom calendar to handle game time is sometimes needed if you want to place your game in a -fictional universe. For instance you may want to create the Shire calendar which Tolkien described -having 12 months, each which 30 days. That would give only 360 days per year (presumably hobbits -weren’t really fond of the hassle of following the astronomical calendar). Another example would be -creating a planet in a different solar system with, say, days 29 hours long and months of only 18 -days.

    +

    Using a custom calendar to handle game time is sometimes needed if you want to place your game in a fictional universe. For instance you may want to create the Shire calendar which Tolkien described having 12 months, each which 30 days. That would give only 360 days per year (presumably hobbits weren’t really fond of the hassle of following the astronomical calendar). Another example would be creating a planet in a different solar system with, say, days 29 hours long and months of only 18 days.

    Evennia handles custom calendars through an optional contrib module, called custom_gametime. Contrary to the normal gametime module described above it is not active by default.

    Setting up the custom calendar

    -

    In our first example of the Shire calendar, used by hobbits in books by Tolkien, we don’t really -need the notion of weeks… but we need the notion of months having 30 days, not 28.

    -

    The custom calendar is defined by adding the TIME_UNITS setting to your settings file. It’s a -dictionary containing as keys the name of the units, and as value the number of seconds (the -smallest unit for us) in this unit. Its keys must be picked among the following: “sec”, “min”, -“hour”, “day”, “week”, “month” and “year” but you don’t have to include them all. Here is the -configuration for the Shire calendar:

    +

    In our first example of the Shire calendar, used by hobbits in books by Tolkien, we don’t really need the notion of weeks… but we need the notion of months having 30 days, not 28.

    +

    The custom calendar is defined by adding the TIME_UNITS setting to your settings file. It’s a dictionary containing as keys the name of the units, and as value the number of seconds (the smallest unit for us) in this unit. Its keys must be picked among the following: “sec”, “min”, “hour”, “day”, “week”, “month” and “year” but you don’t have to include them all. Here is the configuration for the Shire calendar:

    # in a file settings.py in mygame/server/conf
 TIME_UNITS = {"sec": 1,
               "min": 60,
@@ -280,11 +252,8 @@ configuration for the Shire calendar:
    
               "year": 60 * 60 * 24 * 30 * 12 }
    -

    We give each unit we want as keys. Values represent the number of seconds in that unit. Hour is -set to 60 * 60 (that is, 3600 seconds per hour). Notice that we don’t specify the week unit in this -configuration: instead, we skip from days to months directly.

    -

    In order for this setting to work properly, remember all units have to be multiples of the previous -units. If you create “day”, it needs to be multiple of hours, for instance.

    +

    We give each unit we want as keys. Values represent the number of seconds in that unit. Hour is set to 60 * 60 (that is, 3600 seconds per hour). Notice that we don’t specify the week unit in this configuration: instead, we skip from days to months directly.

    +

    In order for this setting to work properly, remember all units have to be multiples of the previous units. If you create “day”, it needs to be multiple of hours, for instance.

    So for our example, our settings may look like this:

    # in a file settings.py in mygame/server/conf
 # Time factor
@@ -304,19 +273,16 @@ units.  If you create “day”, it needs to be multiple of hours, for instance.
 }
    -

    Notice we have set a time epoch of 0. Using a custom calendar, we will come up with a nice display -of time on our own. In our case the game time starts at year 0, month 1, day 1, and at midnight.

    +

    Notice we have set a time epoch of 0. Using a custom calendar, we will come up with a nice display of time on our own. In our case the game time starts at year 0, month 1, day 1, and at midnight.

    Year, hour, minute and sec starts from 0, month, week and day starts from 1, this makes them behave consistently with the standard time.

    -

    Note that while we use “month”, “week” etc in the settings, your game may not use those terms in- -game, instead referring to them as “cycles”, “moons”, “sand falls” etc. This is just a matter of you +

    Note that while we use “month”, “week” etc in the settings, your game may not use those terms in- game, instead referring to them as “cycles”, “moons”, “sand falls” etc. This is just a matter of you displaying them differently. See next section.

    A command to display the current game time

    -

    As pointed out earlier, the @time command is meant to be used with a standard calendar, not a -custom one. We can easily create a new command though. We’ll call it time, as is often the case +

    As pointed out earlier, the @time command is meant to be used with a standard calendar, not a custom one. We can easily create a new command though. We’ll call it time, as is often the case on other MU*. Here’s an example of how we could write it (for the example, you can create a file gametime.py in your commands directory and paste this code in it):

    # in a file mygame/commands/gametime.py
@@ -371,8 +337,7 @@ on other MU*.  Here’s an example of how we could write it (for the example, yo
         self.add(CmdTime())   # <- Add
    -

    Reload your game with the @reload command. You should now see the time command. If you enter -it, you might see something like:

    +

    Reload your game with the @reload command. You should now see the time command. If you enter it, you might see something like:

    We are in year 0, day 0, month 0.
 It's 00:52:17.
    @@ -384,10 +349,7 @@ And if “months” are called “moons” in your game, this is where you’d a
    @@ -407,14 +369,14 @@ same way as described for the default one above.

    modules |
  • - next |
  • previous |
  • Evennia 1.0-dev »
  • Tutorials and Howto’s »
    • -
  • Gametime Tutorial
    • +
  • Changing game calendar and time speed
    • develop branch
    diff --git a/docs/1.0-dev/Howtos/Howtos-Overview.html b/docs/1.0-dev/Howtos/Howtos-Overview.html index c66793c164..582c3dc3d0 100644 --- a/docs/1.0-dev/Howtos/Howtos-Overview.html +++ b/docs/1.0-dev/Howtos/Howtos-Overview.html @@ -17,8 +17,8 @@ - - + +
    -
    -

    Mobs and NPCs

    -
    - -
    -
    -
    -

    Vehicles

    -
    -
    @@ -253,25 +219,25 @@ a small but full game with Evennia. Other tutorials and howto’s tend to assume
    @@ -279,12 +245,12 @@ a small but full game with Evennia. Other tutorials and howto’s tend to assume

    Deep-dives

    @@ -317,10 +283,10 @@ a small but full game with Evennia. Other tutorials and howto’s tend to assume modules |
  • - next |
  • - previous |
  • Evennia 1.0-dev »
  • Tutorials and Howto’s
    • diff --git a/docs/1.0-dev/Howtos/Implementing-a-game-rule-system.html b/docs/1.0-dev/Howtos/Implementing-a-game-rule-system.html index 8686e904a5..3df5c75b20 100644 --- a/docs/1.0-dev/Howtos/Implementing-a-game-rule-system.html +++ b/docs/1.0-dev/Howtos/Implementing-a-game-rule-system.html @@ -18,7 +18,7 @@ - + diff --git a/docs/1.0-dev/Howtos/Tutorial-Vehicles.html b/docs/1.0-dev/Howtos/Tutorial-Building-a-Train.html similarity index 77% rename from docs/1.0-dev/Howtos/Tutorial-Vehicles.html rename to docs/1.0-dev/Howtos/Tutorial-Building-a-Train.html index d02cc5e392..fcbb716f4b 100644 --- a/docs/1.0-dev/Howtos/Tutorial-Vehicles.html +++ b/docs/1.0-dev/Howtos/Tutorial-Building-a-Train.html @@ -6,7 +6,7 @@ - Tutorial Vehicles — Evennia 1.0-dev documentation + Building a train that moves — Evennia 1.0-dev documentation @@ -18,7 +18,7 @@ - + @@ -62,8 +62,7 @@

    Table of Contents

      -
    • Tutorial Vehicles

      Versions

        -
      • 1.0-dev (develop branch)
        • +
      • 1.0-dev (develop branch)
        • 0.9.5 (v0.9.5 branch)
          • @@ -110,24 +109,21 @@
          -
          -

          Tutorial Vehicles

          -

          This tutorial explains how you can create vehicles that can move around in your world. The tutorial -will explain how to create a train, but this can be equally applied to create other kind of vehicles +

          +

          Building a train that moves

          +
          +

          TODO: This should be updated for latest Evennia use.

          +
          +

          Vehicles are things that you can enter and then move around in your game world. Here we’ll explain how to create a train, but this can be equally applied to create other kind of vehicles (cars, planes, boats, spaceships, submarines, …).

          -
          -

          How it works

          -

          Objects in Evennia have an interesting property: you can put any object inside another object. This -is most obvious in rooms: a room in Evennia is just like any other game object (except rooms tend to -not themselves be inside anything else).

          +

          Objects in Evennia have an interesting property: you can put any object inside another object. This is most obvious in rooms: a room in Evennia is just like any other game object (except rooms tend to not themselves be inside anything else).

          Our train will be similar: it will be an object that other objects can get inside. We then simply move the Train, which brings along everyone inside it.

          -

          Creating our train object

          The first step we need to do is create our train object, including a new typeclass. To do this, create a new file, for instance in mygame/typeclasses/train.py with the following content:

          -
          # file mygame/typeclasses/train.py
+
          # in mygame/typeclasses/train.py
 
 from evennia import DefaultObject
 
@@ -140,27 +136,21 @@ create a new file, for instance in 
          
 
          
 
          Now we can create our train in our game:
          
-
          @create/drop train:train.TrainObject
+
          create/drop train:train.TrainObject
 
          
 
          
 
          Now this is just an object that doesn’t do much yet… but we can already force our way inside it
 and back (assuming we created it in limbo).
          
-
          @tel train 
-@tel limbo
+
          tel train 
+tel limbo

          Entering and leaving the train

          -

          Using the @telcommand like shown above is obviously not what we want. @tel is an admin command -and normal players will thus never be able to enter the train! It is also not really a good idea to -use Exits to get in and out of the train - Exits are (at least by default) objects -too. They point to a specific destination. If we put an Exit in this room leading inside the train -it would stay here when the train moved away (still leading into the train like a magic portal!). In -the same way, if we put an Exit object inside the train, it would always point back to this room, -regardless of where the Train has moved. Now, one could define custom Exit types that move with -the train or change their destination in the right way - but this seems to be a pretty cumbersome -solution.

          +

          Using the telcommand like shown above is obviously not what we want. @tel is an admin command and normal players will thus never be able to enter the train!

          +

          It is also not really a good idea to use Exits to get in and out of the train - Exits are (at least by default) objects too. They point to a specific destination. If we put an Exit in this room leading inside the train it would stay here when the train moved away (still leading into the train like a magic portal!). In the same way, if we put an Exit object inside the train, it would always point back to this room, regardless of where the Train has moved.

          +

          Now, one could define custom Exit types that move with the train or change their destination in the right way - but this seems to be a pretty cumbersome solution.

          What we will do instead is to create some new commands: one for entering the train and another for leaving it again. These will be stored on the train object and will thus be made available to whomever is either inside it or in the same room as the train.

          @@ -181,7 +171,6 @@ available to whomever is either inside it or in the same room as the train.

          """ key = "enter train" - locks = "cmd:all()" def func(self): train = self.obj @@ -202,7 +191,6 @@ available to whomever is either inside it or in the same room as the train.

          """ key = "leave train" - locks = "cmd:all()" def func(self): train = self.obj @@ -219,34 +207,29 @@ available to whomever is either inside it or in the same room as the train.

          Note that while this seems like a lot of text, the majority of lines here are taken up by documentation.

          -

          These commands are work in a pretty straightforward way: CmdEnterTrain moves the location of the -player to inside the train and CmdLeaveTrain does the opposite: it moves the player back to the -current location of the train (back outside to its current location). We stacked them in a -cmdset CmdSetTrain so they can be used.

          +

          These commands are work in a pretty straightforward way: CmdEnterTrain moves the location of the player to inside the train and CmdLeaveTrain does the opposite: it moves the player back to the +current location of the train (back outside to its current location). We stacked them in a cmdset CmdSetTrain so they can be used.

          To make the commands work we need to add this cmdset to our train typeclass:

          # file mygame/typeclasses/train.py
 
-from evennia import DefaultObject
 from commands.train import CmdSetTrain
+from typeclasses.objects import Object
 
-class TrainObject(DefaultObject):
+class TrainObject(Object):
 
     def at_object_creation(self):        
         self.cmdset.add_default(CmdSetTrain)
          -

          If we now @reload our game and reset our train, those commands should work and we can now enter -and leave the train:

          -
          @reload
-@typeclass/force/reset train = train.TrainObject
+
          If we now reload our game and reset our train, those commands should work and we can now enter and leave the train:
          
+
          reload
+typeclass/force/reset train = train.TrainObject
 enter train
 leave train
 
          
 
          
-
          Note the switches used with the @typeclass command: The /force switch is necessary to assign our
-object the same typeclass we already have. The /reset re-triggers the typeclass’
-at_object_creation() hook (which is otherwise only called the very first an instance is created).
+
          Note the switches used with the typeclass command: The /force switch is necessary to assign our object the same typeclass we already have. The /reset re-triggers the typeclass’ at_object_creation() hook (which is otherwise only called the very first an instance is created).
 As seen above, when this hook is called on our train, our new cmdset will be loaded.
          
 
 
          
@@ -254,15 +237,10 @@ As seen above, when this hook is called on our train, our new cmdset will be loa
 
          If you have played around a bit, you’ve probably figured out that you can use leave train when
 outside the train and enter train when inside. This doesn’t make any sense … so let’s go ahead
 and fix that.  We need to tell Evennia that you can not enter the train when you’re already inside
-or leave the train when you’re outside. One solution to this is locks: we will lock down
-the commands so that they can only be called if the player is at the correct location.
          
-
          Right now commands defaults to the lock cmd:all(). The cmd lock type in combination with the
-all() lock function means that everyone can run those commands as long as they are in the same
-room as the train or inside the train. We’re going to change this to check the location of the
-player and only allow access if they are inside the train.
          
+or leave the train when you’re outside. One solution to this is locks: we will lock down the commands so that they can only be called if the player is at the correct location.
          
+
          Since we didn’t set a lock property on the Command, it defaults to cmd:all(). This means that everyone can use the command as long as they are in the same room or inside the train.
          
 
          First of all we need to create a new lock function. Evennia comes with many lock functions built-in
-already, but none that we can use for locking a command in this particular case. Create a new entry
-in mygame/server/conf/lockfuncs.py:
          
+already, but none that we can use for locking a command in this particular case. Create a new entry in mygame/server/conf/lockfuncs.py:
          
 
          
 # file mygame/server/conf/lockfuncs.py
 
@@ -278,12 +256,7 @@ in mygame/server/co
 
          
 
          If you didn’t know, Evennia is by default set up to use all functions in this module as lock
 functions (there is a setting variable that points to it).
          
-
          Our new lock function, cmdinside, is to be used by Commands.  The accessed_obj is the Command
-object (in our case this will be CmdEnterTrain and CmdLeaveTrain) — Every command has an obj
-property: this is the the object on which the command “sits”.  Since we added those commands to our
-train object, the .obj property will be set to the train object. Conversely, accessing_obj is
-the object that called the command: in our case it’s the Character trying to enter or leave the
-train.
          
+
          Our new lock function, cmdinside, is to be used by Commands.  The accessed_obj is the Command object (in our case this will be CmdEnterTrain and CmdLeaveTrain) — Every command has an obj property: this is the the object on which the command “sits”.  Since we added those commands to our train object, the .obj property will be set to the train object. Conversely, accessing_obj is the object that called the command: in our case it’s the Character trying to enter or leave the train.
          
 
          What this function does is to check that the player’s location is the same as the train object. If
 it is, it means the player is inside the train. Otherwise it means the player is somewhere else and
 the check will fail.
          
@@ -314,28 +287,23 @@ user ignores lock functions. In order to use this functionality you need to Now that we can enter and leave the train correctly, it’s time to make it move.  There are different
 things we need to consider for this:
          
 
            
-
          • Who can control your vehicle? The first player to enter it, only players that have a certain
-“drive” skill, automatically?
            • 
-
          • Where should it go? Can the player steer the vehicle to go somewhere else or will it always follow
-the same route?
            • 
+
          • Who can control your vehicle? The first player to enter it, only players that have a certain “drive” skill, automatically?
            • 
+
          • Where should it go? Can the player steer the vehicle to go somewhere else or will it always follow the same route?
            • 
 
          
-
          For our example train we’re going to go with automatic movement through a predefined route (its
-track). The train will stop for a bit at the start and end of the route to allow players to enter
-and leave it.
          
-
          Go ahead and create some rooms for our train. Make a list of the room ids along the route (using the
-@ex command).
          
-
          @dig/tel South station
-@ex              # note the id of the station
-@tunnel/tel n = Following a railroad
-@ex              # note the id of the track
-@tunnel/tel n = Following a railroad
-...
-@tunnel/tel n = North Station
+
          For our example train we’re going to go with automatic movement through a predefined route (its track). The train will stop for a bit at the start and end of the route to allow players to enter and leave it.
          
+
          Go ahead and create some rooms for our train. Make a list of the room ids along the route (using the xe command).
          
+
          > dig/tel South station
+> ex              # note the id of the station
+> tunnel/tel n = Following a railroad
+> ex              # note the id of the track
+> tunnel/tel n = Following a railroad
+> ...
+> tunnel/tel n = North Station
 
          
 
          
 
          Put the train onto the tracks:
          
-
          @tel south station
-@tel train = here
+
          tel south station
+tel train = here
 
          
 
          
 
          Next we will tell the train how to move and which route to take.
          
@@ -377,26 +345,22 @@ and leave it.
          
             self.msg_contents(f"The train is moving forward to {room.name}.")
 
          
 
          
-
          We added a lot of code here. Since we changed the at_object_creation to add in variables we will
-have to reset our train object like earlier (using the @typeclass/force/reset command).
          
+
          We added a lot of code here. Since we changed the at_object_creation to add in variables we will have to reset our train object like earlier (using the @typeclass/force/reset command).
          
 
          We are keeping track of a few different things now: whether the train is moving or standing still,
 which direction the train is heading to and what rooms the train will pass through.
          
-
          We also added some methods: one to start moving the train, another to stop and a third that actually
-moves the train to the next room in the list. Or makes it stop driving if it reaches the last stop.
          
-
          Let’s try it out, using @py to call the new train functionality:
          
-
          @reload
-@typeclass/force/reset train = train.TrainObject
-enter train
-@py here.goto_next_room()
+
          We also added some methods: one to start moving the train, another to stop and a third that actually moves the train to the next room in the list. Or makes it stop driving if it reaches the last stop.
          
+
          Let’s try it out, using py to call the new train functionality:
          
+
          > reload
+> typeclass/force/reset train = train.TrainObject
+> enter train
+> py here.goto_next_room()
 
          
 
          
 
          You should see the train moving forward one step along the rail road.
          
 
          
 
          
 
          Adding in scripts
          
-
          If we wanted full control of the train we could now just add a command to step it along the track
-when desired. We want the train to move on its own though, without us having to force it by manually
-calling the goto_next_room method.
          
+
          If we wanted full control of the train we could now just add a command to step it along the track when desired. We want the train to move on its own though, without us having to force it by manually calling the goto_next_room method.
          
 
          To do this we will create two scripts: one script that runs when the train has stopped at
 a station and is responsible for starting the train again after a while. The other script will take
 care of the driving.
          
@@ -457,9 +421,9 @@ train again., and we’re ready to ride it around!
          
         self.scripts.add(TrainStoppedScript)
          -
          @reload
-@typeclass/force/reset train = train.TrainObject
-enter train
+
          > reload
+> typeclass/force/reset train = train.TrainObject
+> enter train
 
 # output:
 < The train is moving forward to Following a railroad.
@@ -479,14 +443,10 @@ train again., and we’re ready to ride it around!
          
 
          This train is very basic and still has some flaws. Some more things to do:
          
 
            
 
          • Make it look like a train.
            • 
-
          • Make it impossible to exit and enter the train mid-ride. This could be made by having the
-enter/exit commands check so the train is not moving before allowing the caller to proceed.
            • 
+
          • Make it impossible to exit and enter the train mid-ride. This could be made by having the enter/exit commands check so the train is not moving before allowing the caller to proceed.
            • 
 
          • Have train conductor commands that can override the automatic start/stop.
            • 
 
          • Allow for in-between stops between the start- and end station
            • 
-
          • Have a rail road track instead of hard-coding the rooms in the train object. This could for
-example be a custom Exit only traversable by trains. The train will follow the
-track. Some track segments can split to lead to two different rooms and a player can switch the
-direction to which room it goes.
            • 
+
          • Have a rail road track instead of hard-coding the rooms in the train object. This could for example be a custom Exit only traversable by trains. The train will follow the track. Some track segments can split to lead to two different rooms and a player can switch the direction to which room it goes.
            • 
 
          • Create another kind of vehicle!
            • 
 
          
 
@@ -511,11 +471,11 @@ direction to which room it goes.
          
           next |
         
        • 
-          previous |
          • 
         
        • Evennia 1.0-dev »
          • 
           
        • Tutorials and Howto’s »
          • 
-        
        • Tutorial Vehicles
          •  
+        
        • Building a train that moves
          •
        develop branch
        diff --git a/docs/1.0-dev/Howtos/Tutorial-Coordinates.html b/docs/1.0-dev/Howtos/Tutorial-Coordinates.html index 18a1d62a60..d3272286c3 100644 --- a/docs/1.0-dev/Howtos/Tutorial-Coordinates.html +++ b/docs/1.0-dev/Howtos/Tutorial-Coordinates.html @@ -6,7 +6,7 @@ - Coordinates — Evennia 1.0-dev documentation + Adding room coordinates to your game — Evennia 1.0-dev documentation @@ -17,8 +17,8 @@ - - + +
      develop branch
      @@ -62,26 +62,25 @@

      Table of Contents

        -
      • Coordinates
        • -
      • Adding room coordinates in your game

        Previous topic

        -

        Weather Tutorial

        +

        Adding Weather messages to a Room

        Next topic

        -

        Dynamic In Game Map

        +

        Show a dynamic map of rooms

          @@ -112,18 +111,14 @@
          -
          -

          Coordinates

          -
          -
          -

          Adding room coordinates in your game

          -

          This tutorial is moderately difficult in content. You might want to be familiar and at ease with -some Python concepts (like properties) and possibly Django concepts (like queries), although this -tutorial will try to walk you through the process and give enough explanations each time. If you -don’t feel very confident with math, don’t hesitate to pause, go to the example section, which shows -a tiny map, and try to walk around the code or read the explanation.

          -

          Evennia doesn’t have a coordinate system by default. Rooms and other objects are linked by location -and content:

          +
          +

          Adding room coordinates to your game

          + +

          This tutorial is moderately difficult in content. You might want to be familiar and at ease with some Python concepts (like properties) and possibly Django concepts (like queries), although this tutorial will try to walk you through the process and give enough explanations each time. If you don’t feel very confident with math, don’t hesitate to pause, go to the example section, which shows a tiny map, and try to walk around the code or read the explanation.

          +

          Evennia doesn’t have a coordinate system by default. Rooms and other objects are linked by location and content:

          • An object can be in a location, that is, another object. Like an exit in a room.

          • An object can access its content. A room can see what objects uses it as location (that would @@ -137,14 +132,8 @@ instance.

            Coordinates as tags

            The first concept might be the most surprising at first glance: we will create coordinates as tags.

            -
            -

            Why not attributes, wouldn’t that be easier?

            -
            -

            It would. We could just do something like room.db.x = 3. The advantage of using tags is that it -will be easy and effective to search. Although this might not seem like a huge advantage right now, -with a database of thousands of rooms, it might make a difference, particularly if you have a lot of -things based on coordinates.

            -

            Rather than giving you a step-by-step process, I’ll show you the code. Notice that we use +

            So, why not attributes, wouldn’t that be easier? It would. We could just do something like room.db.x = 3. The advantage of using tags is that it will be easy and effective to search. Although this might not seem like a huge advantage right now, with a database of thousands of rooms, it might make a difference, particularly if you have a lot of things based on coordinates.

            +

            Rather than giving you a step-by-step process, We’ll show you the code. Notice that we use properties to easily access and update coordinates. This is a Pythonic approach. Here’s our first Room class, that you can modify in typeclasses/rooms.py:

            # in typeclasses/rooms.py
@@ -227,12 +216,7 @@ The tags.get
 
          • We convert the value to an integer, if it’s a str.  Remember that tags can only contain str,
 so we’ll need to convert it.
            • 
 
-
            
-
            I thought tags couldn’t contain values?
            
-
            
-
            Well, technically, they can’t: they’re either here or not.  But using tag categories, as we have
-done, we get a tag, knowing only its category.  That’s the basic approach to coordinates in this
-tutorial.
            
+
            So can Tags contain values? Well, technically, they can’t: they’re either here or not.  But using tag categories, as we have done, we get a tag, knowing only its category.  That’s the basic approach to coordinates in this tutorial.
            
 
            Now, let’s look at the method that will be called when we wish to set x in our room:
            
 
                @x.setter
     def x(self, x):
@@ -249,19 +233,15 @@ tutorial.
            
 room with “coordx” as their category, which wouldn’t do at all.

          • Then we add the new tag, giving it the proper category.

            • -
            -

            Now what?

            -

            If you add this code and reload your game, once you’re logged in with a character in a room as its location, you can play around:

            -
            @py here.x
-@py here.x = 0
-@py here.y = 3
-@py here.z = -2
-@py here.z = None
+
            py here.x
+py here.x = 0
+py here.y = 3
+py here.z = -2
+py here.z = None
 
            
 
            
-
            The code might not be that easy to read, but you have to admit it’s fairly easy to use.

          Some additional searches

          @@ -305,23 +285,18 @@ Z=0?

          return None
          -

          This solution includes a bit of Django -queries. -Basically, what we do is reach for the object manager and search for objects with the matching tags. -Again, don’t spend too much time worrying about the mechanism, the method is quite easy to use:

          +

          This solution includes some Django queries. Basically, what we do is reach for the object manager and search for objects with the matching tags. Again, don’t spend too much time worrying about the mechanism, the method is quite easy to use:

          Room.get_room_at(5, 2, -3)
          -

          Notice that this is a class method: you will call it from Room (the class), not an instance. -Though you still can:

          -
          @py here.get_room_at(3, 8, 0)
+
          Notice that this is a class method: you will call it from Room (the class), not an instance. Though you still can:
          
+
          py here.get_room_at(3, 8, 0)
 
          
 
          
 
 
          
 
          Finding several rooms
          
-
          Here’s another useful method that allows us to look for rooms around a given coordinate.  This is
-more advanced search and doing some calculation, beware!  Look at the following section if you’re
+
          Here’s another useful method that allows us to look for rooms around a given coordinate.  This is more advanced search and doing some calculation, beware!  Look at the following section if you’re
 lost.
          
 
          from math import sqrt
 
@@ -385,9 +360,7 @@ lost.
          
 
            
 
          1. We have specified coordinates as parameters.  We determine a broad range using the distance.
 That is, for each coordinate, we create a list of possible matches.  See the example below.
            2. 
-
          2. We then search for the rooms within this broader range.  It gives us a square
-around our location.  Some rooms are definitely outside the range.  Again, see the example below
-to follow the logic.
            3. 
+
          3. We then search for the rooms within this broader range.  It gives us a square around our location.  Some rooms are definitely outside the range.  Again, see the example below to follow the logic.
            4. 
 
          4. We filter down the list and sort it by distance from the specified coordinates.
            5. 
 
          
 
          Notice that we only search starting at step 2.  Thus, the Django search doesn’t look and cache all
@@ -406,24 +379,16 @@ optimized to be quick and efficient.
          
   1 2 3 4
 
          
 
          
-
          The X coordinates are given below.  The Y coordinates are given on the left.  This is a simple
-square with 16 rooms: 4 on each line, 4 lines of them.  All the rooms are identified by letters in
-this example: the first line at the top has rooms A to D, the second E to H, the third I to L and
-the fourth M to P.  The bottom-left room, X=1 and Y=1, is M.  The upper-right room X=4 and Y=4 is D.
          
-
          So let’s say we want to find all the neighbors, distance 1, from the room J.  J is at X=2, Y=2.
          
+
          The X coordinates are given below.  The Y coordinates are given on the left.  This is a simple square with 16 rooms: 4 on each line, 4 lines of them.  All the rooms are identified by letters in this example: the first line at the top has rooms A to D, the second E to H, the third I to L and the fourth M to P.  The bottom-left room, X=1 and Y=1, is M.  The upper-right room X=4 and Y=4 is D.
+So let’s say we want to find all the neighbors, distance 1, from the room J.  J is at X=2, Y=2.
          
 
          So we use:
          
 
          Room.get_rooms_around(x=2, y=2, z=0, distance=1)
 # we'll assume a z coordinate of 0 for simplicity
 
          
 
          
 
            
-
          1. First, this method gets all the rooms in a square around J.  So it gets E F G, I J K, M N O.  If
-you want, draw the square around these coordinates to see what’s happening.
            2. 
-
          2. Next, we browse over this list and check the real distance between J (X=2, Y=2) and the room.
-The four corners of the square are not in this circle.  For instance, the distance between J and M
-is not 1.  If you draw a circle of center J and radius 1, you’ll notice that the four corners of our
-square (E, G, M and O) are not in this circle. So we remove them.
            3. 
-
          3. We sort by distance from J.
            4. 
+
          4. First, this method gets all the rooms in a square around J.  So it gets E F G, I J K, M N O.  If you want, draw the square around these coordinates to see what’s happening.
            5. 
+
          5. Next, we browse over this list and check the real distance between J (X=2, Y=2) and the room. The four corners of the square are not in this circle.  For instance, the distance between J and M is not 1.  If you draw a circle of center J and radius 1, you’ll notice that the four corners of our square (E, G, M and O) are not in this circle. So we remove them. 3. We sort by distance from J.
            6. 
 
          
 
          So in the end we might obtain something like this:
          
 
          [
@@ -437,11 +402,11 @@ square (E, G, M and O) are not in this circle. So we remove them.
          
 
          
 
          You can try with more examples if you want to see this in action.
          
 
          
-
          
-
          To conclude
          
-
          You can definitely use this system to map other objects, not just rooms.  You can easily remove the
-`Z coordinate too, if you simply need X and Y.
          
 
          
+
          
+
          To conclude
          
+
          You can also use this system to map other objects, not just rooms.  You can easily remove the
+Z coordinate too, if you simply need X and Y.
          
 
          
 
 
@@ -461,14 +426,14 @@ square (E, G, M and O) are not in this circle. So we remove them.
          
           modules |
         
        • 
-          next |
          • 
         
        • 
-          previous |
          • 
         
        • Evennia 1.0-dev »
          • 
           
        • Tutorials and Howto’s »
          • 
-        
        • Coordinates
          •  
+        
        • Adding room coordinates to your game
          •
        develop branch
        diff --git a/docs/1.0-dev/Howtos/Dynamic-In-Game-Map.html b/docs/1.0-dev/Howtos/Tutorial-Displaying-Room-Map.html similarity index 82% rename from docs/1.0-dev/Howtos/Dynamic-In-Game-Map.html rename to docs/1.0-dev/Howtos/Tutorial-Displaying-Room-Map.html index f775974b80..f9afba0845 100644 --- a/docs/1.0-dev/Howtos/Dynamic-In-Game-Map.html +++ b/docs/1.0-dev/Howtos/Tutorial-Displaying-Room-Map.html @@ -6,7 +6,7 @@ - Dynamic In Game Map — Evennia 1.0-dev documentation + Show a dynamic map of rooms — Evennia 1.0-dev documentation @@ -17,8 +17,8 @@ - - + +
      • - next |
      • - previous |
      • Evennia 1.0-dev »
      • Tutorials and Howto’s »
        • -
      • Dynamic In Game Map
        • +
      • Show a dynamic map of rooms
      develop branch
      @@ -62,8 +62,7 @@

      Table of Contents

        -
      • Dynamic In Game Map
          -
        • Introduction
          • +
        • Show a dynamic map of rooms

          Versions

            -
          • 1.0-dev (develop branch)
            • +
          • 1.0-dev (develop branch)
            • 0.9.5 (v0.9.5 branch)
              • @@ -110,53 +109,44 @@
              -
              -

              Dynamic In Game Map

              -
              -

              Introduction

              -

              An often desired feature in a MUD is to show an in-game map to help navigation. The Static in-game -map tutorial solves this by creating a static map, meaning the map is pre- -drawn once and for all - the rooms are then created to match that map. When walking around, parts of -the static map is then cut out and displayed next to the room description.

              -

              In this tutorial we’ll instead do it the other way around; We will dynamically draw the map based on -the relationships we find between already existing rooms.

              -
              +
              +

              Show a dynamic map of rooms

              + +

              An often desired feature in a MUD is to show an in-game map to help navigation.

              +
              Forest path
+
+         [.]   [.]
+[.][.][@][.][.][.]
+         [.]   [.][.][.]
+
+The trees are looming over the narrow forest path.
+
+Exits: East, West
+
              +

              The Grid of Rooms

              There are at least two requirements needed for this tutorial to work.

                -

              1. The structure of your mud has to follow a logical layout. Evennia supports the layout of your -world to be ‘logically’ impossible with rooms looping to themselves or exits leading to the other -side of the map. Exits can also be named anything, from “jumping out the window” to “into the fifth -dimension”. This tutorial assumes you can only move in the cardinal directions (N, E, S and W).

                2. -

              2. Rooms must be connected and linked together for the map to be generated correctly. Vanilla -Evennia comes with a admin command tunnel that allows a -user to create rooms in the cardinal directions, but additional work is needed to assure that rooms -are connected. For example, if you tunnel east and then immediately do tunnel west you’ll find -that you have created two completely stand-alone rooms. So care is needed if you want to create a -“logical” layout. In this tutorial we assume you have such a grid of rooms that we can generate the -map from.

                3. +

              3. The structure of your mud has to follow a logical layout. Evennia supports the layout of your world to be ‘logically’ impossible with rooms looping to themselves or exits leading to the other side of the map. Exits can also be named anything, from “jumping out the window” to “into the fifth dimension”. This tutorial assumes you can only move in the cardinal directions (N, E, S and W).

                4. +

              4. Rooms must be connected and linked together for the map to be generated correctly. Vanilla Evennia comes with a admin command tunnel that allows a user to create rooms in the cardinal directions, but additional work is needed to assure that rooms are connected. For example, if you tunnel east and then immediately do tunnel west you’ll find that you have created two completely stand-alone rooms. So care is needed if you want to create a “logical” layout. In this tutorial we assume you have such a grid of rooms that we can generate the map from.

              Concept

              -

              Before getting into the code, it is beneficial to understand and conceptualize how this is going to -work. The idea is analogous to a worm that starts at your current position. It chooses a direction -and ‘walks’ outward from it, mapping its route as it goes. Once it has traveled a pre-set distance -it stops and starts over in another direction. An important note is that we want a system which is -easily callable and not too complicated. Therefore we will wrap this entire code into a custom -Python class (not a typeclass as this doesn’t use any core objects from evennia itself).

              -

              We are going to create something that displays like this when you type ‘look’:

              -
                  Hallway
+
              Before getting into the code, it is beneficial to understand and conceptualize how this is going to work. The idea is analogous to a worm that starts at your current position. It chooses a direction and ‘walks’ outward from it, mapping its route as it goes. Once it has traveled a pre-set distance it stops and starts over in another direction. An important note is that we want a system which is easily callable and not too complicated. Therefore we will wrap this entire code into a custom Python class (not a typeclass as this doesn’t use any core objects from evennia itself).  We are going to create something that displays like this when you type ‘look’:
              
+
              Hallway
 
-          [.]   [.]
-          [@][.][.][.][.]
-          [.]   [.]   [.]
+      [.]   [.]
+      [@][.][.][.][.]
+      [.]   [.]   [.]
 
-    The distant echoes of the forgotten
-    wail throughout the empty halls.
+The distant echoes of the forgotten
+wail throughout the empty halls.
 
-    Exits: North, East, South
+Exits: North, East, South
 
              
 
              
 
              Your current location is defined by [@] while the [.]s are other rooms that the “worm” has seen
@@ -164,12 +154,7 @@ since departing from your location.

              Setting up the Map Display

              -

              First we must define the components for displaying the map. For the “worm” to know what symbol to -draw on the map we will have it check an Attribute on the room it visits called sector_type. For -this tutorial we understand two symbols - a normal room and the room with us in it. We also define a -fallback symbol for rooms without said Attribute - that way the map will still work even if we -didn’t prepare the room correctly. Assuming your game folder is named mygame, we create this code -in mygame/world/map.py.

              +

              First we must define the components for displaying the map. For the “worm” to know what symbol to draw on the map we will have it check an Attribute on the room it visits called sector_type. For this tutorial we understand two symbols - a normal room and the room with us in it. We also define a fallback symbol for rooms without said Attribute - that way the map will still work even if we didn’t prepare the room correctly. Assuming your game folder is named mygame, we create this code in mygame/world/map.py.

              # in mygame/world/map.py
 
 # the symbol is identified with a key "sector_type" on the
@@ -197,17 +182,11 @@ methods we need.

              • self.caller is normally your Character object, the one using the map.

                • -

              • self.max_width/length determine the max width and length of the map that will be generated. Note -that it’s important that these variables are set to odd numbers to make sure the display area has -a center point.

                • -

              • self.worm_has_mapped is building off the worm analogy above. This dictionary will store all -rooms the “worm” has mapped as well as its relative position within the grid. This is the most -important variable as it acts as a ‘checker’ and ‘address book’ that is able to tell us where the -worm has been and what it has mapped so far.

                • +

              • self.max_width/length determine the max width and length of the map that will be generated. Note that it’s important that these variables are set to odd numbers to make sure the display area has a center point.

                • +

              • self.worm_has_mapped is building off the worm analogy above. This dictionary will store all rooms the “worm” has mapped as well as its relative position within the grid. This is the most important variable as it acts as a ‘checker’ and ‘address book’ that is able to tell us where the worm has been and what it has mapped so far.

              • self.curX/Y are coordinates representing the worm’s current location on the grid.

              -

              Before any sort of mapping can actually be done we need to create an empty display area and do some -sanity checks on it by using the following methods.

              +

              Before any sort of mapping can actually be done we need to create an empty display area and do some sanity checks on it by using the following methods.

              # in mygame/world/map.py
 
 class Map(object):
@@ -230,8 +209,7 @@ sanity checks on it by using the following methods.
              
             else False
              -

              Before we can set our worm on its way, we need to know some of the computer science behind all this -called ‘Graph Traversing’. In Pseudo code what we are trying to accomplish is this:

              +

              Before we can set our worm on its way, we need to know some of the computer science behind all this called ‘Graph Traversing’. In Pseudo code what we are trying to accomplish is this:

              # pseudo code
 
 def draw_room_on_map(room, max_distance):
@@ -252,35 +230,25 @@ called ‘Graph Traversing’. In Pseudo code what we are trying to accomplish i
 
              The beauty of Python is that our actual code of doing this doesn’t differ much if at all from this
 Pseudo code example.
              
 
                
-
              • max_distance is a variable indicating to our Worm how many rooms AWAY from your current location
-will it map. Obviously the larger the number the more time it will take if your current location has
-many many rooms around you.
                • 
+
              • max_distance is a variable indicating to our Worm how many rooms AWAY from your current location will it map. Obviously the larger the number the more time it will take if your current location has many many rooms around you.
                • 
 
              
-
              The first hurdle here is what value to use for ‘max_distance’. There is no reason for the worm to
-travel further than what is actually displayed to you. For example, if your current location is
-placed in the center of a display area of size max_length = max_width = 9, then the worm need only
+
              The first hurdle here is what value to use for ‘max_distance’. There is no reason for the worm to travel further than what is actually displayed to you. For example, if your current location is placed in the center of a display area of size max_length = max_width = 9, then the worm need only
 go 4 spaces in either direction:
              
 
              [.][.][.][.][@][.][.][.][.]
  4  3  2  1  0  1  2  3  4
 
              
 
              
-
              The max_distance can be set dynamically based on the size of the display area. As your width/length
-changes it becomes a simple algebraic linear relationship which is simply max_distance = (min(max_width, max_length) -1) / 2.
              
+
              The max_distance can be set dynamically based on the size of the display area. As your width/length changes it becomes a simple algebraic linear relationship which is simply max_distance = (min(max_width, max_length) -1) / 2.

              Building the Mapper

              -

              Now we can start to fill our Map object with some methods. We are still missing a few methods that -are very important:

              +

              Now we can start to fill our Map object with some methods. We are still missing a few methods that are very important:

              • self.draw(self, room) - responsible for actually drawing room to grid.

                • -

              • self.has_drawn(self, room) - checks to see if the room has been mapped and worm has already been -here.

                • -

              • self.median(self, number) - a simple utility method that finds the median (middle point) from 0, -n

                • -

              • self.update_pos(self, room, exit_name) - updates the worm’s physical position by reassigning -self.curX/Y. .accordingly

                • -

              • self.start_loc_on_grid(self) - the very first initial draw on the grid representing your -location in the middle of the grid

                • +

              • self.has_drawn(self, room) - checks to see if the room has been mapped and worm has already been here.

                • +

              • self.median(self, number) - a simple utility method that finds the median (middle point) from 0, n

                • +

              • self.update_pos(self, room, exit_name) - updates the worm’s physical position by reassigning self.curX/Y accordingly.

                • +

              • self.start_loc_on_grid(self) - the very first initial draw on the grid representing your location in the middle of the grid.

              • self.show_map - after everything is done convert the map into a readable string

              • self.draw_room_on_map(self, room, max_distance) - the main method that ties it all together.

              @@ -307,10 +275,8 @@ conditional statements and set it up to start building the display.

              -

              Here we check to see if the parameters for the grid are okay, then we create an empty canvas and map -our initial location as the first room!

              -

              As mentioned above, the code for the self.draw_room_on_map() is not much different than the Pseudo -code. The method is shown below:

              +

              Here we check to see if the parameters for the grid are okay, then we create an empty canvas and map our initial location as the first room!

              +

              As mentioned above, the code for the self.draw_room_on_map() is not much different than the Pseudo code. The method is shown below:

              # in mygame/world/map.py, in the Map class
 
 def draw_room_on_map(self, room, max_distance):
@@ -431,22 +397,9 @@ presentational string out of it using the return string
              -

              Obviously this method of generating maps doesn’t take into account of any doors or exits that are -hidden… etc… but hopefully it serves as a good base to start with. Like previously mentioned, it -is very important to have a solid foundation on rooms before implementing this. You can try this on -vanilla evennia by using @tunnel and essentially you can just create a long straight/edgy non- -looping rooms that will show on your in-game map.

              -

              The above example will display the map above the room description. You could also use an -EvTable to place description and map next to each other. Some other -things you can do is to have a Command that displays with a larger radius, maybe with a -legend and other features.

              -

              Below is the whole map.py for your reference. You need to update your Room typeclass (see above) -to actually call it. Remember that to see different symbols for a location you also need to set the -sector_type Attribute on the room to one of the keys in the SYMBOLS dictionary. So in this -example, to make a room be mapped as [.] you would set the room’s sector_type to -"SECT_INSIDE". Try it out with @set here/sector_type = "SECT_INSIDE". If you wanted all new -rooms to have a given sector symbol, you could change the default in the SYMBOLS dictionary below, -or you could add the Attribute in the Room’s at_object_creation method.

              +

              Obviously this method of generating maps doesn’t take into account of any doors or exits that are hidden… etc… but hopefully it serves as a good base to start with. Like previously mentioned, it is very important to have a solid foundation on rooms before implementing this. You can try this on vanilla evennia by using @tunnel and essentially you can just create a long straight/edgy non- looping rooms that will show on your in-game map.

              +

              The above example will display the map above the room description. You could also use an EvTable to place description and map next to each other. Some other things you can do is to have a Command that displays with a larger radius, maybe with a legend and other features.

              +

              Below is the whole map.py for your reference. You need to update your Room typeclass (see above) to actually call it. Remember that to see different symbols for a location you also need to set the sector_type Attribute on the room to one of the keys in the SYMBOLS dictionary. So in this example, to make a room be mapped as [.] you would set the room’s sector_type to "SECT_INSIDE". Try it out with @set here/sector_type = "SECT_INSIDE". If you wanted all new rooms to have a given sector symbol, you could change the default in the SYMBOLS dictionary below, or you could add the Attribute in the Room’s at_object_creation method.

              # mygame/world/map.py
 
 # These are keys set with the Attribute sector_type on the room.
@@ -587,14 +540,14 @@ also look into up/down directions and figure out how to display that in a good w
           modules |
         
            • 
-          next |
              • 
         
            • 
-          previous |
              • 
         
            • Evennia 1.0-dev »
              • 
           
            • Tutorials and Howto’s »
              • 
-        
            • Dynamic In Game Map
              •  
+        
            • Show a dynamic map of rooms
              •
            develop branch
            diff --git a/docs/1.0-dev/Howtos/Tutorial-NPC-Merchants.html b/docs/1.0-dev/Howtos/Tutorial-NPC-Merchants.html index 601826eaf4..680a79d146 100644 --- a/docs/1.0-dev/Howtos/Tutorial-NPC-Merchants.html +++ b/docs/1.0-dev/Howtos/Tutorial-NPC-Merchants.html @@ -17,7 +17,7 @@ - +

          Versions

          develop branch
          @@ -62,7 +62,7 @@

          Table of Contents

            -
          • Arxcode installing help
              +
            • Using the Arxcode game dir

              Versions

                -
              • 1.0-dev (develop branch)
                • +
              • 1.0-dev (develop branch)
                • 0.9.5 (v0.9.5 branch)
                  • @@ -96,23 +96,33 @@
                  -
                  -

                  Weather Tutorial

                  -

                  This tutorial will have us create a simple weather system for our MUD. The way we want to use this -is to have all outdoor rooms echo weather-related messages to the room at regular and semi-random -intervals. Things like “Clouds gather above”, “It starts to rain” and so on.

                  -

                  One could imagine every outdoor room in the game having a script running on themselves that fires -regularly. For this particular example it is however more efficient to do it another way, namely by -using a “ticker-subscription” model. The principle is simple: Instead of having each Object -individually track the time, they instead subscribe to be called by a global ticker who handles time -keeping. Not only does this centralize and organize much of the code in one place, it also has less -computing overhead.

                  -

                  Evennia offers the TickerHandler specifically for using the subscription model. We -will use it for our weather system.

                  -

                  We will assume you know how to make your own Typeclasses. If not see one of the beginning tutorials. -We will create a new WeatherRoom typeclass that is aware of the day-night cycle.

                  -
                  
-    import random
+  
                  
+
                  Adding Weather messages to a Room
                  
+
                  This tutorial will have us create a simple weather system for our MUD.  The way we want to use this is to have all outdoor rooms echo weather-related messages to the room at regular and semi-random intervals. Things like “Clouds gather above”, “It starts to rain” and so on.
                  
+
                  One could imagine every outdoor room in the game having a script running on themselves that fires regularly. For this particular example it is however more efficient to do it another way, namely by using a “ticker-subscription” model.
                  
+
                  The principle is simple: Instead of having each Object individually track the time, they instead subscribe to be called by a global ticker who handles time keeping.  Not only does this centralize and organize much of the code in one place, it also has less computing overhead.
                  
+
                  Evennia’s TickerHandler specifically offers such a subscription model. We will use it for our weather system.
                  
+
                  We will create a new WeatherRoom typeclass that is aware of the day-night cycle.
                  
+
                   1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
                      import random
     from evennia import DefaultRoom, TICKER_HANDLER
     
     ECHOES = ["The sky is clear.", 
@@ -132,7 +142,7 @@ We will create a new WeatherRoom typeclass that is aware of the day-night cycle.
             "ticked at regular intervals"
             echo = random.choice(ECHOES)
             self.msg_contents(echo)
-
                  
+
                  
 
                  
 
                  In the at_object_creation method, we simply added ourselves to the TickerHandler and tell it to
 call at_weather_update every hour (60*60 seconds). During testing you might want to play with a
@@ -160,14 +170,14 @@ weather came before it. Expanding it to be more realistic is a useful exercise.<
           modules |
         
                • 
-          next |
                  • 
         
                • 
-          previous |
                  • 
         
                • Evennia 1.0-dev »
                  • 
           
                • Tutorials and Howto’s »
                  • 
-        
                • Weather Tutorial
                  •  
+        
                • Adding Weather messages to a Room
                  •
                develop branch
                diff --git a/docs/1.0-dev/Howtos/Tutorial-for-basic-MUSH-like-game.html b/docs/1.0-dev/Howtos/Tutorial-for-basic-MUSH-like-game.html index 8bff0e8fe6..83254b491c 100644 --- a/docs/1.0-dev/Howtos/Tutorial-for-basic-MUSH-like-game.html +++ b/docs/1.0-dev/Howtos/Tutorial-for-basic-MUSH-like-game.html @@ -130,7 +130,7 @@ focused on free form storytelling. Even if you are not interested in MUSH:es, this is still a good first game-type to try since it’s not so code heavy. You will be able to use the same principles for building other types of games.

                -

                The tutorial starts from scratch. If you did the First Steps Coding tutorial +

                The tutorial starts from scratch. If you did the First Steps Coding tutorial already you should have some ideas about how to do some of the steps already.

                The following are the (very simplistic and cut-down) features we will implement (this was taken from a feature request from a MUSH user new to Evennia). A Character in this system should:

                diff --git a/docs/1.0-dev/Howtos/Web-Add-a-wiki.html b/docs/1.0-dev/Howtos/Web-Add-a-wiki.html index e0a62e45a6..29eb4fa768 100644 --- a/docs/1.0-dev/Howtos/Web-Add-a-wiki.html +++ b/docs/1.0-dev/Howtos/Web-Add-a-wiki.html @@ -18,7 +18,7 @@ - +

              Previous topic

              -

              Tutorial Tweeting Game Stats

              +

              Changing the Game Website

              Next topic

              Web Character Generation

              @@ -119,7 +119,7 @@

              Add a wiki on your website

              Before doing this tutorial you will probably want to read the intro in -Basic Web tutorial. Reading the three first parts of the +Basic Web tutorial. Reading the three first parts of the Django tutorial might help as well.

              This tutorial will provide a step-by-step process to installing a wiki on your website. Fortunately, you don’t have to create the features manually, since it has been done by others, and @@ -331,7 +331,7 @@ solution for connecting the Evennia permission levels to wiki access, this is th next |

            • - previous |
            • Evennia 1.0-dev »
            • Tutorials and Howto’s »
              • diff --git a/docs/1.0-dev/Howtos/Beginner-Tutorial/Part5/Web-Tutorial.html b/docs/1.0-dev/Howtos/Web-Changing-Webpage.html similarity index 52% rename from docs/1.0-dev/Howtos/Beginner-Tutorial/Part5/Web-Tutorial.html rename to docs/1.0-dev/Howtos/Web-Changing-Webpage.html index f50c6f6f95..d9329dc2cf 100644 --- a/docs/1.0-dev/Howtos/Beginner-Tutorial/Part5/Web-Tutorial.html +++ b/docs/1.0-dev/Howtos/Web-Changing-Webpage.html @@ -6,40 +6,38 @@ - 2. Web Tutorial — Evennia 1.0-dev documentation - - - - - - - - - - - - + Changing the Game Website — Evennia 1.0-dev documentation + + + + + + + + + + + + @@ -49,40 +47,40 @@
            -

            Rather than using an explicit command you can set up a Script to send automatic tweets, for example to post updated game stats. See the Tweeting Game Stats tutorial for help.

            +

            Rather than using an explicit command you can set up a Script to send automatic tweets, for example to post updated game stats. See the Tweeting Game Stats tutorial for help.

            diff --git a/docs/1.0-dev/Setup/Config-Apache-Proxy.html b/docs/1.0-dev/Setup/Config-Apache-Proxy.html index d3a7c2b5a2..1f0414e641 100644 --- a/docs/1.0-dev/Setup/Config-Apache-Proxy.html +++ b/docs/1.0-dev/Setup/Config-Apache-Proxy.html @@ -16,7 +16,9 @@ - + + +
          • modules |
            • +
          • + next |
            • +
          • + previous |
          • Evennia 1.0-dev »
            • +
          • Server Setup and Life »
          • Configuring an Apache Proxy
          develop branch
          @@ -75,6 +84,12 @@
        +

        Previous topic

        +

        Configuring HAProxy

        +

        Next topic

        +

        Tutorials and Howto’s

        develop branch
        diff --git a/docs/1.0-dev/Setup/Config-HAProxy.html b/docs/1.0-dev/Setup/Config-HAProxy.html index ad94ed1aa4..9f07165a1f 100644 --- a/docs/1.0-dev/Setup/Config-HAProxy.html +++ b/docs/1.0-dev/Setup/Config-HAProxy.html @@ -17,7 +17,7 @@ - +
      • - next |
      • Security Hints and Practices

        Next topic

        -

        Tutorials and Howto’s

        +

        Configuring an Apache Proxy

          @@ -350,7 +350,7 @@ uncommented in the config file, it will now start as a background process.

          modules |
        • - next |

        • Installing with Docker

          -

          Evennia releases docker images which makes -running an Evennia-based game in a Docker container easy.

          -

          First, install the docker program so you can run the Evennia container. You can get it freely from -docker.com. Linux users can likely also get it through their normal -package manager.

          +

          Evennia releases docker images as part of regular commits and releases. This makes running an Evennia-based game in a Docker container easy.

          +

          First, install the docker program so you can run the Evennia container. You can get it freely from docker.com. Linux users can likely also get it through their normal package manager.

          To fetch the latest evennia docker image, run:

          docker pull evennia/evennia
          @@ -142,11 +139,7 @@ the docker container:

          evennia|docker /usr/src/game $
          -

          This is a normal shell prompt. We are in the /usr/src/game location inside the docker container. -If you had anything in the folder you started from, you should see it here (with ls) since we -mounted the current directory to usr/src/game (with -v above). You have the evennia command -available and can now proceed to create a new game as per the normal game setup -instructions (no virtualenv needed).

          +

          This is a normal shell prompt. We are in the /usr/src/game location inside the docker container. If you had anything in the folder you started from, you should see it here (with ls) since we mounted the current directory to usr/src/game (with -v above). You have the evennia command available and can now proceed to create a new game as per the normal game setup instructions (no virtualenv needed).

          You can run Evennia from inside this container if you want to, it’s like you are root in a little isolated Linux environment. To exit the container and all processes in there, press Ctrl-D. If you created a new game folder, you will find that it has appeared on-disk.

          @@ -165,8 +158,7 @@ on your drive.

        Running your game as a docker image

        -

        If you run the docker command given in the previous section from your game dir you can then -easily start Evennia and have a running server without any further fuss.

        +

        If you run the docker command given in the previous section from your game dir you can then easily start Evennia and have a running server without any further fuss.

        But apart from ease of install, the primary benefit to running an Evennia-based game in a container is to simplify its deployment into a public production environment. Most cloud-based hosting providers these days support the ability to run container-based applications. This makes deploying or updating your game as simple as building a new container image locally, pushing it to your Docker Hub account, and then pulling from Docker Hub into your AWS/Azure/other docker-enabled hosting account. The container eliminates the need to install Python, set up a virtualenv, or run pip to install dependencies.

        @@ -197,14 +189,11 @@ enter it and run commands).

            docker build -t mydhaccount/mygame .
        -

        (don’t forget the period at the end, it will use the Dockerfile from the current location). Here -mydhaccount is the name of your dockerhub account. If you don’t have a dockerhub account you can build the image locally only (name the container whatever you like in that case, like just mygame).

        -

        Docker images are stored centrally on your computer. You can see which ones you have available -locally with docker images. Once built, you have a couple of options to run your game.

        +

        (don’t forget the period at the end, it will use the Dockerfile from the current location). Here mydhaccount is the name of your dockerhub account. If you don’t have a dockerhub account you can build the image locally only (name the container whatever you like in that case, like just mygame).

        +

        Docker images are stored centrally on your computer. You can see which ones you have available locally with docker images. Once built, you have a couple of options to run your game.

        Run container from your game image for development

        -

        To run the container based on your game image locally for development, mount the local game -directory as before:

        +

        To run the container based on your game image locally for development, mount the local game directory as before:

        docker run -it --rm -p 4000:4000 -p 4001:4001 -p 4002:4002 -v $PWD:/usr/src/game --user $UID:$GID
 mydhaccount/mygame
        @@ -256,10 +245,8 @@ container will get a new container id to reference.

        How it Works

        -

        The evennia/evennia docker image holds the evennia library and all of its dependencies. It also has an ONBUILD directive which is triggered during builds of images derived from it. This -ONBUILD directive handles setting up a volume and copying your game directory code into the proper location within the container.

        -

        In most cases, the Dockerfile for an Evennia-based game will only need the FROM evennia/evennia:latest directive, and optionally a MAINTAINER directive if you plan to publish -your image on Docker Hub and would like to provide contact info.

        +

        The evennia/evennia docker image holds the evennia library and all of its dependencies. It also has an ONBUILD directive which is triggered during builds of images derived from it. This ONBUILD directive handles setting up a volume and copying your game directory code into the proper location within the container.

        +

        In most cases, the Dockerfile for an Evennia-based game will only need the FROM evennia/evennia:latest directive, and optionally a MAINTAINER directive if you plan to publish your image on Docker Hub and would like to provide contact info.

        For more information on Dockerfile directives, see the Dockerfile Reference.

        For more information on volumes and Docker containers, see the Docker site’s Manage data in containers page.

        @@ -317,8 +304,7 @@ working directory to be your game directory and run

        - .:/usr/src/game
        -

        With this file in the game directory next to the Dockerfile, starting the container is as simple -as

        +

        With this file in the game directory next to the Dockerfile, starting the container is as simple as

        docker-compose up
        diff --git a/docs/1.0-dev/Setup/Installation-Git.html b/docs/1.0-dev/Setup/Installation-Git.html index 761f28fe8c..ea56c0e62c 100644 --- a/docs/1.0-dev/Setup/Installation-Git.html +++ b/docs/1.0-dev/Setup/Installation-Git.html @@ -147,39 +147,44 @@ not recognize local

        Virtualenv

        A Python virtual environment allows you to install Evennia in its own little folder, separate from the rest of the system. You also won’t need any extra permissions. It’s optional to use a virtualenv, but it’s highly recommended. Python supports this natively:

        -
         python3.11 -m venv evenv   (linux/mac)
- python -m venv venv evenv  (Windows)
+
+
        python3.11 -m venv evenv   (linux/mac)
+python -m venv evenv       (Windows)
 
        
 
        
-
        
-
        If you have older versions of Python installed on Windows, you should instead use py instead of python - the py launcher automatically selects the latest python version among those you installed.
        
-
        
 
        This will create a new folder evenv in your current directory.
 Activate it like this:
        
-
        source evenv/bin/activate (Linux, Mac)
-evenv\Scripts\activate (Windows)
-.\evenv\scripts\activate (Windows with PS Shell, Git Bash etc)
        
+
        source evenv/bin/activate (Linux, Mac)
+evenv\Scripts\activate    (Windows Console)
+.\evenv\scripts\activate  (Windows PS Shell, 
+                           Git Bash etc)
+
        
+
        
 
        The text (evenv) should appear next to your prompt to show that the virtual
 environment is active. You don’t need to actually be in or near the evenv folder for
 the environment to be active.
        
-
        
-
        Remember that you need to re-activate the virtualenv like this every time you
-start a new terminal/console. Otherwise the evennia command will not be available.
        
-
        
+
        
+
        Important
        
+
        Remember that you need to (re-)activate the virtualenv like this every time you
+start a new terminal/console (or restart your computer). Until you do, the evennia command will not be available.
        
+

        Linux Install

        For Debian-derived systems (like Ubuntu, Mint etc), start a terminal and install the requirements:

        -
        sudo apt-get update
-sudo apt-get install python3.11 python3.11-venv python3.11-dev gcc
+
        sudo apt-get update
+sudo apt-get install python3.11 python3.11-venv python3.11-dev gcc
 
        
 
        
 
        You should make sure to not be root after this step, running as root is a
 security risk. Now create a folder where you want to do all your Evennia
 development:
        
-
        mkdir muddev
-cd muddev
+
        mkdir muddev
+cd muddev
 
        
 
        
 
        Next we fetch Evennia itself:
        
@@ -191,6 +196,9 @@ contains the source code though, it is not installed yet.
        
 
        At this point it’s now optional but recommended that you initialize and activate a virtualenv.
        
 
        Next, install Evennia (system-wide, or into your active virtualenv). Make sure you are standing
 at the top of your mud directory tree (so you see the evennia/ folder, and likely the evenv virtualenv folder) and do
        
+
 
        pip install -e evennia
 
        
 
        
diff --git a/docs/1.0-dev/Setup/Installation-Troubleshooting.html b/docs/1.0-dev/Setup/Installation-Troubleshooting.html
index 0a1b1ee7e7..eae36232ba 100644
--- a/docs/1.0-dev/Setup/Installation-Troubleshooting.html
+++ b/docs/1.0-dev/Setup/Installation-Troubleshooting.html
@@ -112,20 +112,18 @@
             
   
        
 
        Installation Troubleshooting
        
-
        If you have an issue not covered here, please report it
-so it can be fixed or a workaround found!
        
+
        If you have an issue not covered here, please report it so it can be fixed or a workaround found!
        
 
        The server logs are in mygame/server/logs/. To easily view server logs in the terminal,
-you can run evennia -l, or (in the future) start the server with evennia start -l.
        
+you can run evennia -l, or start/reload the server with evennia start -l or evennia reload -l.
        
 
        
 
        Check your Requirements
        
-
        Any system that supports Python3.9+ should work. We’ll describe how to install
-everything in the following sections.
        
+
        Any system that supports Python3.9+ should work.
        
 
          
 
        • Linux/Unix
          • 
 
        • Windows (Win7, Win8, Win10, Win11)
          • 
 
        • Mac OSX (>10.5 recommended)
          • 
-
        • Python (v3.9, 3.10  and 3.11 are tested)
          • 
-
        • Twisted (v22.0+)
          
+
        • Python (v3.9, 3.10  and 3.11 are tested. 3.11 is recommended)
          • 
+
        • Twisted (v22.3+)
          
 
            
 
          • ZopeInterface (v3.0+)  - usually included in Twisted packages
            • 
 
          • Linux/Mac users may need the gcc and python-dev packages or equivalent.
            • 
diff --git a/docs/1.0-dev/Setup/Installation-Upgrade.html b/docs/1.0-dev/Setup/Installation-Upgrade.html
index 9bfe52a815..9e66d59f70 100644
--- a/docs/1.0-dev/Setup/Installation-Upgrade.html
+++ b/docs/1.0-dev/Setup/Installation-Upgrade.html
@@ -116,17 +116,16 @@ over things manually.
            
 
            Evennia v0.9.5 to 1.0
            
 
            
 
            Upgrading the Evennia library
            
-
            Prior to 1.0, all Evennia installs were Git-installs. These instructions
-assume that you have a cloned evennia repo and use a virtualenv (best practices).
            
+
            Prior to 1.0, all Evennia installs were Git-installs. These instructions assume that you have a cloned evennia repo and use a virtualenv (best practices).
            
 
              
-
            • Make sure to stop Evennia 0.9.5 entirely with evennia stop.
              • 
+
            • Make sure to stop Evennia 0.9.5 entirely with evennia stop from your game dir.
              • 
 
            • deactivate to leave your active virtualenv.
              • 
-
            • Make a backup of your entire mygame folder, just to be sure!
              • 
 
            • Install Python 3.11 (recommended). Follow the Git-installation for your OS if needed.
              • 
 
            • Delete the old virtualenv evenv folder, or rename it (in case you want to keep using 0.9.5 for a while).
              • 
 
            • Make new evenv virtualenv (see the virtualenv instructions for help)
              • 
 
            • cd into your evennia/ root folder (you want to see the docs/ and  bin/ directories as well as a nested evennia/ folder)
              • 
 
            • git pull
              • 
+
            • git checkout develop   TODO - only until 1.0 release.
              • 
 
            • pip install -e .
              • 
 
            • If you want the optional extra libs (needed by some contribs), do pip install -e .[extra]
              • 
 
            • Test that you can run the evennia command.
              • 
@@ -134,12 +133,10 @@ assume that you have a cloned 
 
              
 
              Upgrading your game dir
              
-
              If you don’t have anything you want to keep in your existing game dir, you can just start a new onew
-using the normal install instructions. If you want to keep/convert your existing
-game dir, continue below.
              
+
              If you don’t have anything you want to keep in your existing game dir, you can just start a new one using the normal install instructions. If you want to keep/convert your existing game dir, continue below.
              
 
                
-
              • First, make a backup of your exising game dir! If you use version control, make sure to commit your current state.
                • 
-
              • cd to your existing 0.9.5-based game folder (like mygame.)
                • 
+
              • First, make a backup of your exising game dir! If you use version control, make sure to commit your current state.
                • 
+
              • cd to your existing 0.9.5-based game folder (like mygame).
                • 
 
              • If you have changed mygame/web, rename the folder to web_0.9.5. If you didn’t change anything (or don’t have anything you want to keep), you can delete it entirely.
                • 
 
              • Copy evennia/evennia/game_template/web to mygame/ (e.g. using cp -Rf or a file manager). This new web folder replaces the old one and has a very different structure.
                • 
 
              • It’s possible you need to replace/comment out import and calls to the deprecated
diff --git a/docs/1.0-dev/Setup/Installation.html b/docs/1.0-dev/Setup/Installation.html
index 9bc283b0f0..3819977ef0 100644
--- a/docs/1.0-dev/Setup/Installation.html
+++ b/docs/1.0-dev/Setup/Installation.html
@@ -239,7 +239,7 @@ registering your server with the Evennia game index.
                
 
                
 
                The Next steps
                
 
                You are good to go!
                
-
                Next, why not head into the Starting Tutorial  to learn how to start making your new game!
                
+
                Next, why not head into the Starting Tutorial  to learn how to start making your new game!
                
 
                
 
              
 
diff --git a/docs/1.0-dev/Setup/Online-Setup.html b/docs/1.0-dev/Setup/Online-Setup.html
index 83be64a6a4..ef11599631 100644
--- a/docs/1.0-dev/Setup/Online-Setup.html
+++ b/docs/1.0-dev/Setup/Online-Setup.html
@@ -148,8 +148,7 @@ remote hosting later in this document.
              
 
              Evennia will by default accept incoming connections on all interfaces (0.0.0.0) so in principle anyone knowing the ports to use and has the IP address to your machine should be able to connect to your game.
              
 
 
                
 
              • Make sure Evennia is installed and that you have activated the virtualenv. Start the server with evennia start --log. The --log (or -l) will make sure that the logs are echoed to the terminal.
                • 
diff --git a/docs/1.0-dev/Setup/Setup-Overview.html b/docs/1.0-dev/Setup/Setup-Overview.html
index db34e588cd..97dad62668 100644
--- a/docs/1.0-dev/Setup/Setup-Overview.html
+++ b/docs/1.0-dev/Setup/Setup-Overview.html
@@ -258,6 +258,11 @@
 
              • Putting it all together
                • 
 
              
 
+
            • Configuring an Apache Proxy
+
              •
        diff --git a/docs/1.0-dev/Unimplemented.html b/docs/1.0-dev/Unimplemented.html index 3a6dcab916..cb21fb3ba1 100644 --- a/docs/1.0-dev/Unimplemented.html +++ b/docs/1.0-dev/Unimplemented.html @@ -17,8 +17,8 @@ - - + +
      • - next |
      • - previous |
      • Evennia 1.0-dev »
      • Tutorials and Howto’s »
        • -
      • Beginner Tutorial »
        • -
      • Part 4: Using what we created »
        • +
      • Beginner Tutorial »
        • +
      • Part 4: Using what we created »
      • 1. Unimplemented
      develop branch
      @@ -63,10 +63,10 @@

      Previous topic

      -

      Part 4: Using what we created

      Next topic

      -

      Part 5: Showing the world

      @@ -120,15 +120,15 @@ modules |
    • - next |
    • - previous |
    • Evennia 1.0-dev »
    • Tutorials and Howto’s »
      • -
    • Beginner Tutorial »
      • -
    • Part 4: Using what we created »
      • +
    • Beginner Tutorial »
      • +
    • Part 4: Using what we created »
    • 1. Unimplemented
    develop branch
    diff --git a/docs/1.0-dev/_modules/evennia/prototypes/prototypes.html b/docs/1.0-dev/_modules/evennia/prototypes/prototypes.html index 3f16bd69a4..45b9007d8b 100644 --- a/docs/1.0-dev/_modules/evennia/prototypes/prototypes.html +++ b/docs/1.0-dev/_modules/evennia/prototypes/prototypes.html @@ -90,7 +90,6 @@ from django.core.paginator import Paginator from django.db.models import Q from django.utils.translation import gettext as _ - from evennia.locks.lockhandler import check_lockstring, validate_lockstring from evennia.objects.models import ObjectDB from evennia.scripts.scripts import DefaultScript @@ -604,8 +603,6 @@ require_single=False, return_iterators=False, no_db=False, - page_size=None, - page_no=None, ): """ Find prototypes based on key and/or tags, or all prototypes. diff --git a/docs/1.0-dev/_modules/evennia/utils/evmenu.html b/docs/1.0-dev/_modules/evennia/utils/evmenu.html index aab214af88..63affb5eeb 100644 --- a/docs/1.0-dev/_modules/evennia/utils/evmenu.html +++ b/docs/1.0-dev/_modules/evennia/utils/evmenu.html @@ -351,22 +351,12 @@ # i18n from django.utils.translation import gettext as _ - from evennia import CmdSet, Command from evennia.commands import cmdhandler from evennia.utils import logger from evennia.utils.ansi import strip_ansi from evennia.utils.evtable import EvColumn, EvTable -from evennia.utils.utils import ( - crop, - dedent, - is_iter, - m_len, - make_iter, - mod_import, - pad, - to_str, -) +from evennia.utils.utils import crop, dedent, is_iter, m_len, make_iter, mod_import, pad, to_str # read from protocol NAWS later? _MAX_TEXT_WIDTH = settings.CLIENT_DEFAULT_WIDTH diff --git a/docs/1.0-dev/_sources/Coding/Coding-Introduction.md.txt b/docs/1.0-dev/_sources/Coding/Coding-Introduction.md.txt index b92703b5de..fe3652075f 100644 --- a/docs/1.0-dev/_sources/Coding/Coding-Introduction.md.txt +++ b/docs/1.0-dev/_sources/Coding/Coding-Introduction.md.txt @@ -7,7 +7,7 @@ Here are some pointers to get you going. ## Start with the tutorial -It's highly recommended that you jump in on the [Starting Tutorial](../Howtos/Beginner-Tutorial/Part1/Beginner-Tutorial-Part1-Intro.md). Even if +It's highly recommended that you jump in on the [Starting Tutorial](../Howtos/Beginner-Tutorial/Part1/Beginner-Tutorial-Part1-Overview.md). Even if you only the beginning or some part of it, it covers much of the things needed to get started, including giving you are first introduction to Python. ## Explore Evennia interactively diff --git a/docs/1.0-dev/_sources/Coding/Coding-Overview.md.txt b/docs/1.0-dev/_sources/Coding/Coding-Overview.md.txt index 61b225fc7a..568cb36b9e 100644 --- a/docs/1.0-dev/_sources/Coding/Coding-Overview.md.txt +++ b/docs/1.0-dev/_sources/Coding/Coding-Overview.md.txt @@ -6,7 +6,7 @@ make your game, also if you never coded before. If you are an experienced coder, ## Setting up a workflow -See also the [Beginner Tutorial](../Howtos/Beginner-Tutorial/Beginner-Tutorial-Intro.md). +See also the [Beginner Tutorial](../Howtos/Beginner-Tutorial/Beginner-Tutorial-Overview.md). ```{toctree} :maxdepth: 2 diff --git a/docs/1.0-dev/_sources/Components/TickerHandler.md.txt b/docs/1.0-dev/_sources/Components/TickerHandler.md.txt index a5f5ee2039..6362f03243 100644 --- a/docs/1.0-dev/_sources/Components/TickerHandler.md.txt +++ b/docs/1.0-dev/_sources/Components/TickerHandler.md.txt @@ -104,7 +104,7 @@ may store. When testing, you can stop all tickers in the entire game with `tickerhandler.clear()`. You can also view the currently subscribed objects with `tickerhandler.all()`. -See the [Weather Tutorial](../Howtos/Weather-Tutorial.md) for an example of using the TickerHandler. +See the [Weather Tutorial](../Howtos/Tutorial-Weather-Effects.md) for an example of using the TickerHandler. ### When *not* to use TickerHandler diff --git a/docs/1.0-dev/_sources/Concepts/Web-Features.md.txt b/docs/1.0-dev/_sources/Concepts/Web-Features.md.txt index afbea527c3..7263371e7e 100644 --- a/docs/1.0-dev/_sources/Concepts/Web-Features.md.txt +++ b/docs/1.0-dev/_sources/Concepts/Web-Features.md.txt @@ -42,7 +42,7 @@ Example: To override or modify `evennia/web/website/template/website/index.html` add/modify `mygame/web/template_overrides/website/index.html`. The detailed description on how to customize the website is best described in tutorial form. See the -[Web Tutorial](../Howtos/Beginner-Tutorial/Part5/Web-Tutorial.md) for more information. +[Web Tutorial](../Howtos/Web-Changing-Webpage.md) for more information. ### Overloading Django views diff --git a/docs/1.0-dev/_sources/Howtos/Static-In-Game-Map.md.txt b/docs/1.0-dev/_sources/Contribs/Contrib-Mapbuilder-Tutorial.md.txt similarity index 95% rename from docs/1.0-dev/_sources/Howtos/Static-In-Game-Map.md.txt rename to docs/1.0-dev/_sources/Contribs/Contrib-Mapbuilder-Tutorial.md.txt index 094c142836..23b1a30849 100644 --- a/docs/1.0-dev/_sources/Howtos/Static-In-Game-Map.md.txt +++ b/docs/1.0-dev/_sources/Contribs/Contrib-Mapbuilder-Tutorial.md.txt @@ -1,12 +1,6 @@ -# Static In Game Map +# Creating rooms from an ascii map - -## Introduction - -This tutorial describes the creation of an in-game map display based on a pre-drawn map. It also -details how to use the [Batch code processor](../Components/Batch-Code-Processor.md) for advanced building. There is -also the [Dynamic in-game map tutorial](./Dynamic-In-Game-Map.md) that works in the opposite direction, -by generating a map from an existing grid of rooms. +This tutorial describes the creation of an in-game map display based on a pre-drawn map. It goes with the [Mapbuilder contrib](./Contrib-Mapbuilder.md). It also details how to use the [Batch code processor](../Components/Batch-Code-Processor.md) for advanced building. Evennia does not require its rooms to be positioned in a "logical" way. Your exits could be named anything. You could make an exit "west" that leads to a room described to be in the far north. You @@ -41,7 +35,7 @@ map we designed before. ``` We will henceforth assume your game folder is name named `mygame` and that you haven't modified the -default commands. We will also not be using [Colors](../Concepts/Colors.md) for our map since they +dkefault commands. We will also not be using [Colors](../Concepts/Colors.md) for our map since they don't show in the documentation wiki. ## Planning the Map @@ -84,7 +78,7 @@ In this section we will try to create an actual "map" object that an account can at. Evennia offers a range of [default commands](../Components/Default-Commands.md) for -[creating objects and rooms in-game](Beginner-Tutorial/Part1/Beginner-Tutorial-Building-Quickstart.md). While readily accessible, these commands are made to do very +[creating objects and rooms in-game](../Howtos/Beginner-Tutorial/Part1/Beginner-Tutorial-Building-Quickstart.md). While readily accessible, these commands are made to do very specific, restricted things and will thus not offer as much flexibility to experiment (for an advanced exception see [the FuncParser](../Components/FuncParser.md)). Additionally, entering long descriptions and properties over and over in the game client can become tedious; especially when @@ -412,5 +406,5 @@ easily new game defining features can be added to Evennia. You can easily build from this tutorial by expanding the map and creating more rooms to explore. Why not add more features to your game by trying other tutorials: [Add weather to your world](Weather- -Tutorial), [fill your world with NPC's](./Tutorial-NPC-Reacting.md) or -[implement a combat system](./Turn-based-Combat-System.md). +Tutorial), [fill your world with NPC's](../Howtos/Tutorial-NPC-Reacting.md) or +[implement a combat system](../Howtos/Turn-based-Combat-System.md). diff --git a/docs/1.0-dev/_sources/Contribs/Contrib-Mapbuilder.md.txt b/docs/1.0-dev/_sources/Contribs/Contrib-Mapbuilder.md.txt index a56ce7ff4a..ae18378f24 100644 --- a/docs/1.0-dev/_sources/Contribs/Contrib-Mapbuilder.md.txt +++ b/docs/1.0-dev/_sources/Contribs/Contrib-Mapbuilder.md.txt @@ -52,6 +52,8 @@ references to rooms previously created is passed to the build commands. You then call the command in-game using the path to the MAP and MAP_LEGEND vars The path you provide is relative to the evennia or mygame folder. +See also the [separate tutorial in the docs](./Contrib-Mapbuilder-Tutorial.md). + ## Installation Use by importing and including the command in your default_cmdsets module. @@ -277,6 +279,11 @@ EXAMPLE2_LEGEND = { ``` +```{toctree} +:hidden: +Contrib-Mapbuilder-Tutorial +``` + ---- diff --git a/docs/1.0-dev/_sources/Contribs/Contribs-Overview.md.txt b/docs/1.0-dev/_sources/Contribs/Contribs-Overview.md.txt index 4ee5d0203d..5a5fe67a53 100644 --- a/docs/1.0-dev/_sources/Contribs/Contribs-Overview.md.txt +++ b/docs/1.0-dev/_sources/Contribs/Contribs-Overview.md.txt @@ -1,9 +1,14 @@ # Contribs +```{sidebar} More contributions +Additional Evennia code snippets and contributions can be found +in the [Community Contribs & Snippets][forum] forum. +``` _Contribs_ are optional code snippets and systems contributed by the Evennia community. They vary in size and complexity and may be more specific about game types and styles than 'core' Evennia. -This page is auto-generated and summarizes all contribs currently included. +This page is auto-generated and summarizes all **46** contribs currently included +with the Evennia distribution. All contrib categories are imported from `evennia.contrib`, such as @@ -13,16 +18,34 @@ Each contrib contains installation instructions for how to integrate it with your other code. If you want to tweak the code of a contrib, just copy its entire folder to your game directory and modify/use it from there. -> Hint: Additional (potentially un-maintained) code snippets from the community can be found -in our discussion forum's [Community Contribs & Snippets](https://github.com/evennia/evennia/discussions/categories/community-contribs-snippets) category. - If you want to contribute yourself, see [here](../Contributing.md)! +[forum]: https://github.com/evennia/evennia/discussions/categories/community-contribs-snippets + +## Index +| | | | | | | | +|---|---|---|---|---|---|---| +| [base_systems](#base_systems) | [full_systems](#full_systems) | [game_systems](#game_systems) | [grid](#grid) | [rpg](#rpg) | [tutorials](#tutorials) | [utils](#utils) | + +| | | | | | +|---|---|---|---|---| +| [auditing](#auditing) | [awsstorage](#awsstorage) | [barter](#barter) | [batchprocessor](#batchprocessor) | [bodyfunctions](#bodyfunctions) | +| [buffs](#buffs) | [building_menu](#building_menu) | [character_creator](#character_creator) | [clothing](#clothing) | [color_markups](#color_markups) | +| [components](#components) | [cooldowns](#cooldowns) | [crafting](#crafting) | [custom_gametime](#custom_gametime) | [dice](#dice) | +| [email_login](#email_login) | [evadventure](#evadventure) | [evscaperoom](#evscaperoom) | [extended_room](#extended_room) | [fieldfill](#fieldfill) | +| [gendersub](#gendersub) | [git_integration](#git_integration) | [health_bar](#health_bar) | [ingame_map_display](#ingame_map_display) | [ingame_python](#ingame_python) | +| [mail](#mail) | [mapbuilder](#mapbuilder) | [menu_login](#menu_login) | [mirror](#mirror) | [multidescer](#multidescer) | +| [mux_comms_cmds](#mux_comms_cmds) | [name_generator](#name_generator) | [puzzles](#puzzles) | [random_string_generator](#random_string_generator) | [red_button](#red_button) | +| [rpsystem](#rpsystem) | [simpledoor](#simpledoor) | [slow_exit](#slow_exit) | [talking_npc](#talking_npc) | [traits](#traits) | +| [tree_select](#tree_select) | [turnbattle](#turnbattle) | [tutorial_world](#tutorial_world) | [unixcommand](#unixcommand) | [wilderness](#wilderness) | +| [xyzgrid](#xyzgrid) | + + ## base_systems -_This category contains systems that are not necessarily tied to a specific -in-game mechanic but is useful for the game as a whole. Examples include +_Systems that are not necessarily tied to a specific +in-game mechanic but which are useful for the game as a whole. Examples include login systems, new command syntaxes, and build helpers._ ```{toctree} @@ -41,7 +64,7 @@ Contrib-Unixcommand.md ``` -### Contrib: `awsstorage` +### `awsstorage` _Contrib by The Right Honourable Reverend (trhr), 2020_ @@ -53,7 +76,7 @@ cloud hosting. Great for those serving media with the game. -### Contrib: `building_menu` +### `building_menu` _Contrib by vincent-lg, 2018_ @@ -68,7 +91,7 @@ that will edit any default object, offering to change its key and description. -### Contrib: `color_markups` +### `color_markups` _Contrib by Griatch, 2017_ @@ -80,7 +103,7 @@ Additional color markup styles for Evennia (extending or replacing the default -### Contrib: `components` +### `components` __Contrib by ChrisLR 2021__ @@ -90,7 +113,7 @@ __Contrib by ChrisLR 2021__ -### Contrib: `custom_gametime` +### `custom_gametime` _Contrib by vlgeoff, 2017 - based on Griatch's core original_ @@ -103,7 +126,7 @@ in-game times, but now taking this custom calendar into account. -### Contrib: `email_login` +### `email_login` _Contrib by Griatch, 2012_ @@ -115,7 +138,7 @@ it just uses it as the identifier rather than a username. -### Contrib: `ingame_python` +### `ingame_python` _Contrib by Vincent Le Goff 2017_ @@ -132,7 +155,7 @@ this module carefully before continuing. -### Contrib: `menu_login` +### `menu_login` _Contribution by Vincent-lg 2016. Reworked for modern EvMenu by Griatch, 2019._ @@ -144,7 +167,7 @@ menu system `EvMenu` under the hood. -### Contrib: `mux_comms_cmds` +### `mux_comms_cmds` _Contribution by Griatch 2021_ @@ -158,7 +181,7 @@ main `channel` command is still called under the hood. -### Contrib: `unixcommand` +### `unixcommand` _Contribution by Vincent Le Geoff (vlgeoff), 2017_ @@ -178,8 +201,8 @@ library under the hood. ## full_systems -_This category contains 'complete' game engines that can be used directly -to start creating content without no further additions (unless you want to)._ +_'Complete' game engines that can be used directly to start creating content +without no further additions (unless you want to)._ ```{toctree} :maxdepth: 1 @@ -188,7 +211,7 @@ Contrib-Evscaperoom.md ``` -### Contrib: `evscaperoom` +### `evscaperoom` _Contribution by Griatch, 2019_ @@ -207,10 +230,10 @@ content but contains the utilities and base classes and an empty example room. ## game_systems -_This category holds code implementing in-game gameplay systems like -crafting, mail, combat and more. Each system is meant to be adopted -piecemeal and adopted for your game. This does not include -roleplaying-specific systems, those are found in the `rpg` folder._ +_In-game gameplay systems like crafting, mail, combat and more. +Each system is meant to be adopted piecemeal and adopted for your game. +This does not include roleplaying-specific systems, those are found in +the `rpg` category._ ```{toctree} :maxdepth: 1 @@ -227,7 +250,7 @@ Contrib-Turnbattle.md ``` -### Contrib: `barter` +### `barter` _Contribution by Griatch, 2012_ @@ -243,7 +266,7 @@ transactions. -### Contrib: `clothing` +### `clothing` _Contribution by Tim Ashley Jenkins, 2017_ @@ -254,7 +277,7 @@ look of these clothes are appended to the character's description when worn. -### Contrib: `cooldowns` +### `cooldowns` _Contribution by owllex, 2021_ @@ -268,7 +291,7 @@ asynchronous timer that you can query to see if a certain time has yet passed. -### Contrib: `crafting` +### `crafting` _Contribution by Griatch 2020_ @@ -281,7 +304,7 @@ combine 'flour', 'water' and 'yeast' with an 'oven' to bake a 'loaf of bread'. -### Contrib: `gendersub` +### `gendersub` _Contribution by Griatch 2015_ @@ -294,7 +317,7 @@ inspiration and starting point to how to do stuff like this. -### Contrib: `mail` +### `mail` _Contribution by grungies1138 2016_ @@ -307,7 +330,7 @@ on their own. -### Contrib: `multidescer` +### `multidescer` _Contribution by Griatch 2016_ @@ -321,7 +344,7 @@ work well together with the `rpsystem` contrib. -### Contrib: `puzzles` +### `puzzles` _Contribution by Henddher 2018_ @@ -335,7 +358,7 @@ the puzzle entirely from in-game. -### Contrib: `turnbattle` +### `turnbattle` _Contribution by Tim Ashley Jenkins, 2017_ @@ -356,8 +379,8 @@ the participants until the fight ends. ## grid -_Systems related to the game world's topology and structure. This has -contribs related to rooms, exits and map building._ +_Systems related to the game world's topology and structure. Contribs related +to rooms, exits and map building._ ```{toctree} :maxdepth: 1 @@ -372,7 +395,7 @@ Contrib-XYZGrid.md ``` -### Contrib: `extended_room` +### `extended_room` _Contribution - Griatch 2012, vincent-lg 2019_ @@ -385,7 +408,7 @@ supported by new `look` and `desc` commands. -### Contrib: `ingame_map_display` +### `ingame_map_display` _Contribution - helpme 2022_ @@ -398,7 +421,7 @@ directions are ignored. -### Contrib: `mapbuilder` +### `mapbuilder` _Contribution by Cloud_Keeper 2016_ @@ -408,7 +431,7 @@ Build a game map from the drawing of a 2D ASCII map. -### Contrib: `simpledoor` +### `simpledoor` _Contribution by Griatch, 2016_ @@ -420,7 +443,7 @@ destroyable etc. -### Contrib: `slow_exit` +### `slow_exit` _Contribution by Griatch 2014_ @@ -433,7 +456,7 @@ and abort an ongoing traversal, respectively. -### Contrib: `wilderness` +### `wilderness` _Contribution by titeuf87, 2017_ @@ -446,7 +469,7 @@ long as the rooms are relatively similar (name/desc changing). -### Contrib: `xyzgrid` +### `xyzgrid` _Contribution by Griatch 2021_ @@ -466,7 +489,7 @@ current location (useful for displaying the grid as an in-game, updating map). ## rpg -_These are systems specifically related to roleplaying +_Systems specifically related to roleplaying and rule implementation like character traits, dice rolling and emoting._ ```{toctree} @@ -481,7 +504,7 @@ Contrib-Traits.md ``` -### Contrib: `buffs` +### `buffs` _Contribution by Tegiminis 2022_ @@ -492,7 +515,7 @@ It is a common design pattern in RPGs, particularly action games. -### Contrib: `character_creator` +### `character_creator` _Commands for managing and initiating an in-game character-creation menu._ @@ -502,7 +525,7 @@ Contribution by InspectorCaracal, 2022 -### Contrib: `dice` +### `dice` _Contribution by Griatch, 2012_ @@ -515,7 +538,7 @@ rolls for use by a human game master. -### Contrib: `health_bar` +### `health_bar` _Contribution by Tim Ashley Jenkins, 2017_ @@ -528,7 +551,7 @@ and can be used for any sort of appropriate data besides player health. -### Contrib: `rpsystem` +### `rpsystem` _Contribution by Griatch, 2015_ @@ -544,7 +567,7 @@ very powerful in-emote reference system, for referencing and differentiate targe -### Contrib: `traits` +### `traits` _Contribution by Griatch 2020, based on code by Whitenoise and Ainneve contribs, 2014_ @@ -567,7 +590,8 @@ healed). _Helper resources specifically meant to teach a development concept or to exemplify an Evennia system. Any extra resources tied to documentation -tutorials are found here. Also the home of the Tutorial World demo adventure._ +tutorials are found here. Also the home of the Tutorial-World and Evadventure +demo codes._ ```{toctree} :maxdepth: 1 @@ -582,7 +606,7 @@ Contrib-Tutorial-World.md ``` -### Contrib: `batchprocessor` +### `batchprocessor` _Contibution by Griatch, 2012_ @@ -594,7 +618,7 @@ control and then 'applied' to the game to create content. -### Contrib: `bodyfunctions` +### `bodyfunctions` _Contribution by Griatch, 2012_ @@ -605,7 +629,7 @@ character make small verbal observations at irregular intervals. -### Contrib: `evadventure` +### `evadventure` _Contrib by Griatch 2022_ @@ -620,7 +644,7 @@ perfection. -### Contrib: `mirror` +### `mirror` _Contribution by Griatch, 2017_ @@ -630,7 +654,7 @@ A simple mirror object to experiment with. It will respond to being looked at. -### Contrib: `red_button` +### `red_button` _Contribution by Griatch, 2011_ @@ -641,7 +665,7 @@ object with its own functionality and state tracking. -### Contrib: `talking_npc` +### `talking_npc` _Contribution by Griatch 2011. Updated by grungies1138, 2016_ @@ -652,7 +676,7 @@ conversation. Suitable for example as a quest giver or merchant. -### Contrib: `tutorial_world` +### `tutorial_world` _Contribution by Griatch 2011, 2015_ @@ -673,8 +697,7 @@ is a great way to start learning the system. ## utils -_Miscellaneous, optional tools for manipulating text, auditing connections -and more._ +_Miscellaneous, tools for manipulating text, security auditing, and more._ ```{toctree} :maxdepth: 1 @@ -688,7 +711,7 @@ Contrib-Tree-Select.md ``` -### Contrib: `auditing` +### `auditing` _Contribution by Johnny, 2017_ @@ -700,7 +723,7 @@ quality assurance, post-incident investigations and debugging. -### Contrib: `fieldfill` +### `fieldfill` _Contribution by Tim Ashley Jenkins, 2018_ @@ -716,7 +739,7 @@ to any callable of your choice. -### Contrib: `git_integration` +### `git_integration` _Contribution by helpme (2022)_ @@ -726,7 +749,7 @@ A module to integrate a stripped-down version of git within the game, allowing d -### Contrib: `name_generator` +### `name_generator` _Contribution by InspectorCaracal (2022)_ @@ -739,7 +762,7 @@ and used under the [CC BY-SA 4.0 license](https://creativecommons.org/licenses/b -### Contrib: `random_string_generator` +### `random_string_generator` _Contribution by Vincent Le Goff (vlgeoff), 2017_ @@ -752,7 +775,7 @@ passwords and so on. The strings generated will be stored and won't be repeated. -### Contrib: `tree_select` +### `tree_select` _Contribution by Tim Ashley Jenkins, 2017_ diff --git a/docs/1.0-dev/_sources/Evennia-Introduction.md.txt b/docs/1.0-dev/_sources/Evennia-Introduction.md.txt index c931225e9f..5554b24475 100644 --- a/docs/1.0-dev/_sources/Evennia-Introduction.md.txt +++ b/docs/1.0-dev/_sources/Evennia-Introduction.md.txt @@ -52,7 +52,7 @@ Evennia comes with a default set of commands for the Python newbies and for thos ### I know basic Python, or I am willing to learn -Evennia's source code is [extensively documented](https://www.evennia.com/docs/latest). But while Python is considered a very easy programming language to get into, you do have a learning curve to climb if you are new to programming. Evennia's [Starting-tutorial](Howtos/Beginner-Tutorial/Part1/Beginner-Tutorial-Part1-Intro.md) has a [basic introduction to Python](Howtos/Beginner-Tutorial/Part1/Beginner-Tutorial-Python-basic-introduction.md) but you should probably also sit down with a full Python beginner's tutorial at some point (there are plenty of them on the web if you look around). See also our [link page](./Links.md) for some reading suggestions. +Evennia's source code is [extensively documented](https://www.evennia.com/docs/latest). But while Python is considered a very easy programming language to get into, you do have a learning curve to climb if you are new to programming. Evennia's [Starting-tutorial](Howtos/Beginner-Tutorial/Part1/Beginner-Tutorial-Part1-Overview.md) has a [basic introduction to Python](Howtos/Beginner-Tutorial/Part1/Beginner-Tutorial-Python-basic-introduction.md) but you should probably also sit down with a full Python beginner's tutorial at some point (there are plenty of them on the web if you look around). See also our [link page](./Links.md) for some reading suggestions. To code your dream game in Evennia you don't need to be a Python guru, but you do need to be able to read example code containing at least these basic Python features: @@ -78,6 +78,6 @@ presence (a website and a mud web client) to play around with ... ## Where to from here? -It's recommended you jump into the [Beginner Tutorial](Howtos/Beginner-Tutorial/Beginner-Tutorial-Intro.md). You can either follow it or jump around to lessons that seem interesting. You can also read the lead developer's [dev blog](https://www.evennia.com/devblog/index.html) for many tidbits and snippets about Evennia's development and structure. +It's recommended you jump into the [Beginner Tutorial](Howtos/Beginner-Tutorial/Beginner-Tutorial-Overview.md). You can either follow it or jump around to lessons that seem interesting. You can also read the lead developer's [dev blog](https://www.evennia.com/devblog/index.html) for many tidbits and snippets about Evennia's development and structure. Sometimes it's easier to ask for help. Get engaged in the Evennia community by joining our [Discord](https://discord.gg/AJJpcRUhtF) for direct support. Make an introductory post to our [Discussion forum](https://github.com/evennia/evennia/discussions) and say hi!. \ No newline at end of file diff --git a/docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Beginner-Tutorial-Intro.md.txt b/docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Beginner-Tutorial-Intro.md.txt deleted file mode 100644 index 0ce5bdd833..0000000000 --- a/docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Beginner-Tutorial-Intro.md.txt +++ /dev/null @@ -1,114 +0,0 @@ -# Beginner Tutorial - -```{sidebar} Beginner Tutorial Parts -- **[Introduction](./Beginner-Tutorial-Intro.md)** -
    Getting set up. -- Part 1: [What we have](Part1/Beginner-Tutorial-Part1-Intro.md) -
    A tour of Evennia and how to use the tools, including an introduction to Python. -- Part 2: [What we want](Part2/Beginner-Tutorial-Part2-Intro.md) -
    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-Intro.md) -
    Getting down to the meat of extending Evennia to make our game -- Part 4: [Using what we created](Part4/Beginner-Tutorial-Part4-Intro.md) -
    Building a tech-demo and world content to go with our code -- Part 5: [Showing the world](Part5/Beginner-Tutorial-Part5-Intro.md) -
    Taking our new game online and let players try it out -``` - -Welcome to Evennia! This multi-part Beginner Tutorial will help you get off the ground. It consists -of five parts, each with several lessons. 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! - -Use the menu on the right to get the index of each tutorial-part. Use the [next](Part1/Beginner-Tutorial-Part1-Intro.md) -and [previous](../Howtos-Overview.md) links to step from lesson to lesson. - -## Things you need - -- A Command line -- A MUD client (or web browser) -- A text-editor/IDE -- Evennia installed and a game-dir initialized - -### A Command line - -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: - -- [Django-girls' 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. - -### A MUD client - -You might already have a MUD-client you prefer. Check out the [grid of supported clients](../../Setup/Client-Support-Grid.md) for aid. -If telnet's not your thing, you can also just use Evennia's web client in your browser. - -> 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. - -### An Editor -You need a text-editor to edit Python source files. Most everything that can edit and output raw -text works (so not 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. - -> Hint: When setting up your editor, make sure that pressing TAB inserts _4 spaces_ rather than a Tab-character. Since -> Python is whitespace-aware, this will make your life a lot easier. - - -### Set up a game dir for the tutorial - -Next you should make sure you have [installed Evennia](../../Setup/Installation.md). If you followed the instructions -you will already have created a game-dir. You could use that for this tutorial or you may want to do the -tutorial in its own, isolated game dir; it's up to you. - -- If you want a new gamedir for the tutorial game and already have Evennia running with another gamedir, - first enter that gamedir and run - - evennia stop - -> If you want to run two parallel servers, that'd be fine too, but one would have to use -> different ports from the defaults, or there'd be a clash. We will go into changing settings later. -- Now go to where you want to create your tutorial-game. We will always refer to it as `mygame` so - it may be convenient if you do too: - - evennia --init mygame - cd mygame - evennia migrate - evennia start --log - - Add your superuser name and password at the prompt (email is optional). Make sure you can - go to `localhost:4000` in your MUD client or to [http://localhost:4001](http://localhost:4001) - in your web browser (Mac users: Try `127.0.0.1` instead of `localhost` if you have trouble). - - The above `--log` flag will have Evennia output all its logs to the terminal. This will block - the terminal from other input. To leave the log-view, press `Ctrl-C` (`Cmd-C` on Mac). To see - the log again just run - - evennia --log - -You should now be good to go on to [the first part of the tutorial](Part1/Beginner-Tutorial-Part1-Intro.md). -Good luck! - -
    - -Click here to expand a list of all Beginner-Tutorial sections (all parts). - - -```{toctree} - -Part1/Beginner-Tutorial-Part1-Intro -Part2/Beginner-Tutorial-Part2-Intro -Part3/Beginner-Tutorial-Part3-Intro -Part4/Beginner-Tutorial-Part4-Intro -Part5/Beginner-Tutorial-Part5-Intro - -``` - -
    \ No newline at end of file diff --git a/docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Beginner-Tutorial-Overview.md.txt b/docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Beginner-Tutorial-Overview.md.txt new file mode 100644 index 0000000000..cb0e476c2c --- /dev/null +++ b/docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Beginner-Tutorial-Overview.md.txt @@ -0,0 +1,82 @@ +# Beginner Tutorial + +```{sidebar} Beginner Tutorial Parts +- **[Introduction](./Beginner-Tutorial-Overview.md)** +
    Getting set up. +- Part 1: [What we have](Part1/Beginner-Tutorial-Part1-Overview.md) +
    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) +
    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) +
    Getting down to the meat of extending Evennia to make our game +- Part 4: [Using what we created](Part4/Beginner-Tutorial-Part4-Overview.md) +
    Building a tech-demo and world content to go with our code +- Part 5: [Showing the world](Part5/Beginner-Tutorial-Part5-Overview.md) +
    Taking our new game online and let players try it out +``` + +Welcome to Evennia! This multi-part Beginner Tutorial will help you get off the ground. + +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! + +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. + +## Things you need + +- A Command line +- A MUD client (or web browser) +- A text-editor/IDE +- Evennia installed and a game-dir initialized + +### A Command line + +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: + +- [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. + +### 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. + +> 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. + +### 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). + +- [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. + +```{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. + +### A fresh game dir? + +You should make sure you have [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. + +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 do the same. + +You should now be ready to move on to the [first lesson](Part1/Beginner-Tutorial-Part1-Overview.md) + +
    + +Click here to expand a list of all Beginner-Tutorial sections (all parts). + + +```{toctree} + +Part1/Beginner-Tutorial-Part1-Overview +Part2/Beginner-Tutorial-Part2-Overview +Part3/Beginner-Tutorial-Part3-Overview +Part4/Beginner-Tutorial-Part4-Overview +Part5/Beginner-Tutorial-Part5-Overview + +``` + +
    \ No newline at end of file diff --git a/docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part1/Beginner-Tutorial-Part1-Intro.md.txt b/docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part1/Beginner-Tutorial-Part1-Overview.md.txt similarity index 80% rename from docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part1/Beginner-Tutorial-Part1-Intro.md.txt rename to docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part1/Beginner-Tutorial-Part1-Overview.md.txt index fabfabb5b6..a85188d511 100644 --- a/docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part1/Beginner-Tutorial-Part1-Intro.md.txt +++ b/docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part1/Beginner-Tutorial-Part1-Overview.md.txt @@ -1,17 +1,17 @@ # Part 1: What we have ```{sidebar} Beginner Tutorial Parts -- [Introduction](../Beginner-Tutorial-Intro.md) +- [Introduction](../Beginner-Tutorial-Overview.md)
    Getting set up. -- Part 1: **[What we have](./Beginner-Tutorial-Part1-Intro.md)** +- Part 1: **[What we have](./Beginner-Tutorial-Part1-Overview.md)**
    A tour of Evennia and how to use the tools, including an introduction to Python. -- Part 2: [What we want](../Part2/Beginner-Tutorial-Part2-Intro.md) +- Part 2: [What we want](../Part2/Beginner-Tutorial-Part2-Overview.md)
    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-Intro.md) +- Part 3: [How we get there](../Part3/Beginner-Tutorial-Part3-Overview.md)
    Getting down to the meat of extending Evennia to make our game -- Part 4: [Using what we created](../Part4/Beginner-Tutorial-Part4-Intro.md) +- Part 4: [Using what we created](../Part4/Beginner-Tutorial-Part4-Overview.md)
    Building a tech-demo and world content to go with our code -- Part 5: [Showing the world](../Part5/Beginner-Tutorial-Part5-Intro.md) +- Part 5: [Showing the world](../Part5/Beginner-Tutorial-Part5-Overview.md)
    Taking our new game online and let players try it out ``` diff --git a/docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part2/Beginner-Tutorial-Part2-Intro.md.txt b/docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part2/Beginner-Tutorial-Part2-Overview.md.txt similarity index 74% rename from docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part2/Beginner-Tutorial-Part2-Intro.md.txt rename to docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part2/Beginner-Tutorial-Part2-Overview.md.txt index d0b6b5cb97..b508589ce7 100644 --- a/docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part2/Beginner-Tutorial-Part2-Intro.md.txt +++ b/docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part2/Beginner-Tutorial-Part2-Overview.md.txt @@ -1,17 +1,17 @@ # Part 2: What we want ```{sidebar} Beginner Tutorial Parts -- [Introduction](../Beginner-Tutorial-Intro.md) +- [Introduction](../Beginner-Tutorial-Overview.md)
    Getting set up. -- Part 1: [What we have](../Part1/Beginner-Tutorial-Part1-Intro.md) +- Part 1: [What we have](../Part1/Beginner-Tutorial-Part1-Overview.md)
    A tour of Evennia and how to use the tools, including an introduction to Python. -- **Part 2: [What we want](./Beginner-Tutorial-Part2-Intro.md)** +- **Part 2: [What we want](./Beginner-Tutorial-Part2-Overview.md)**
    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-Intro.md) +- Part 3: [How we get there](../Part3/Beginner-Tutorial-Part3-Overview.md)
    Getting down to the meat of extending Evennia to make our game -- Part 4: [Using what we created](../Part4/Beginner-Tutorial-Part4-Intro.md) +- Part 4: [Using what we created](../Part4/Beginner-Tutorial-Part4-Overview.md)
    Building a tech-demo and world content to go with our code -- Part 5: [Showing the world](../Part5/Beginner-Tutorial-Part5-Intro.md) +- Part 5: [Showing the world](../Part5/Beginner-Tutorial-Part5-Overview.md)
    Taking our new game online and let players try it out ``` diff --git a/docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part3/Beginner-Tutorial-Part3-Intro.md.txt b/docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part3/Beginner-Tutorial-Part3-Overview.md.txt similarity index 85% rename from docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part3/Beginner-Tutorial-Part3-Intro.md.txt rename to docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part3/Beginner-Tutorial-Part3-Overview.md.txt index 3e75b3cf02..d08e91e17b 100644 --- a/docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part3/Beginner-Tutorial-Part3-Intro.md.txt +++ b/docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part3/Beginner-Tutorial-Part3-Overview.md.txt @@ -7,17 +7,17 @@ from it at this time. ``` ```{sidebar} Beginner Tutorial Parts -- [Introduction](../Beginner-Tutorial-Intro.md) +- [Introduction](../Beginner-Tutorial-Overview.md)
    Getting set up. -- Part 1: [What we have](../Part1/Beginner-Tutorial-Part1-Intro.md) +- Part 1: [What we have](../Part1/Beginner-Tutorial-Part1-Overview.md)
    A tour of Evennia and how to use the tools, including an introduction to Python. -- Part 2: [What we want](../Part2/Beginner-Tutorial-Part2-Intro.md) +- Part 2: [What we want](../Part2/Beginner-Tutorial-Part2-Overview.md)
    Planning our tutorial game and what to think about when planning your own in the future. -- **Part 3: [How we get there](./Beginner-Tutorial-Part3-Intro.md)** +- **Part 3: [How we get there](./Beginner-Tutorial-Part3-Overview.md)**
    Getting down to the meat of extending Evennia to make our game -- Part 4: [Using what we created](../Part4/Beginner-Tutorial-Part4-Intro.md) +- Part 4: [Using what we created](../Part4/Beginner-Tutorial-Part4-Overview.md)
    Building a tech-demo and world content to go with our code -- Part 5: [Showing the world](../Part5/Beginner-Tutorial-Part5-Intro.md) +- Part 5: [Showing the world](../Part5/Beginner-Tutorial-Part5-Overview.md)
    Taking our new game online and let players try it out ``` diff --git a/docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part4/Beginner-Tutorial-Part4-Intro.md.txt b/docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part4/Beginner-Tutorial-Part4-Intro.md.txt deleted file mode 100644 index 4d29a9d3f2..0000000000 --- a/docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part4/Beginner-Tutorial-Part4-Intro.md.txt +++ /dev/null @@ -1,34 +0,0 @@ -# Part 4: Using what we created - -```{sidebar} Beginner Tutorial Parts -- [Introduction](../Beginner-Tutorial-Intro.md) -
    Getting set up. -- Part 1: [What we have](../Part1/Beginner-Tutorial-Part1-Intro.md) -
    A tour of Evennia and how to use the tools, including an introduction to Python. -- Part 2: [What we want](../Part2/Beginner-Tutorial-Part2-Intro.md) -
    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-Intro.md) -
    Getting down to the meat of extending Evennia to make our game -- **Part 4: [Using what we created](./Beginner-Tutorial-Part4-Intro.md)** -
    Building a tech-demo and world content to go with our code -- Part 5: [Showing the world](../Part5/Beginner-Tutorial-Part5-Intro.md) -
    Taking our new game online and let players try it out -``` - -We now have the code underpinnings of everything we need. We have also tested the various components -and has a simple tech-demo to show it all works together. But there is no real coherence to it at this -point - we need to actually make a world. -In part four we will expand our tech demo into a more full-fledged (if small) game by use of batchcommand -and batchcode processors. - -## Lessons - -_TODO_ - -```{toctree} -:numbered: -:maxdepth: 2 -../../../Unimplemented.md -``` - - diff --git a/docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part4/Beginner-Tutorial-Part4-Overview.md.txt b/docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part4/Beginner-Tutorial-Part4-Overview.md.txt new file mode 100644 index 0000000000..3d45960079 --- /dev/null +++ b/docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part4/Beginner-Tutorial-Part4-Overview.md.txt @@ -0,0 +1,30 @@ +# Part 4: Using what we created + +```{sidebar} Beginner Tutorial Parts +- [Introduction](../Beginner-Tutorial-Overview.md) +
    Getting set up. +- Part 1: [What we have](../Part1/Beginner-Tutorial-Part1-Overview.md) +
    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) +
    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) +
    Getting down to the meat of extending Evennia to make our game +- **Part 4: [Using what we created](./Beginner-Tutorial-Part4-Overview.md)** +
    Building a tech-demo and world content to go with our code +- Part 5: [Showing the world](../Part5/Beginner-Tutorial-Part5-Overview.md) +
    Taking our new game online and let players try it out +``` + +We now have the code underpinnings of everything we need. We have also tested the various components and has a simple tech-demo to show it all works together. But there is no real coherence to it at this point - we need to actually make a world. In part four we will expand our tech demo into a more full-fledged (if small) game by use of batchcommand and batchcode processors. + +## Lessons + +_TODO_ + +```{toctree} +:numbered: +:maxdepth: 2 +../../../Unimplemented.md +``` + + diff --git a/docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part5/Beginner-Tutorial-Part5-Intro.md.txt b/docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part5/Beginner-Tutorial-Part5-Overview.md.txt similarity index 98% rename from docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part5/Beginner-Tutorial-Part5-Intro.md.txt rename to docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part5/Beginner-Tutorial-Part5-Overview.md.txt index a99272d1a7..013da068cc 100644 --- a/docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part5/Beginner-Tutorial-Part5-Intro.md.txt +++ b/docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part5/Beginner-Tutorial-Part5-Overview.md.txt @@ -27,5 +27,4 @@ _TODO_ :numbered: :maxdepth: 2 Add-a-simple-new-web-page.md -Web-Tutorial.md ``` \ No newline at end of file diff --git a/docs/1.0-dev/_sources/Howtos/Evennia-for-roleplaying-sessions.md.txt b/docs/1.0-dev/_sources/Howtos/Evennia-for-roleplaying-sessions.md.txt index 25a505bf00..a1d22f3ae5 100644 --- a/docs/1.0-dev/_sources/Howtos/Evennia-for-roleplaying-sessions.md.txt +++ b/docs/1.0-dev/_sources/Howtos/Evennia-for-roleplaying-sessions.md.txt @@ -31,7 +31,7 @@ instructions. Initialize a new game directory with `evennia init `. In this tutorial we assume your game dir is simply named `mygame`. You can use the default database and keep all other settings to default for now. Familiarize yourself with the `mygame` folder before continuing. You might want to browse the -[First Steps Coding](Beginner-Tutorial/Part1/Beginner-Tutorial-Part1-Intro.md) tutorial, just to see roughly where things are modified. +[First Steps Coding](Beginner-Tutorial/Part1/Beginner-Tutorial-Part1-Overview.md) tutorial, just to see roughly where things are modified. ## The Game Master role diff --git a/docs/1.0-dev/_sources/Howtos/Gametime-Tutorial.md.txt b/docs/1.0-dev/_sources/Howtos/Howto-Game-Time.md.txt similarity index 72% rename from docs/1.0-dev/_sources/Howtos/Gametime-Tutorial.md.txt rename to docs/1.0-dev/_sources/Howtos/Howto-Game-Time.md.txt index d38acac508..d129970ed9 100644 --- a/docs/1.0-dev/_sources/Howtos/Gametime-Tutorial.md.txt +++ b/docs/1.0-dev/_sources/Howtos/Howto-Game-Time.md.txt @@ -1,11 +1,8 @@ -# Gametime Tutorial +# Changing game calendar and time speed -A lot of games use a separate time system we refer to as *game time*. This runs in parallel to what -we usually think of as *real time*. The game time might run at a different speed, use different -names for its time units or might even use a completely custom calendar. You don't need to rely on a -game time system at all. But if you do, Evennia offers basic tools to handle these various -situations. This tutorial will walk you through these features. +A lot of games use a separate time system we refer to as *game time*. This runs in parallel to what we usually think of as *real time*. The game time might run at a different speed, use different +names for its time units or might even use a completely custom calendar. You don't need to rely on a game time system at all. But if you do, Evennia offers basic tools to handle these various situations. This tutorial will walk you through these features. ## A game time with a standard calendar @@ -18,8 +15,7 @@ in-game perceived one is easy. - The intricacies of the real world calendar, with leap years and months of different length etc are automatically handled by the system. -Evennia's game time features assume a standard calendar (see the relevant section below for a custom -calendar). +Evennia's game time features assume a standard calendar (see the relevant section below for a custom calendar). ### Setting up game time for a standard calendar @@ -39,11 +35,7 @@ TIME_FACTOR = 2.0 TIME_GAME_EPOCH = None ``` -By default, the game time runs twice as fast as the real time. You can set the time factor to be 1 -(the game time would run exactly at the same speed than the real time) or lower (the game time will -be slower than the real time). Most games choose to have the game time spinning faster (you will -find some games that have a time factor of 60, meaning the game time runs sixty times as fast as the -real time, a minute in real time would be an hour in game time). +By default, the game time runs twice as fast as the real time. You can set the time factor to be 1 (the game time would run exactly at the same speed than the real time) or lower (the game time will be slower than the real time). Most games choose to have the game time spinning faster (you will find some games that have a time factor of 60, meaning the game time runs sixty times as fast as the real time, a minute in real time would be an hour in game time). The epoch is a slightly more complex setting. It should contain a number of seconds that would indicate the time your game started. As indicated, an epoch of 0 would mean January 1st, 1970. If @@ -59,8 +51,7 @@ start = datetime(2020, 1, 1) time.mktime(start.timetuple()) ``` -This should return a huge number - the number of seconds since Jan 1 1970. Copy that directly into -your settings (editing `server/conf/settings.py`): +This should return a huge number - the number of seconds since Jan 1 1970. Copy that directly into your settings (editing `server/conf/settings.py`): ```python # in a file settings.py in mygame/server/conf @@ -93,22 +84,15 @@ time updated correctly... and going (by default) twice as fast as the real time. ### Time-related events -The `gametime` utility also has a way to schedule game-related events, taking into account your game -time, and assuming a standard calendar (see below for the same feature with a custom calendar). For -instance, it can be used to have a specific message every (in-game) day at 6:00 AM showing how the -sun rises. +The `gametime` utility also has a way to schedule game-related events, taking into account your game time, and assuming a standard calendar (see below for the same feature with a custom calendar). For instance, it can be used to have a specific message every (in-game) day at 6:00 AM showing how the sun rises. -The function `schedule()` should be used here. It will create a [script](../Components/Scripts.md) with some -additional features to make sure the script is always executed when the game time matches the given -parameters. +The function `schedule()` should be used here. It will create a [script](../Components/Scripts.md) with some additional features to make sure the script is always executed when the game time matches the given parameters. The `schedule` function takes the following arguments: - The *callback*, a function to be called when time is up. -- The keyword `repeat` (`False` by default) to indicate whether this function should be called -repeatedly. -- Additional keyword arguments `sec`, `min`, `hour`, `day`, `month` and `year` to describe the time -to schedule. If the parameter isn't given, it assumes the current time value of this specific unit. +- The keyword `repeat` (`False` by default) to indicate whether this function should be called repeatedly. +- Additional keyword arguments `sec`, `min`, `hour`, `day`, `month` and `year` to describe the time to schedule. If the parameter isn't given, it assumes the current time value of this specific unit. Here is a short example for making the sun rise every day: @@ -140,9 +124,7 @@ The script will be created silently. The `at_sunrise` function will now be calle at 6 AM. You can use the `@scripts` command to see it. You could stop it using `@scripts/stop`. If we hadn't set `repeat` the sun would only have risen once and then never again. -We used the `@py` command here: nothing prevents you from adding the system into your game code. -Remember to be careful not to add each event at startup, however, otherwise there will be a lot of -overlapping events scheduled when the sun rises. +We used the `@py` command here: nothing prevents you from adding the system into your game code. Remember to be careful not to add each event at startup, however, otherwise there will be a lot of overlapping events scheduled when the sun rises. The `schedule` function when using `repeat` set to `True` works with the higher, non-specified unit. In our example, we have specified hour, minute and second. The higher unit we haven't specified is @@ -156,26 +138,16 @@ such day in February, April etc. Similarly, leap years may change the number of ### A game time with a custom calendar -Using a custom calendar to handle game time is sometimes needed if you want to place your game in a -fictional universe. For instance you may want to create the Shire calendar which Tolkien described -having 12 months, each which 30 days. That would give only 360 days per year (presumably hobbits -weren't really fond of the hassle of following the astronomical calendar). Another example would be -creating a planet in a different solar system with, say, days 29 hours long and months of only 18 -days. +Using a custom calendar to handle game time is sometimes needed if you want to place your game in a fictional universe. For instance you may want to create the Shire calendar which Tolkien described having 12 months, each which 30 days. That would give only 360 days per year (presumably hobbits weren't really fond of the hassle of following the astronomical calendar). Another example would be creating a planet in a different solar system with, say, days 29 hours long and months of only 18 days. Evennia handles custom calendars through an optional *contrib* module, called `custom_gametime`. Contrary to the normal `gametime` module described above it is not active by default. ### Setting up the custom calendar -In our first example of the Shire calendar, used by hobbits in books by Tolkien, we don't really -need the notion of weeks... but we need the notion of months having 30 days, not 28. +In our first example of the Shire calendar, used by hobbits in books by Tolkien, we don't really need the notion of weeks... but we need the notion of months having 30 days, not 28. -The custom calendar is defined by adding the `TIME_UNITS` setting to your settings file. It's a -dictionary containing as keys the name of the units, and as value the number of seconds (the -smallest unit for us) in this unit. Its keys must be picked among the following: "sec", "min", -"hour", "day", "week", "month" and "year" but you don't have to include them all. Here is the -configuration for the Shire calendar: +The custom calendar is defined by adding the `TIME_UNITS` setting to your settings file. It's a dictionary containing as keys the name of the units, and as value the number of seconds (the smallest unit for us) in this unit. Its keys must be picked among the following: "sec", "min", "hour", "day", "week", "month" and "year" but you don't have to include them all. Here is the configuration for the Shire calendar: ```python # in a file settings.py in mygame/server/conf @@ -187,12 +159,9 @@ TIME_UNITS = {"sec": 1, "year": 60 * 60 * 24 * 30 * 12 } ``` -We give each unit we want as keys. Values represent the number of seconds in that unit. Hour is -set to 60 * 60 (that is, 3600 seconds per hour). Notice that we don't specify the week unit in this -configuration: instead, we skip from days to months directly. +We give each unit we want as keys. Values represent the number of seconds in that unit. Hour is set to 60 * 60 (that is, 3600 seconds per hour). Notice that we don't specify the week unit in this configuration: instead, we skip from days to months directly. -In order for this setting to work properly, remember all units have to be multiples of the previous -units. If you create "day", it needs to be multiple of hours, for instance. +In order for this setting to work properly, remember all units have to be multiples of the previous units. If you create "day", it needs to be multiple of hours, for instance. So for our example, our settings may look like this: @@ -215,20 +184,17 @@ TIME_UNITS = { } ``` -Notice we have set a time epoch of 0. Using a custom calendar, we will come up with a nice display -of time on our own. In our case the game time starts at year 0, month 1, day 1, and at midnight. +Notice we have set a time epoch of 0. Using a custom calendar, we will come up with a nice display of time on our own. In our case the game time starts at year 0, month 1, day 1, and at midnight. > Year, hour, minute and sec starts from 0, month, week and day starts from 1, this makes them > behave consistently with the standard time. -Note that while we use "month", "week" etc in the settings, your game may not use those terms in- -game, instead referring to them as "cycles", "moons", "sand falls" etc. This is just a matter of you +Note that while we use "month", "week" etc in the settings, your game may not use those terms in- game, instead referring to them as "cycles", "moons", "sand falls" etc. This is just a matter of you displaying them differently. See next section. #### A command to display the current game time -As pointed out earlier, the `@time` command is meant to be used with a standard calendar, not a -custom one. We can easily create a new command though. We'll call it `time`, as is often the case +As pointed out earlier, the `@time` command is meant to be used with a standard calendar, not a custom one. We can easily create a new command though. We'll call it `time`, as is often the case on other MU*. Here's an example of how we could write it (for the example, you can create a file `gametime.py` in your `commands` directory and paste this code in it): @@ -287,8 +253,7 @@ class CharacterCmdSet(default_cmds.CharacterCmdSet): self.add(CmdTime()) # <- Add ``` -Reload your game with the `@reload` command. You should now see the `time` command. If you enter -it, you might see something like: +Reload your game with the `@reload` command. You should now see the `time` command. If you enter it, you might see something like: We are in year 0, day 0, month 0. It's 00:52:17. @@ -298,7 +263,4 @@ And if "months" are called "moons" in your game, this is where you'd add that. ## Time-related events in custom gametime -The `custom_gametime` module also has a way to schedule game-related events, taking into account -your game time (and your custom calendar). It can be used to have a specific message every day at -6:00 AM, to show the sun rises, for instance. The `custom_gametime.schedule` function works in the -same way as described for the default one above. +The `custom_gametime` module also has a way to schedule game-related events, taking into account your game time (and your custom calendar). It can be used to have a specific message every day at 6:00 AM, to show the sun rises, for instance. The `custom_gametime.schedule` function works in the same way as described for the default one above. diff --git a/docs/1.0-dev/_sources/Howtos/Howtos-Overview.md.txt b/docs/1.0-dev/_sources/Howtos/Howtos-Overview.md.txt index 45dd186e96..283eedd847 100644 --- a/docs/1.0-dev/_sources/Howtos/Howtos-Overview.md.txt +++ b/docs/1.0-dev/_sources/Howtos/Howtos-Overview.md.txt @@ -1,6 +1,8 @@ # Tutorials and Howto's -All Evennia tutorials. They will often refer to the [components](../Components/Components-Overview.md) or [concepts](../Concepts/Concepts-Overview.md) if you want to dive deeper. +```{sidebar} Want more details about something? +See the documentation about the Evennia core [Components](../Components/Components-Overview.md) and important [Concepts](../Concepts/Concepts-Overview.md). +``` ## Beginner Tutorial @@ -13,43 +15,30 @@ Part 3 and onwards are still under development. ```{toctree} :maxdepth: 3 -./Beginner-Tutorial/Beginner-Tutorial-Intro -./Beginner-Tutorial/Part1/Beginner-Tutorial-Part1-Intro -./Beginner-Tutorial/Part2/Beginner-Tutorial-Part2-Intro -./Beginner-Tutorial/Part3/Beginner-Tutorial-Part3-Intro -./Beginner-Tutorial/Part4/Beginner-Tutorial-Part4-Intro -./Beginner-Tutorial/Part5/Beginner-Tutorial-Part5-Intro +./Beginner-Tutorial/Beginner-Tutorial-Overview +./Beginner-Tutorial/Part1/Beginner-Tutorial-Part1-Overview +./Beginner-Tutorial/Part2/Beginner-Tutorial-Part2-Overview +./Beginner-Tutorial/Part3/Beginner-Tutorial-Part3-Overview +./Beginner-Tutorial/Part4/Beginner-Tutorial-Part4-Overview +./Beginner-Tutorial/Part5/Beginner-Tutorial-Part5-Overview ``` ## Howto's ```{toctree} -:maxdepth: 2 +:maxdepth: 1 Howto-Command-Prompt.md Howto-Command-Cooldown.md Howto-Command-Duration.md Howto-Default-Exit-Errors.md Howto-Add-Object-Weight.md -``` -## Mobs and NPCs - -```{toctree} -:maxdepth: 1 - Tutorial-NPC-Listening.md Tutorial-NPC-Reacting.md Tutorial-NPC-Merchants.md -``` - -## Vehicles - -```{toctree} -:maxdepth: 1 - -Building-a-mech-tutorial.md -Tutorial-Vehicles.md +Tutorial-Building-a-Mech.md +Tutorial-Building-a-Train.md ``` ## Systems @@ -57,37 +46,38 @@ Tutorial-Vehicles.md :maxdepth: 1 Tutorial-Persistent-Handler.md -Gametime-Tutorial.md -Weather-Tutorial.md +Howto-Game-Time.md +Tutorial-Weather-Effects.md Tutorial-Coordinates.md -Dynamic-In-Game-Map.md -Static-In-Game-Map.md -Tutorial-Tweeting-Game-Stats.md +Tutorial-Displaying-Room-Map.md ``` ## Web-related tutorials +_Some of these will likely move into the Beginner tutorial later_. + ```{toctree} :maxdepth: 1 +Web-Changing-Webpage.md Web-Add-a-wiki.md Web-Character-Generation.md Web-Character-View-Tutorial.md Web-Help-System-Tutorial.md Web-Extending-the-REST-API - +Web-Tweeting-Game-Stats.md ``` ## Deep-dives ```{toctree} :maxdepth: 1 -Parsing-commands-tutorial.md +Tutorial-Parsing-Commands.md Tutorial-Understanding-Color-Tags.md Evennia-for-roleplaying-sessions.md Evennia-for-Diku-Users.md Evennia-for-MUSH-Users.md -Arxcode-Installation.md +Tutorial-Using-Arxcode.md ``` ## Old tutorials diff --git a/docs/1.0-dev/_sources/Howtos/Building-a-mech-tutorial.md.txt b/docs/1.0-dev/_sources/Howtos/Tutorial-Building-a-Mech.md.txt similarity index 52% rename from docs/1.0-dev/_sources/Howtos/Building-a-mech-tutorial.md.txt rename to docs/1.0-dev/_sources/Howtos/Tutorial-Building-a-Mech.md.txt index edce1cb379..ea4b2490a2 100644 --- a/docs/1.0-dev/_sources/Howtos/Building-a-mech-tutorial.md.txt +++ b/docs/1.0-dev/_sources/Howtos/Tutorial-Building-a-Mech.md.txt @@ -1,67 +1,49 @@ -# Building a mech tutorial +# Building a giant mech -> This page was adapted from the article "Building a Giant Mech in Evennia" by Griatch, published in -Imaginary Realities Volume 6, issue 1, 2014. The original article is no longer available online, -this is a version adopted to be compatible with the latest Evennia. +Let us create a functioning giant mech in Evennia. Everyone likes a giant mech, right? Start in-game as a character with build privileges (or the superuser). -## Creating the Mech - -Let us create a functioning giant mech using the Python MUD-creation system Evennia. Everyone likes -a giant mech, right? Start in-game as a character with build privileges (or the superuser). - - @create/drop Giant Mech ; mech + create/drop Giant Mech ; mech Boom. We created a Giant Mech Object and dropped it in the room. We also gave it an alias *mech*. Let’s describe it. - @desc mech = This is a huge mech. It has missiles and stuff. + desc mech = This is a huge mech. It has missiles and stuff. Next we define who can “puppet” the mech object. - @lock mech = puppet:all() + lock mech = puppet:all() -This makes it so that everyone can control the mech. More mechs to the people! (Note that whereas -Evennia’s default commands may look vaguely MUX-like, you can change the syntax to look like -whatever interface style you prefer.) +This makes it so that everyone can control the mech. More mechs to the people! (Note that whereas Evennia’s default commands may look vaguely MUX-like, you can change the syntax to look like whatever interface style you prefer.) -Before we continue, let’s make a brief detour. Evennia is very flexible about its objects and even -more flexible about using and adding commands to those objects. Here are some ground rules well -worth remembering for the remainder of this article: +Before we continue, let’s make a brief detour. Evennia is very flexible about its objects and even more flexible about using and adding commands to those objects. Here are some ground rules well worth remembering for the remainder of this article: - The [Account](../Components/Accounts.md) represents the real person logging in and has no game-world existence. - Any [Object](../Components/Objects.md) can be puppeted by an Account (with proper permissions). -- [Characters](../Components/Objects.md#characters), [Rooms](../Components/Objects.md#rooms), and [Exits](../Components/Objects.md#exits) are just -children of normal Objects. +- [Characters](../Components/Objects.md#characters), [Rooms](../Components/Objects.md#rooms), and [Exits](../Components/Objects.md#exits) are just children of normal Objects. - Any Object can be inside another (except if it creates a loop). - Any Object can store custom sets of commands on it. Those commands can: - be made available to the puppeteer (Account), - be made available to anyone in the same location as the Object, and - be made available to anyone “inside” the Object - - Also Accounts can store commands on themselves. Account commands are always available unless -commands on a puppeted Object explicitly override them. + - Also Accounts can store commands on themselves. Account commands are always available unless commands on a puppeted Object explicitly override them. -In Evennia, using the `@ic` command will allow you to puppet a given Object (assuming you have -puppet-access to do so). As mentioned above, the bog-standard Character class is in fact like any -Object: it is auto-puppeted when logging in and just has a command set on it containing the normal -in-game commands, like look, inventory, get and so on. +In Evennia, using the `ic` command will allow you to puppet a given Object (assuming you have puppet-access to do so). As mentioned above, the bog-standard Character class is in fact like any Object: it is auto-puppeted when logging in and just has a command set on it containing the normal in-game commands, like look, inventory, get and so on. - @ic mech + ic mech You just jumped out of your Character and *are* now the mech! If people look at you in-game, they will look at a mech. The problem at this point is that the mech Object has no commands of its own. The usual things like look, inventory and get sat on the Character object, remember? So at the moment the mech is not quite as cool as it could be. - @ic + ic You just jumped back to puppeting your normal, mundane Character again. All is well. -> (But, you ask, where did that `@ic` command come from, if the mech had no commands on it? The -answer is that it came from the Account's command set. This is important. Without the Account being -the one with the `@ic` command, we would not have been able to get back out of our mech again.) +> Where did that `ic` command come from, if the mech had no commands on it? The +answer is that it came from the `Account`'s command set. This is important. Without the Account being the one with the `ic` command, we would not have been able to get back out of our mech again. - -### Arming the Mech +## Make a Mech that can shoot Let us make the mech a little more interesting. In our favorite text editor, we will create some new mech-suitable commands. In Evennia, commands are defined as Python classes. @@ -109,20 +91,12 @@ class CmdLaunch(Command): ``` -This is saved as a normal Python module (let’s call it `mechcommands.py`), in a place Evennia looks -for such modules (`mygame/commands/`). This command will trigger when the player gives the command -“shoot”, “fire,” or even “fire!” with an exclamation mark. The mech can shoot in the air or at a -target if you give one. In a real game the gun would probably be given a chance to hit and give +This is saved as a normal Python module (let’s call it `mechcommands.py`), in a place Evennia looks for such modules (`mygame/commands/`). This command will trigger when the player gives the command “shoot”, “fire,” or even “fire!” with an exclamation mark. The mech can shoot in the air or at a target if you give one. In a real game the gun would probably be given a chance to hit and give damage to the target, but this is enough for now. -We also make a second command for launching missiles (`CmdLaunch`). To save -space we won’t describe it here; it looks the same except it returns a text -about the missiles being fired and has different `key` and `aliases`. We leave -that up to you to create as an exercise. You could have it print "WOOSH! The -mech launches missiles against !", for example. +We also make a second command for launching missiles (`CmdLaunch`). To save space we won’t describe it here; it looks the same except it returns a text about the missiles being fired and has different `key` and `aliases`. We leave that up to you to create as an exercise. You could have it print `"WOOSH! The mech launches missiles against !`, for example. -Now we shove our commands into a command set. A [Command Set](../Components/Command-Sets.md) (CmdSet) is a container -holding any number of commands. The command set is what we will store on the mech. +Now we shove our commands into a command set. A [Command Set](../Components/Command-Sets.md) (CmdSet) is a container holding any number of commands. The command set is what we will store on the mech. ```python # in the same file mygame/commands/mechcommands.py @@ -142,37 +116,29 @@ class MechCmdSet(CmdSet): self.add(CmdLaunch()) ``` -This simply groups all the commands we want. We add our new shoot/launch commands. Let’s head back -into the game. For testing we will manually attach our new CmdSet to the mech. +This simply groups all the commands we want. We add our new shoot/launch commands. Let’s head back into the game. For testing we will manually attach our new CmdSet to the mech. - @py self.search("mech").cmdset.add("commands.mechcommands.MechCmdSet") + py self.search("mech").cmdset.add("commands.mechcommands.MechCmdSet") -This is a little Python snippet (run from the command line as an admin) that searches for the mech -in our current location and attaches our new MechCmdSet to it. What we add is actually the Python -path to our cmdset class. Evennia will import and initialize it behind the scenes. +This is a little Python snippet that searches for the mech in our current location and attaches our new MechCmdSet to it. What we add is actually the Python path to our cmdset class. Evennia will import and initialize it behind the scenes. - @ic mech + ic mech We are back as the mech! Let’s do some shooting! fire! BOOM! The mech fires its gun in the air! -There we go, one functioning mech. Try your own `launch` command and see that it works too. We can -not only walk around as the mech — since the CharacterCmdSet is included in our MechCmdSet, the mech -can also do everything a Character could do, like look around, pick up stuff, and have an inventory. -We could now shoot the gun at a target or try the missile launch command. Once you have your own -mech, what else do you need? +There we go, one functioning mech. Try your own `launch` command and see that it works too. We can not only walk around as the mech — since the CharacterCmdSet is included in our MechCmdSet, the mech can also do everything a Character could do, like look around, pick up stuff, and have an inventory. We could now shoot the gun at a target or try the missile launch command. Once you have your own mech, what else do you need? -> Note: You'll find that the mech's commands are available to you by just standing in the same +> You'll find that the mech's commands are available to you by just standing in the same location (not just by puppeting it). We'll solve this with a *lock* in the next section. -## Making a Mech production line +## Making an army of Mechs What we’ve done so far is just to make a normal Object, describe it and put some commands on it. This is great for testing. The way we added it, the MechCmdSet will even go away if we reload the -server. Now we want to make the mech an actual object “type” so we can create mechs without those -extra steps. For this we need to create a new Typeclass. +server. Now we want to make the mech an actual object “type” so we can create mechs without those extra steps. For this we need to create a new Typeclass. A [Typeclass](../Components/Typeclasses.md) is a near-normal Python class that stores its existence to the database behind the scenes. A Typeclass is created in a normal Python source file: @@ -196,42 +162,31 @@ class Mech(Object): self.db.desc = "This is a huge mech. It has missiles and stuff." ``` -For convenience we include the full contents of the default `CharacterCmdSet` in there. This will -make a Character’s normal commands available to the mech. We also add the mech-commands from before, -making sure they are stored persistently in the database. The locks specify that anyone can puppet -the meck and no-one can "call" the mech's Commands from 'outside' it - you have to puppet it to be -able to shoot. +For convenience we include the full contents of the default `CharacterCmdSet` in there. This will make a Character’s normal commands available to the mech. We also add the mech-commands from before, making sure they are stored persistently in the database. The locks specify that anyone can puppet the meck and no-one can "call" the mech's Commands from 'outside' it - you have to puppet it to be able to shoot. -That’s it. When Objects of this type are created, they will always start out with the mech’s command -set and the correct lock. We set a default description, but you would probably change this with -`@desc` to individualize your mechs as you build them. +That’s it. When Objects of this type are created, they will always start out with the mech’s command set and the correct lock. We set a default description, but you would probably change this with `desc` to individualize your mechs as you build them. Back in the game, just exit the old mech (`@ic` back to your old character) then do - @create/drop The Bigger Mech ; bigmech : mech.Mech + create/drop The Bigger Mech ; bigmech : mech.Mech We create a new, bigger mech with an alias bigmech. Note how we give the python-path to our Typeclass at the end — this tells Evennia to create the new object based on that class (we don't -have to give the full path in our game dir `typeclasses.mech.Mech` because Evennia knows to look in -the `typeclasses` folder already). A shining new mech will appear in the room! Just use +have to give the full path in our game dir `typeclasses.mech.Mech` because Evennia knows to look in the `typeclasses` folder already). A shining new mech will appear in the room! Just use - @ic bigmech + ic bigmech to take it on a test drive. -## Future Mechs +### Future Mechs -To expand on this you could add more commands to the mech and remove others. Maybe the mech -shouldn’t work just like a Character after all. Maybe it makes loud noises every time it passes from -room to room. Maybe it cannot pick up things without crushing them. Maybe it needs fuel, ammo and -repairs. Maybe you’ll lock it down so it can only be puppeted by emo teenagers. - -Having you puppet the mech-object directly is also just one way to implement a giant mech in -Evennia. +Having you puppet the mech-object directly is just one way to implement a giant mech in Evennia. For example, you could instead picture a mech as a “vehicle” that you “enter” as your normal -Character (since any Object can move inside another). In that case the “insides” of the mech Object -could be the “cockpit”. The cockpit would have the `MechCommandSet` stored on itself and all the -shooting goodness would be made available to you only when you enter it. +Character (since any Object can move inside another). In that case the “insides” of the mech Object could be the “cockpit”. The cockpit would have the `MechCommandSet` stored on itself and all the shooting goodness would be made available to you only when you enter it. -And of course you could put more guns on it. And make it fly. +To expand on this you could add more commands to the mech and remove others. Maybe the mech shouldn’t work just like a Character after all. + +Maybe it makes loud noises every time it passes from room to room. Maybe it cannot pick up things without crushing them. Maybe it needs fuel, ammo and repairs. Maybe you’ll lock it down so it can only be puppeted by emo teenagers. + +And of course you could put more guns on it. And make it fly. \ No newline at end of file diff --git a/docs/1.0-dev/_sources/Howtos/Tutorial-Vehicles.md.txt b/docs/1.0-dev/_sources/Howtos/Tutorial-Building-a-Train.md.txt similarity index 67% rename from docs/1.0-dev/_sources/Howtos/Tutorial-Vehicles.md.txt rename to docs/1.0-dev/_sources/Howtos/Tutorial-Building-a-Train.md.txt index acb074de6a..74befd4f04 100644 --- a/docs/1.0-dev/_sources/Howtos/Tutorial-Vehicles.md.txt +++ b/docs/1.0-dev/_sources/Howtos/Tutorial-Building-a-Train.md.txt @@ -1,15 +1,11 @@ -# Tutorial Vehicles +# Building a train that moves +> TODO: This should be updated for latest Evennia use. -This tutorial explains how you can create vehicles that can move around in your world. The tutorial -will explain how to create a train, but this can be equally applied to create other kind of vehicles +Vehicles are things that you can enter and then move around in your game world. Here we'll explain how to create a train, but this can be equally applied to create other kind of vehicles (cars, planes, boats, spaceships, submarines, ...). -## How it works - -Objects in Evennia have an interesting property: you can put any object inside another object. This -is most obvious in rooms: a room in Evennia is just like any other game object (except rooms tend to -not themselves be inside anything else). +Objects in Evennia have an interesting property: you can put any object inside another object. This is most obvious in rooms: a room in Evennia is just like any other game object (except rooms tend to not themselves be inside anything else). Our train will be similar: it will be an object that other objects can get inside. We then simply move the Train, which brings along everyone inside it. @@ -20,7 +16,7 @@ The first step we need to do is create our train object, including a new typecla create a new file, for instance in `mygame/typeclasses/train.py` with the following content: ```python -# file mygame/typeclasses/train.py +# in mygame/typeclasses/train.py from evennia import DefaultObject @@ -35,28 +31,24 @@ class TrainObject(DefaultObject): Now we can create our train in our game: ``` -@create/drop train:train.TrainObject +create/drop train:train.TrainObject ``` Now this is just an object that doesn't do much yet... but we can already force our way inside it and back (assuming we created it in limbo). ``` -@tel train -@tel limbo +tel train +tel limbo ``` ## Entering and leaving the train -Using the `@tel`command like shown above is obviously not what we want. `@tel` is an admin command -and normal players will thus never be able to enter the train! It is also not really a good idea to -use [Exits](../Components/Objects.md#exits) to get in and out of the train - Exits are (at least by default) objects -too. They point to a specific destination. If we put an Exit in this room leading inside the train -it would stay here when the train moved away (still leading into the train like a magic portal!). In -the same way, if we put an Exit object inside the train, it would always point back to this room, -regardless of where the Train has moved. Now, one *could* define custom Exit types that move with -the train or change their destination in the right way - but this seems to be a pretty cumbersome -solution. +Using the `tel`command like shown above is obviously not what we want. `@tel` is an admin command and normal players will thus never be able to enter the train! + +It is also not really a good idea to use [Exits](../Components/Objects.md#exits) to get in and out of the train - Exits are (at least by default) objects too. They point to a specific destination. If we put an Exit in this room leading inside the train it would stay here when the train moved away (still leading into the train like a magic portal!). In the same way, if we put an Exit object inside the train, it would always point back to this room, regardless of where the Train has moved. + +Now, one *could* define custom Exit types that move with the train or change their destination in the right way - but this seems to be a pretty cumbersome solution. What we will do instead is to create some new [commands](../Components/Commands.md): one for entering the train and another for leaving it again. These will be stored *on the train object* and will thus be made @@ -81,7 +73,6 @@ class CmdEnterTrain(Command): """ key = "enter train" - locks = "cmd:all()" def func(self): train = self.obj @@ -102,7 +93,6 @@ class CmdLeaveTrain(Command): """ key = "leave train" - locks = "cmd:all()" def func(self): train = self.obj @@ -119,39 +109,34 @@ class CmdSetTrain(CmdSet): Note that while this seems like a lot of text, the majority of lines here are taken up by documentation. -These commands are work in a pretty straightforward way: `CmdEnterTrain` moves the location of the -player to inside the train and `CmdLeaveTrain` does the opposite: it moves the player back to the -current location of the train (back outside to its current location). We stacked them in a -[cmdset](../Components/Command-Sets.md) `CmdSetTrain` so they can be used. +These commands are work in a pretty straightforward way: `CmdEnterTrain` moves the location of the player to inside the train and `CmdLeaveTrain` does the opposite: it moves the player back to the +current location of the train (back outside to its current location). We stacked them in a [cmdset](../Components/Command-Sets.md) `CmdSetTrain` so they can be used. To make the commands work we need to add this cmdset to our train typeclass: ```python # file mygame/typeclasses/train.py -from evennia import DefaultObject from commands.train import CmdSetTrain +from typeclasses.objects import Object -class TrainObject(DefaultObject): +class TrainObject(Object): def at_object_creation(self): self.cmdset.add_default(CmdSetTrain) ``` -If we now `@reload` our game and reset our train, those commands should work and we can now enter -and leave the train: +If we now `reload` our game and reset our train, those commands should work and we can now enter and leave the train: ``` -@reload -@typeclass/force/reset train = train.TrainObject +reload +typeclass/force/reset train = train.TrainObject enter train leave train ``` -Note the switches used with the `@typeclass` command: The `/force` switch is necessary to assign our -object the same typeclass we already have. The `/reset` re-triggers the typeclass' -`at_object_creation()` hook (which is otherwise only called the very first an instance is created). +Note the switches used with the `typeclass` command: The `/force` switch is necessary to assign our object the same typeclass we already have. The `/reset` re-triggers the typeclass' `at_object_creation()` hook (which is otherwise only called the very first an instance is created). As seen above, when this hook is called on our train, our new cmdset will be loaded. ## Locking down the commands @@ -159,17 +144,12 @@ As seen above, when this hook is called on our train, our new cmdset will be loa If you have played around a bit, you've probably figured out that you can use `leave train` when outside the train and `enter train` when inside. This doesn't make any sense ... so let's go ahead and fix that. We need to tell Evennia that you can not enter the train when you're already inside -or leave the train when you're outside. One solution to this is [locks](../Components/Locks.md): we will lock down -the commands so that they can only be called if the player is at the correct location. +or leave the train when you're outside. One solution to this is [locks](../Components/Locks.md): we will lock down the commands so that they can only be called if the player is at the correct location. -Right now commands defaults to the lock `cmd:all()`. The `cmd` lock type in combination with the -`all()` lock function means that everyone can run those commands as long as they are in the same -room as the train *or* inside the train. We're going to change this to check the location of the -player and *only* allow access if they are inside the train. +Since we didn't set a `lock` property on the Command, it defaults to `cmd:all()`. This means that everyone can use the command as long as they are in the same room _or inside the train_. First of all we need to create a new lock function. Evennia comes with many lock functions built-in -already, but none that we can use for locking a command in this particular case. Create a new entry -in `mygame/server/conf/lockfuncs.py`: +already, but none that we can use for locking a command in this particular case. Create a new entry in `mygame/server/conf/lockfuncs.py`: ```python @@ -187,12 +167,7 @@ def cmdinside(accessing_obj, accessed_obj, *args, **kwargs): If you didn't know, Evennia is by default set up to use all functions in this module as lock functions (there is a setting variable that points to it). -Our new lock function, `cmdinside`, is to be used by Commands. The `accessed_obj` is the Command -object (in our case this will be `CmdEnterTrain` and `CmdLeaveTrain`) — Every command has an `obj` -property: this is the the object on which the command "sits". Since we added those commands to our -train object, the `.obj` property will be set to the train object. Conversely, `accessing_obj` is -the object that called the command: in our case it's the Character trying to enter or leave the -train. +Our new lock function, `cmdinside`, is to be used by Commands. The `accessed_obj` is the Command object (in our case this will be `CmdEnterTrain` and `CmdLeaveTrain`) — Every command has an `obj` property: this is the the object on which the command "sits". Since we added those commands to our train object, the `.obj` property will be set to the train object. Conversely, `accessing_obj` is the object that called the command: in our case it's the Character trying to enter or leave the train. What this function does is to check that the player's location is the same as the train object. If it is, it means the player is inside the train. Otherwise it means the player is somewhere else and @@ -226,33 +201,28 @@ user ignores lock functions. In order to use this functionality you need to `@qu Now that we can enter and leave the train correctly, it's time to make it move. There are different things we need to consider for this: -* Who can control your vehicle? The first player to enter it, only players that have a certain -"drive" skill, automatically? -* Where should it go? Can the player steer the vehicle to go somewhere else or will it always follow -the same route? +* Who can control your vehicle? The first player to enter it, only players that have a certain "drive" skill, automatically? +* Where should it go? Can the player steer the vehicle to go somewhere else or will it always follow the same route? -For our example train we're going to go with automatic movement through a predefined route (its -track). The train will stop for a bit at the start and end of the route to allow players to enter -and leave it. +For our example train we're going to go with automatic movement through a predefined route (its track). The train will stop for a bit at the start and end of the route to allow players to enter and leave it. -Go ahead and create some rooms for our train. Make a list of the room ids along the route (using the -`@ex` command). +Go ahead and create some rooms for our train. Make a list of the room ids along the route (using the `xe` command). ``` -@dig/tel South station -@ex # note the id of the station -@tunnel/tel n = Following a railroad -@ex # note the id of the track -@tunnel/tel n = Following a railroad -... -@tunnel/tel n = North Station +> dig/tel South station +> ex # note the id of the station +> tunnel/tel n = Following a railroad +> ex # note the id of the track +> tunnel/tel n = Following a railroad +> ... +> tunnel/tel n = North Station ``` Put the train onto the tracks: ``` -@tel south station -@tel train = here +tel south station +tel train = here ``` Next we will tell the train how to move and which route to take. @@ -296,31 +266,27 @@ class TrainObject(DefaultObject): self.msg_contents(f"The train is moving forward to {room.name}.") ``` -We added a lot of code here. Since we changed the `at_object_creation` to add in variables we will -have to reset our train object like earlier (using the `@typeclass/force/reset` command). +We added a lot of code here. Since we changed the `at_object_creation` to add in variables we will have to reset our train object like earlier (using the `@typeclass/force/reset` command). We are keeping track of a few different things now: whether the train is moving or standing still, which direction the train is heading to and what rooms the train will pass through. -We also added some methods: one to start moving the train, another to stop and a third that actually -moves the train to the next room in the list. Or makes it stop driving if it reaches the last stop. +We also added some methods: one to start moving the train, another to stop and a third that actually moves the train to the next room in the list. Or makes it stop driving if it reaches the last stop. -Let's try it out, using `@py` to call the new train functionality: +Let's try it out, using `py` to call the new train functionality: ``` -@reload -@typeclass/force/reset train = train.TrainObject -enter train -@py here.goto_next_room() +> reload +> typeclass/force/reset train = train.TrainObject +> enter train +> py here.goto_next_room() ``` You should see the train moving forward one step along the rail road. ## Adding in scripts -If we wanted full control of the train we could now just add a command to step it along the track -when desired. We want the train to move on its own though, without us having to force it by manually -calling the `goto_next_room` method. +If we wanted full control of the train we could now just add a command to step it along the track when desired. We want the train to move on its own though, without us having to force it by manually calling the `goto_next_room` method. To do this we will create two [scripts](../Components/Scripts.md): one script that runs when the train has stopped at a station and is responsible for starting the train again after a while. The other script will take @@ -389,9 +355,9 @@ class TrainObject(DefaultObject): ``` ``` -@reload -@typeclass/force/reset train = train.TrainObject -enter train +> reload +> typeclass/force/reset train = train.TrainObject +> enter train # output: < The train is moving forward to Following a railroad. @@ -411,12 +377,8 @@ Our train will stop 30 seconds at each end station and then turn around to go ba This train is very basic and still has some flaws. Some more things to do: * Make it look like a train. -* Make it impossible to exit and enter the train mid-ride. This could be made by having the -enter/exit commands check so the train is not moving before allowing the caller to proceed. +* Make it impossible to exit and enter the train mid-ride. This could be made by having the enter/exit commands check so the train is not moving before allowing the caller to proceed. * Have train conductor commands that can override the automatic start/stop. * Allow for in-between stops between the start- and end station -* Have a rail road track instead of hard-coding the rooms in the train object. This could for -example be a custom [Exit](../Components/Objects.md#exits) only traversable by trains. The train will follow the -track. Some track segments can split to lead to two different rooms and a player can switch the -direction to which room it goes. +* Have a rail road track instead of hard-coding the rooms in the train object. This could for example be a custom [Exit](../Components/Objects.md#exits) only traversable by trains. The train will follow the track. Some track segments can split to lead to two different rooms and a player can switch the direction to which room it goes. * Create another kind of vehicle! \ No newline at end of file diff --git a/docs/1.0-dev/_sources/Howtos/Tutorial-Coordinates.md.txt b/docs/1.0-dev/_sources/Howtos/Tutorial-Coordinates.md.txt index 5825a1a3fd..1cda9a2597 100644 --- a/docs/1.0-dev/_sources/Howtos/Tutorial-Coordinates.md.txt +++ b/docs/1.0-dev/_sources/Howtos/Tutorial-Coordinates.md.txt @@ -1,15 +1,11 @@ -# Coordinates +# Adding room coordinates to your game -# Adding room coordinates in your game +```{sidebar} The XYZGrid +See also the [XYZGrid contrib](../Contribs/Contrib-XYZGrid.md), which adds coordinate support and pathfinding. +``` +This tutorial is moderately difficult in content. You might want to be familiar and at ease with some Python concepts (like properties) and possibly Django concepts (like queries), although this tutorial will try to walk you through the process and give enough explanations each time. If you don't feel very confident with math, don't hesitate to pause, go to the example section, which shows a tiny map, and try to walk around the code or read the explanation. -This tutorial is moderately difficult in content. You might want to be familiar and at ease with -some Python concepts (like properties) and possibly Django concepts (like queries), although this -tutorial will try to walk you through the process and give enough explanations each time. If you -don't feel very confident with math, don't hesitate to pause, go to the example section, which shows -a tiny map, and try to walk around the code or read the explanation. - -Evennia doesn't have a coordinate system by default. Rooms and other objects are linked by location -and content: +Evennia doesn't have a coordinate system by default. Rooms and other objects are linked by location and content: - An object can be in a location, that is, another object. Like an exit in a room. - An object can access its content. A room can see what objects uses it as location (that would @@ -25,14 +21,9 @@ instance. The first concept might be the most surprising at first glance: we will create coordinates as [tags](../Components/Tags.md). -> Why not attributes, wouldn't that be easier? +So, why not attributes, wouldn't that be easier? It would. We could just do something like `room.db.x = 3`. The advantage of using tags is that it will be easy and effective to search. Although this might not seem like a huge advantage right now, with a database of thousands of rooms, it might make a difference, particularly if you have a lot of things based on coordinates. -It would. We could just do something like `room.db.x = 3`. The advantage of using tags is that it -will be easy and effective to search. Although this might not seem like a huge advantage right now, -with a database of thousands of rooms, it might make a difference, particularly if you have a lot of -things based on coordinates. - -Rather than giving you a step-by-step process, I'll show you the code. Notice that we use +Rather than giving you a step-by-step process, We'll show you the code. Notice that we use properties to easily access and update coordinates. This is a Pythonic approach. Here's our first `Room` class, that you can modify in `typeclasses/rooms.py`: @@ -120,11 +111,7 @@ What it does is pretty simple: 2. We convert the value to an integer, if it's a `str`. Remember that tags can only contain `str`, so we'll need to convert it. -> I thought tags couldn't contain values? - -Well, technically, they can't: they're either here or not. But using tag categories, as we have -done, we get a tag, knowing only its category. That's the basic approach to coordinates in this -tutorial. +So can Tags contain values? Well, technically, they can't: they're either here or not. But using tag categories, as we have done, we get a tag, knowing only its category. That's the basic approach to coordinates in this tutorial. Now, let's look at the method that will be called when we wish to set `x` in our room: @@ -143,21 +130,17 @@ Now, let's look at the method that will be called when we wish to set `x` in our room with "coordx" as their category, which wouldn't do at all. 2. Then we add the new tag, giving it the proper category. -> Now what? - If you add this code and reload your game, once you're logged in with a character in a room as its location, you can play around: ``` -@py here.x -@py here.x = 0 -@py here.y = 3 -@py here.z = -2 -@py here.z = None +py here.x +py here.x = 0 +py here.y = 3 +py here.z = -2 +py here.z = None ``` -The code might not be that easy to read, but you have to admit it's fairly easy to use. - ## Some additional searches Having coordinates is useful for several reasons: @@ -203,24 +186,19 @@ class Room(DefaultRoom): return None ``` -This solution includes a bit of [Django -queries](https://docs.djangoproject.com/en/1.11/topics/db/queries/). -Basically, what we do is reach for the object manager and search for objects with the matching tags. -Again, don't spend too much time worrying about the mechanism, the method is quite easy to use: +This solution includes some [Django queries](Basic-Tutorial-Django-queries). Basically, what we do is reach for the object manager and search for objects with the matching tags. Again, don't spend too much time worrying about the mechanism, the method is quite easy to use: ``` Room.get_room_at(5, 2, -3) ``` -Notice that this is a class method: you will call it from `Room` (the class), not an instance. -Though you still can: +Notice that this is a class method: you will call it from `Room` (the class), not an instance. Though you still can: - @py here.get_room_at(3, 8, 0) + py here.get_room_at(3, 8, 0) ### Finding several rooms -Here's another useful method that allows us to look for rooms around a given coordinate. This is -more advanced search and doing some calculation, beware! Look at the following section if you're +Here's another useful method that allows us to look for rooms around a given coordinate. This is more advanced search and doing some calculation, beware! Look at the following section if you're lost. ```python @@ -286,9 +264,7 @@ This gets more serious. 1. We have specified coordinates as parameters. We determine a broad range using the distance. That is, for each coordinate, we create a list of possible matches. See the example below. -2. We then search for the rooms within this broader range. It gives us a square - around our location. Some rooms are definitely outside the range. Again, see the example below -to follow the logic. +2. We then search for the rooms within this broader range. It gives us a square around our location. Some rooms are definitely outside the range. Again, see the example below to follow the logic. 3. We filter down the list and sort it by distance from the specified coordinates. Notice that we only search starting at step 2. Thus, the Django search doesn't look and cache all @@ -309,11 +285,7 @@ An example might help. Consider this very simple map (a textual description fol 1 2 3 4 ``` -The X coordinates are given below. The Y coordinates are given on the left. This is a simple -square with 16 rooms: 4 on each line, 4 lines of them. All the rooms are identified by letters in -this example: the first line at the top has rooms A to D, the second E to H, the third I to L and -the fourth M to P. The bottom-left room, X=1 and Y=1, is M. The upper-right room X=4 and Y=4 is D. - +The X coordinates are given below. The Y coordinates are given on the left. This is a simple square with 16 rooms: 4 on each line, 4 lines of them. All the rooms are identified by letters in this example: the first line at the top has rooms A to D, the second E to H, the third I to L and the fourth M to P. The bottom-left room, X=1 and Y=1, is M. The upper-right room X=4 and Y=4 is D. So let's say we want to find all the neighbors, distance 1, from the room J. J is at X=2, Y=2. So we use: @@ -321,13 +293,8 @@ So we use: Room.get_rooms_around(x=2, y=2, z=0, distance=1) # we'll assume a z coordinate of 0 for simplicity -1. First, this method gets all the rooms in a square around J. So it gets E F G, I J K, M N O. If -you want, draw the square around these coordinates to see what's happening. -2. Next, we browse over this list and check the real distance between J (X=2, Y=2) and the room. -The four corners of the square are not in this circle. For instance, the distance between J and M -is not 1. If you draw a circle of center J and radius 1, you'll notice that the four corners of our -square (E, G, M and O) are not in this circle. So we remove them. -3. We sort by distance from J. +1. First, this method gets all the rooms in a square around J. So it gets E F G, I J K, M N O. If you want, draw the square around these coordinates to see what's happening. +2. Next, we browse over this list and check the real distance between J (X=2, Y=2) and the room. The four corners of the square are not in this circle. For instance, the distance between J and M is not 1. If you draw a circle of center J and radius 1, you'll notice that the four corners of our square (E, G, M and O) are not in this circle. So we remove them. 3. We sort by distance from J. So in the end we might obtain something like this: @@ -343,7 +310,7 @@ So in the end we might obtain something like this: You can try with more examples if you want to see this in action. -### To conclude +## To conclude -You can definitely use this system to map other objects, not just rooms. You can easily remove the -`Z coordinate too, if you simply need X and Y. \ No newline at end of file +You can also use this system to map other objects, not just rooms. You can easily remove the +`Z` coordinate too, if you simply need `X` and `Y`. \ No newline at end of file diff --git a/docs/1.0-dev/_sources/Howtos/Dynamic-In-Game-Map.md.txt b/docs/1.0-dev/_sources/Howtos/Tutorial-Displaying-Room-Map.md.txt similarity index 71% rename from docs/1.0-dev/_sources/Howtos/Dynamic-In-Game-Map.md.txt rename to docs/1.0-dev/_sources/Howtos/Tutorial-Displaying-Room-Map.md.txt index ebd59cdd44..7a0390f629 100644 --- a/docs/1.0-dev/_sources/Howtos/Dynamic-In-Game-Map.md.txt +++ b/docs/1.0-dev/_sources/Howtos/Tutorial-Displaying-Room-Map.md.txt @@ -1,53 +1,44 @@ -# Dynamic In Game Map +# Show a dynamic map of rooms -## Introduction +```{sidebar} +See also the [Mapbuilder](../Contribs/Contrib-Mapbuilder.md) and [XYZGrid](../Contribs/Contrib-XYZGrid.md) contribs, which offer alternative ways of both creating and displaying room maps. +``` +An often desired feature in a MUD is to show an in-game map to help navigation. -An often desired feature in a MUD is to show an in-game map to help navigation. The [Static in-game -map](../Contribs/Contrib-Mapbuilder.md) tutorial solves this by creating a *static* map, meaning the map is pre- -drawn once and for all - the rooms are then created to match that map. When walking around, parts of -the static map is then cut out and displayed next to the room description. +``` +Forest path -In this tutorial we'll instead do it the other way around; We will dynamically draw the map based on -the relationships we find between already existing rooms. + [.] [.] +[.][.][@][.][.][.] + [.] [.][.][.] + +The trees are looming over the narrow forest path. + +Exits: East, West +``` ## The Grid of Rooms There are at least two requirements needed for this tutorial to work. -1. The structure of your mud has to follow a logical layout. Evennia supports the layout of your -world to be 'logically' impossible with rooms looping to themselves or exits leading to the other -side of the map. Exits can also be named anything, from "jumping out the window" to "into the fifth -dimension". This tutorial assumes you can only move in the cardinal directions (N, E, S and W). -2. Rooms must be connected and linked together for the map to be generated correctly. Vanilla -Evennia comes with a admin command [tunnel](evennia.commands.default.building.CmdTunnel) that allows a -user to create rooms in the cardinal directions, but additional work is needed to assure that rooms -are connected. For example, if you `tunnel east` and then immediately do `tunnel west` you'll find -that you have created two completely stand-alone rooms. So care is needed if you want to create a -"logical" layout. In this tutorial we assume you have such a grid of rooms that we can generate the -map from. +1. The structure of your mud has to follow a logical layout. Evennia supports the layout of your world to be 'logically' impossible with rooms looping to themselves or exits leading to the other side of the map. Exits can also be named anything, from "jumping out the window" to "into the fifth dimension". This tutorial assumes you can only move in the cardinal directions (N, E, S and W). +2. Rooms must be connected and linked together for the map to be generated correctly. Vanilla Evennia comes with a admin command [tunnel](evennia.commands.default.building.CmdTunnel) that allows a user to create rooms in the cardinal directions, but additional work is needed to assure that rooms are connected. For example, if you `tunnel east` and then immediately do `tunnel west` you'll find that you have created two completely stand-alone rooms. So care is needed if you want to create a "logical" layout. In this tutorial we assume you have such a grid of rooms that we can generate the map from. ## Concept -Before getting into the code, it is beneficial to understand and conceptualize how this is going to -work. The idea is analogous to a worm that starts at your current position. It chooses a direction -and 'walks' outward from it, mapping its route as it goes. Once it has traveled a pre-set distance -it stops and starts over in another direction. An important note is that we want a system which is -easily callable and not too complicated. Therefore we will wrap this entire code into a custom -Python class (not a typeclass as this doesn't use any core objects from evennia itself). - -We are going to create something that displays like this when you type 'look': +Before getting into the code, it is beneficial to understand and conceptualize how this is going to work. The idea is analogous to a worm that starts at your current position. It chooses a direction and 'walks' outward from it, mapping its route as it goes. Once it has traveled a pre-set distance it stops and starts over in another direction. An important note is that we want a system which is easily callable and not too complicated. Therefore we will wrap this entire code into a custom Python class (not a typeclass as this doesn't use any core objects from evennia itself). We are going to create something that displays like this when you type 'look': ``` - Hallway +Hallway - [.] [.] - [@][.][.][.][.] - [.] [.] [.] + [.] [.] + [@][.][.][.][.] + [.] [.] [.] - The distant echoes of the forgotten - wail throughout the empty halls. +The distant echoes of the forgotten +wail throughout the empty halls. - Exits: North, East, South +Exits: North, East, South ``` Your current location is defined by `[@]` while the `[.]`s are other rooms that the "worm" has seen @@ -55,12 +46,7 @@ since departing from your location. ## Setting up the Map Display -First we must define the components for displaying the map. For the "worm" to know what symbol to -draw on the map we will have it check an Attribute on the room it visits called `sector_type`. For -this tutorial we understand two symbols - a normal room and the room with us in it. We also define a -fallback symbol for rooms without said Attribute - that way the map will still work even if we -didn't prepare the room correctly. Assuming your game folder is named `mygame`, we create this code -in `mygame/world/map.py.` +First we must define the components for displaying the map. For the "worm" to know what symbol to draw on the map we will have it check an Attribute on the room it visits called `sector_type`. For this tutorial we understand two symbols - a normal room and the room with us in it. We also define a fallback symbol for rooms without said Attribute - that way the map will still work even if we didn't prepare the room correctly. Assuming your game folder is named `mygame`, we create this code in `mygame/world/map.py.` ```python # in mygame/world/map.py @@ -91,18 +77,11 @@ class Map(object): ``` - `self.caller` is normally your Character object, the one using the map. -- `self.max_width/length` determine the max width and length of the map that will be generated. Note -that it's important that these variables are set to *odd* numbers to make sure the display area has -a center point. -- ` self.worm_has_mapped` is building off the worm analogy above. This dictionary will store all -rooms the "worm" has mapped as well as its relative position within the grid. This is the most -important variable as it acts as a 'checker' and 'address book' that is able to tell us where the -worm has been and what it has mapped so far. +- `self.max_width/length` determine the max width and length of the map that will be generated. Note that it's important that these variables are set to *odd* numbers to make sure the display area has a center point. +- ` self.worm_has_mapped` is building off the worm analogy above. This dictionary will store all rooms the "worm" has mapped as well as its relative position within the grid. This is the most important variable as it acts as a 'checker' and 'address book' that is able to tell us where the worm has been and what it has mapped so far. - `self.curX/Y` are coordinates representing the worm's current location on the grid. - -Before any sort of mapping can actually be done we need to create an empty display area and do some -sanity checks on it by using the following methods. + Before any sort of mapping can actually be done we need to create an empty display area and do some sanity checks on it by using the following methods. ```python # in mygame/world/map.py @@ -127,8 +106,7 @@ class Map(object): else False ``` -Before we can set our worm on its way, we need to know some of the computer science behind all this -called 'Graph Traversing'. In Pseudo code what we are trying to accomplish is this: +Before we can set our worm on its way, we need to know some of the computer science behind all this called 'Graph Traversing'. In Pseudo code what we are trying to accomplish is this: ```python # pseudo code @@ -151,13 +129,9 @@ def draw_room_on_map(room, max_distance): The beauty of Python is that our actual code of doing this doesn't differ much if at all from this Pseudo code example. -- `max_distance` is a variable indicating to our Worm how many rooms AWAY from your current location -will it map. Obviously the larger the number the more time it will take if your current location has -many many rooms around you. +- `max_distance` is a variable indicating to our Worm how many rooms AWAY from your current location will it map. Obviously the larger the number the more time it will take if your current location has many many rooms around you. -The first hurdle here is what value to use for 'max_distance'. There is no reason for the worm to -travel further than what is actually displayed to you. For example, if your current location is -placed in the center of a display area of size `max_length = max_width = 9`, then the worm need only +The first hurdle here is what value to use for 'max_distance'. There is no reason for the worm to travel further than what is actually displayed to you. For example, if your current location is placed in the center of a display area of size `max_length = max_width = 9`, then the worm need only go `4` spaces in either direction: ``` @@ -165,24 +139,17 @@ go `4` spaces in either direction: 4 3 2 1 0 1 2 3 4 ``` -The `max_distance` can be set dynamically based on the size of the display area. As your width/length -changes it becomes a simple algebraic linear relationship which is simply `max_distance = -(min(max_width, max_length) -1) / 2`. +The `max_distance` can be set dynamically based on the size of the display area. As your width/length changes it becomes a simple algebraic linear relationship which is simply `max_distance = (min(max_width, max_length) -1) / 2`. ## Building the Mapper -Now we can start to fill our Map object with some methods. We are still missing a few methods that -are very important: +Now we can start to fill our Map object with some methods. We are still missing a few methods that are very important: * `self.draw(self, room)` - responsible for actually drawing room to grid. -* `self.has_drawn(self, room)` - checks to see if the room has been mapped and worm has already been -here. -* `self.median(self, number)` - a simple utility method that finds the median (middle point) from 0, -n -* `self.update_pos(self, room, exit_name)` - updates the worm's physical position by reassigning -self.curX/Y. .accordingly -* `self.start_loc_on_grid(self)` - the very first initial draw on the grid representing your -location in the middle of the grid +* `self.has_drawn(self, room)` - checks to see if the room has been mapped and worm has already been here. +* `self.median(self, number)` - a simple utility method that finds the median (middle point) from `0, n` +* `self.update_pos(self, room, exit_name)` - updates the worm's physical position by reassigning `self.curX/Y` accordingly. +* `self.start_loc_on_grid(self)` - the very first initial draw on the grid representing your location in the middle of the grid. * `self.show_map` - after everything is done convert the map into a readable string * `self.draw_room_on_map(self, room, max_distance)` - the main method that ties it all together. @@ -190,7 +157,6 @@ location in the middle of the grid Now that we know which methods we need, let's refine our initial `__init__(self)` to pass some conditional statements and set it up to start building the display. - ```python #mygame/world/map.py @@ -213,11 +179,9 @@ class Map(object): ``` -Here we check to see if the parameters for the grid are okay, then we create an empty canvas and map -our initial location as the first room! +Here we check to see if the parameters for the grid are okay, then we create an empty canvas and map our initial location as the first room! -As mentioned above, the code for the `self.draw_room_on_map()` is not much different than the Pseudo -code. The method is shown below: +As mentioned above, the code for the `self.draw_room_on_map()` is not much different than the Pseudo code. The method is shown below: ```python # in mygame/world/map.py, in the Map class @@ -352,24 +316,11 @@ class Room(DefaultRoom): return string ``` -Obviously this method of generating maps doesn't take into account of any doors or exits that are -hidden.. etc.. but hopefully it serves as a good base to start with. Like previously mentioned, it -is very important to have a solid foundation on rooms before implementing this. You can try this on -vanilla evennia by using @tunnel and essentially you can just create a long straight/edgy non- -looping rooms that will show on your in-game map. +Obviously this method of generating maps doesn't take into account of any doors or exits that are hidden.. etc.. but hopefully it serves as a good base to start with. Like previously mentioned, it is very important to have a solid foundation on rooms before implementing this. You can try this on vanilla evennia by using @tunnel and essentially you can just create a long straight/edgy non- looping rooms that will show on your in-game map. -The above example will display the map above the room description. You could also use an -[EvTable](github:evennia.utils.evtable) to place description and map next to each other. Some other -things you can do is to have a [Command](../Components/Commands.md) that displays with a larger radius, maybe with a -legend and other features. +The above example will display the map above the room description. You could also use an [EvTable](github:evennia.utils.evtable) to place description and map next to each other. Some other things you can do is to have a [Command](../Components/Commands.md) that displays with a larger radius, maybe with a legend and other features. -Below is the whole `map.py` for your reference. You need to update your `Room` typeclass (see above) -to actually call it. Remember that to see different symbols for a location you also need to set the -`sector_type` Attribute on the room to one of the keys in the `SYMBOLS` dictionary. So in this -example, to make a room be mapped as `[.]` you would set the room's `sector_type` to -`"SECT_INSIDE"`. Try it out with `@set here/sector_type = "SECT_INSIDE"`. If you wanted all new -rooms to have a given sector symbol, you could change the default in the `SYMBOLS` dictionary below, -or you could add the Attribute in the Room's `at_object_creation` method. +Below is the whole `map.py` for your reference. You need to update your `Room` typeclass (see above) to actually call it. Remember that to see different symbols for a location you also need to set the `sector_type` Attribute on the room to one of the keys in the `SYMBOLS` dictionary. So in this example, to make a room be mapped as `[.]` you would set the room's `sector_type` to `"SECT_INSIDE"`. Try it out with `@set here/sector_type = "SECT_INSIDE"`. If you wanted all new rooms to have a given sector symbol, you could change the default in the `SYMBOLS` dictionary below, or you could add the Attribute in the Room's `at_object_creation` method. ```python # mygame/world/map.py diff --git a/docs/1.0-dev/_sources/Howtos/Parsing-commands-tutorial.md.txt b/docs/1.0-dev/_sources/Howtos/Tutorial-Parsing-Commands.md.txt similarity index 99% rename from docs/1.0-dev/_sources/Howtos/Parsing-commands-tutorial.md.txt rename to docs/1.0-dev/_sources/Howtos/Tutorial-Parsing-Commands.md.txt index c400de09ac..d374b54e8a 100644 --- a/docs/1.0-dev/_sources/Howtos/Parsing-commands-tutorial.md.txt +++ b/docs/1.0-dev/_sources/Howtos/Tutorial-Parsing-Commands.md.txt @@ -43,8 +43,7 @@ command for every kind of word or sentence, which is, of course, not practical. Last thing: what is parsing? -> In our case, parsing is the process by which we convert command arguments into something we can -work with. +> In our case, parsing is the process by which we convert command arguments into something we can work with. We don't usually use the command argument as is (which is just text, of type `str` in Python). We need to extract useful information. We might want to ask the user for a number, or the name of diff --git a/docs/1.0-dev/_sources/Howtos/Tutorial-Tweeting-Game-Stats.md.txt b/docs/1.0-dev/_sources/Howtos/Tutorial-Tweeting-Game-Stats.md.txt deleted file mode 100644 index 4baaba4c1c..0000000000 --- a/docs/1.0-dev/_sources/Howtos/Tutorial-Tweeting-Game-Stats.md.txt +++ /dev/null @@ -1,96 +0,0 @@ -# Tutorial Tweeting Game Stats - - -This tutorial will create a simple script that will send a tweet to your already configured twitter -account. Please see: [How to connect Evennia to Twitter](../Setup/Channels-to-Twitter.md) if you -haven't already done so. - -The script could be expanded to cover a variety of statistics you might wish to tweet about -regularly, from player deaths to how much currency is in the economy etc. - -```python -# evennia/typeclasses/tweet_stats.py - -import twitter -from random import randint -from django.conf import settings -from evennia import ObjectDB -from evennia import spawner -from evennia import logger -from evennia import DefaultScript - -class TweetStats(DefaultScript): - """ - This implements the tweeting of stats to a registered twitter account - """ - - # standard Script hooks - - def at_script_creation(self): - "Called when script is first created" - - self.key = "tweet_stats" - self.desc = "Tweets interesting stats about the game" - self.interval = 86400 # 1 day timeout - self.start_delay = False - - def at_repeat(self): - """ - This is called every self.interval seconds to tweet interesting stats about the game. - """ - - api = twitter.Api(consumer_key='consumer_key', - consumer_secret='consumer_secret', - access_token_key='access_token_key', - access_token_secret='access_token_secret') - - number_tweet_outputs = 2 - - tweet_output = randint(1, number_tweet_outputs) - - if tweet_output == 1: - ##Game Chars, Rooms, Objects taken from @stats command - nobjs = ObjectDB.objects.count() - base_char_typeclass = settings.BASE_CHARACTER_TYPECLASS - nchars = ObjectDB.objects.filter(db_typeclass_path=base_char_typeclass).count() - nrooms = -ObjectDB.objects.filter(db_location__isnull=True).exclude(db_typeclass_path=base_char_typeclass).count() - nexits = ObjectDB.objects.filter(db_location__isnull=False, -db_destination__isnull=False).count() - nother = nobjs - nchars - nrooms - nexits - tweet = "Chars: %s, Rooms: %s, Objects: %s" %(nchars, nrooms, nother) - else: - if tweet_output == 2: ##Number of prototypes and 3 random keys - taken from @spawn -command - prototypes = spawner.spawn(return_prototypes=True) - - keys = prototypes.keys() - nprots = len(prototypes) - tweet = f"Prototype Count: {nprots} Random Keys: " - - tweet += f" {keys[randint(0,len(keys)-1)]}" - for x in range(0,2): ##tweet 3 - tweet += f", {keys[randint(0,len(keys)-1)]}" - # post the tweet - try: - response = api.PostUpdate(tweet) - except: - logger.log_trace(f"Tweet Error: When attempting to tweet {tweet}") -``` - -In the `at_script_creation` method, we configure the script to fire immediately (useful for testing) -and setup the delay (1 day) as well as script information seen when you use `@scripts` - -In the `at_repeat` method (which is called immediately and then at interval seconds later) we setup -the Twitter API (just like in the initial configuration of twitter). numberTweetOutputs is used to -show how many different types of outputs we have (in this case 2). We then build the tweet based on -randomly choosing between these outputs. - -1. Shows the number of Player Characters, Rooms and Other/Objects -2. Shows the number of prototypes currently in the game and then selects 3 random keys to show - -[Scripts Information](../Components/Scripts.md) will show you how to add it as a Global script, however, for testing -it may be useful to start/stop it quickly from within the game. Assuming that you create the file -as `mygame/typeclasses/tweet_stats.py` it can be started by using the following command - - @script Here = tweet_stats.TweetStats \ No newline at end of file diff --git a/docs/1.0-dev/_sources/Howtos/Arxcode-Installation.md.txt b/docs/1.0-dev/_sources/Howtos/Tutorial-Using-Arxcode.md.txt similarity index 99% rename from docs/1.0-dev/_sources/Howtos/Arxcode-Installation.md.txt rename to docs/1.0-dev/_sources/Howtos/Tutorial-Using-Arxcode.md.txt index 5720b6e295..90cc4afd8a 100644 --- a/docs/1.0-dev/_sources/Howtos/Arxcode-Installation.md.txt +++ b/docs/1.0-dev/_sources/Howtos/Tutorial-Using-Arxcode.md.txt @@ -1,4 +1,4 @@ -# Arxcode installing help +# Using the Arxcode game dir ```{warning} Arxcode is separately maintained. diff --git a/docs/1.0-dev/_sources/Howtos/Weather-Tutorial.md.txt b/docs/1.0-dev/_sources/Howtos/Tutorial-Weather-Effects.md.txt similarity index 62% rename from docs/1.0-dev/_sources/Howtos/Weather-Tutorial.md.txt rename to docs/1.0-dev/_sources/Howtos/Tutorial-Weather-Effects.md.txt index e426e5dadc..560a5ab019 100644 --- a/docs/1.0-dev/_sources/Howtos/Weather-Tutorial.md.txt +++ b/docs/1.0-dev/_sources/Howtos/Tutorial-Weather-Effects.md.txt @@ -1,24 +1,19 @@ -# Weather Tutorial +# Adding Weather messages to a Room -This tutorial will have us create a simple weather system for our MUD. The way we want to use this -is to have all outdoor rooms echo weather-related messages to the room at regular and semi-random -intervals. Things like "Clouds gather above", "It starts to rain" and so on. +This tutorial will have us create a simple weather system for our MUD. The way we want to use this is to have all outdoor rooms echo weather-related messages to the room at regular and semi-random intervals. Things like "Clouds gather above", "It starts to rain" and so on. -One could imagine every outdoor room in the game having a script running on themselves that fires -regularly. For this particular example it is however more efficient to do it another way, namely by -using a "ticker-subscription" model. The principle is simple: Instead of having each Object -individually track the time, they instead subscribe to be called by a global ticker who handles time -keeping. Not only does this centralize and organize much of the code in one place, it also has less -computing overhead. +One could imagine every outdoor room in the game having a script running on themselves that fires regularly. For this particular example it is however more efficient to do it another way, namely by using a "ticker-subscription" model. -Evennia offers the [TickerHandler](../Components/TickerHandler.md) specifically for using the subscription model. We -will use it for our weather system. +The principle is simple: Instead of having each Object individually track the time, they instead subscribe to be called by a global ticker who handles time keeping. Not only does this centralize and organize much of the code in one place, it also has less computing overhead. + +Evennia's [TickerHandler](../Components/TickerHandler.md) specifically offers such a subscription model. We will use it for our weather system. -We will assume you know how to make your own Typeclasses. If not see one of the beginning tutorials. We will create a new WeatherRoom typeclass that is aware of the day-night cycle. -```python +```{code-block} python +:linenos: +:emphasize-lines: import random from evennia import DefaultRoom, TICKER_HANDLER @@ -42,6 +37,8 @@ We will create a new WeatherRoom typeclass that is aware of the day-night cycle. self.msg_contents(echo) ``` + + In the `at_object_creation` method, we simply added ourselves to the TickerHandler and tell it to call `at_weather_update` every hour (`60*60` seconds). During testing you might want to play with a shorter time duration. diff --git a/docs/1.0-dev/_sources/Howtos/Tutorial-for-basic-MUSH-like-game.md.txt b/docs/1.0-dev/_sources/Howtos/Tutorial-for-basic-MUSH-like-game.md.txt index 61069ede67..a7121be42d 100644 --- a/docs/1.0-dev/_sources/Howtos/Tutorial-for-basic-MUSH-like-game.md.txt +++ b/docs/1.0-dev/_sources/Howtos/Tutorial-for-basic-MUSH-like-game.md.txt @@ -7,7 +7,7 @@ focused on free form storytelling. Even if you are not interested in MUSH:es, th first game-type to try since it's not so code heavy. You will be able to use the same principles for building other types of games. -The tutorial starts from scratch. If you did the [First Steps Coding](Beginner-Tutorial/Part1/Beginner-Tutorial-Part1-Intro.md) tutorial +The tutorial starts from scratch. If you did the [First Steps Coding](Beginner-Tutorial/Part1/Beginner-Tutorial-Part1-Overview.md) tutorial already you should have some ideas about how to do some of the steps already. The following are the (very simplistic and cut-down) features we will implement (this was taken from diff --git a/docs/1.0-dev/_sources/Howtos/Web-Add-a-wiki.md.txt b/docs/1.0-dev/_sources/Howtos/Web-Add-a-wiki.md.txt index 6ec97a9ffc..b547f3d73c 100644 --- a/docs/1.0-dev/_sources/Howtos/Web-Add-a-wiki.md.txt +++ b/docs/1.0-dev/_sources/Howtos/Web-Add-a-wiki.md.txt @@ -1,7 +1,7 @@ # Add a wiki on your website **Before doing this tutorial you will probably want to read the intro in -[Basic Web tutorial](Beginner-Tutorial/Part5/Web-Tutorial.md).** Reading the three first parts of the +[Basic Web tutorial](./Web-Changing-Webpage.md).** Reading the three first parts of the [Django tutorial](https://docs.djangoproject.com/en/1.9/intro/tutorial01/) might help as well. This tutorial will provide a step-by-step process to installing a wiki on your website. diff --git a/docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part5/Web-Tutorial.md.txt b/docs/1.0-dev/_sources/Howtos/Web-Changing-Webpage.md.txt similarity index 57% rename from docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part5/Web-Tutorial.md.txt rename to docs/1.0-dev/_sources/Howtos/Web-Changing-Webpage.md.txt index 34f62b9f08..d8741641f1 100644 --- a/docs/1.0-dev/_sources/Howtos/Beginner-Tutorial/Part5/Web-Tutorial.md.txt +++ b/docs/1.0-dev/_sources/Howtos/Web-Changing-Webpage.md.txt @@ -1,31 +1,17 @@ -# Web Tutorial +# Changing the Game Website -Evennia uses the [Django](https://www.djangoproject.com/) web framework as the basis of both its -database configuration and the website it provides. While a full understanding of Django requires -reading the Django documentation, we have provided this tutorial to get you running with the basics -and how they pertain to Evennia. This text details getting everything set up. The -[Web-based Character view Tutorial](../../Web-Character-View-Tutorial.md) gives a more explicit example of making a -custom web page connected to your game, and you may want to read that after finishing this guide. +Evennia uses the [Django](https://www.djangoproject.com/) web framework as the basis of both its database configuration and the website it provides. While a full understanding of Django requires reading the Django documentation, we have provided this tutorial to get you running with the basics and how they pertain to Evennia. This text details getting everything set up. The [Web-based Character view Tutorial](./Web-Character-View-Tutorial.md) gives a more explicit example of making a custom web page connected to your game, and you may want to read that after finishing this guide. ## A Basic Overview -Django is a web framework. It gives you a set of development tools for building a website quickly -and easily. +Django is a web framework. It gives you a set of development tools for building a website quickly and easily. Django projects are split up into *apps* and these apps all contribute to one project. For instance, you might have an app for conducting polls, or an app for showing news posts or, like us, one for creating a web client. -Each of these applications has a `urls.py` file, which specifies what -[URL](https://en.wikipedia.org/wiki/Uniform_resource_locator)s are used by the app, a `views.py` file -for the code that the URLs activate, a `templates` directory for displaying the results of that code -in [HTML](https://en.wikipedia.org/wiki/Html) for the user, and a `static` folder that holds assets -like [CSS](https://en.wikipedia.org/wiki/CSS), [Javascript](https://en.wikipedia.org/wiki/Javascript), -and Image files (You may note your mygame/web folder does not have a `static` or `template` folder. -This is intended and explained further below). Django applications may also have a `models.py` file -for storing information in the database. We will not change any models here, take a look at the -[New Models](../../../Concepts/New-Models.md) page (as well as the [Django docs](https://docs.djangoproject.com/en/1.7/topics/db/models/) on models) if you are interested. +Each of these applications has a `urls.py` file, which specifies what [URL](https://en.wikipedia.org/wiki/Uniform_resource_locator)s are used by the app, a `views.py` file for the code that the URLs activate, a `templates` directory for displaying the results of that code in [HTML](https://en.wikipedia.org/wiki/Html) for the user, and a `static` folder that holds assets like [CSS](https://en.wikipedia.org/wiki/CSS), [Javascript](https://en.wikipedia.org/wiki/Javascript), and Image files (You may note your mygame/web folder does not have a `static` or `template` folder. This is intended and explained further below). Django applications may also have a `models.py` file for storing information in the database. We will not change any models here, take a look at the [New Models](../Concepts/New-Models.md) page (as well as the [Django docs](https://docs.djangoproject.com/en/1.7/topics/db/models/) on models) if you are interested. There is also a root `urls.py` that determines the URL structure for the entire project. A starter `urls.py` is included in the default game template, and automatically imports all of Evennia's @@ -80,32 +66,18 @@ evennia collectstatic to only update the static files without any other changes. -> **Note**: Evennia will collect static files automatically during startup. So if `evennia -collectstatic` reports finding 0 files to collect, make sure you didn't start the engine at some -point - if so the collector has already done its work! To make sure, connect to the website and -check so the logo has actually changed to your own version. +> Evennia will collect static files automatically during startup. So if `evennia collectstatic` reports finding 0 files to collect, make sure you didn't start the engine at some point - if so the collector has already done its work! To make sure, connect to the website and check so the logo has actually changed to your own version. -> **Note**: Sometimes the static asset collector can get confused. If no matter what you do, your -overridden files aren't getting copied over the defaults, try removing the target file (or -everything) in the `web/static` directory, and re-running `collectstatic` to gather everything from -scratch. +> Sometimes the static asset collector can get confused. If no matter what you do, your overridden files aren't getting copied over the defaults, try removing the target file (or everything) in the `web/static` directory, and re-running `collectstatic` to gather everything from scratch. ## Changing the Front Page's Text -The default front page for Evennia contains information about the Evennia project. You'll probably -want to replace this information with information about your own project. Changing the page template -is done in a similar way to changing static resources. +The default front page for Evennia contains information about the Evennia project. You'll probably want to replace this information with information about your own project. Changing the page template is done in a similar way to changing static resources. -Like static files, Django looks through a series of template folders to find the file it wants. The -difference is that Django does not copy all of the template files into one place, it just searches -through the template folders until it finds a template that matches what it's looking for. This -means that when you edit a template, the changes are instant. You don't have to reload the server or +Like static files, Django looks through a series of template folders to find the file it wants. The difference is that Django does not copy all of the template files into one place, it just searches through the template folders until it finds a template that matches what it's looking for. This means that when you edit a template, the changes are instant. You don't have to reload the server or run any extra commands to see these changes - reloading the web page in your browser is enough. -To replace the index page's text, we'll need to find the template for it. We'll go into more detail -about how to determine which template is used for rendering a page in the -[Web-based Character view Tutorial](../../Web-Character-View-Tutorial.md). For now, you should know that the template we want to change -is stored in `evennia/web/website/templates/website/index.html`. +To replace the index page's text, we'll need to find the template for it. We'll go into more detail about how to determine which template is used for rendering a page in the [Web-based Character view Tutorial](./Web-Character-View-Tutorial.md). For now, you should know that the template we want to change is stored in `evennia/web/website/templates/website/index.html`. To replace this template file, you will put your changed template inside the `web/template_overrides/website` directory in your game folder. In the same way as with static @@ -119,8 +91,4 @@ original file already has all the markup and tags, ready for editing. ## Further reading -For further hints on working with the web presence, you could now continue to the -[Web-based Character view Tutorial](../../Web-Character-View-Tutorial.md) where you learn to make a web page that -displays in-game character stats. You can also look at [Django's own -tutorial](https://docs.djangoproject.com/en/1.7/intro/tutorial01/) to get more insight in how Django -works and what possibilities exist. \ No newline at end of file +For further hints on working with the web presence, you could now continue to the [Web-based Character view Tutorial](./Web-Character-View-Tutorial.md) where you learn to make a web page that displays in-game character stats. You can also look at [Django's own tutorial](https://docs.djangoproject.com/en/1.7/intro/tutorial01/) to get more insight in how Django works and what possibilities exist. \ No newline at end of file diff --git a/docs/1.0-dev/_sources/Howtos/Web-Tweeting-Game-Stats.md.txt b/docs/1.0-dev/_sources/Howtos/Web-Tweeting-Game-Stats.md.txt new file mode 100644 index 0000000000..e12f2ddac5 --- /dev/null +++ b/docs/1.0-dev/_sources/Howtos/Web-Tweeting-Game-Stats.md.txt @@ -0,0 +1,86 @@ +# Automatically Tweet game stats + + +This tutorial will create a simple script that will send a tweet to your already configured twitter account. Please see: [How to connect Evennia to Twitter](../Setup/Channels-to-Twitter.md) if you haven't already done so. + +The script could be expanded to cover a variety of statistics you might wish to tweet about +regularly, from player deaths to how much currency is in the economy etc. + +```python +# evennia/typeclasses/tweet_stats.py + +import twitter +from random import randint +from django.conf import settings +from evennia import ObjectDB +from evennia.prototypes import prototypes +from evennia import logger +from evennia import DefaultScript + +class TweetStats(DefaultScript): + """ + This implements the tweeting of stats to a registered twitter account + """ + + # standard Script hooks + + def at_script_creation(self): + "Called when script is first created" + + self.key = "tweet_stats" + self.desc = "Tweets interesting stats about the game" + self.interval = 86400 # 1 day timeout + self.start_delay = False + + def at_repeat(self): + """ + This is called every self.interval seconds to + tweet interesting stats about the game. + """ + + api = twitter.Api(consumer_key='consumer_key', + consumer_secret='consumer_secret', + access_token_key='access_token_key', + access_token_secret='access_token_secret') + + # Game Chars, Rooms, Objects taken from `stats` command + nobjs = ObjectDB.objects.count() + base_char_typeclass = settings.BASE_CHARACTER_TYPECLASS + nchars = ( + ObjectDB.objects + .filter(db_typeclass_path=base_char_typeclass) + .count() + ) + nrooms =( + ObjectDB.objects + .filter(db_location__isnull=True) + .exclude(db_typeclass_path=base_char_typeclass) + .count() + ) + nexits = ( + ObjectDB.objects + .filter(db_location__isnull=False, + db_destination__isnull=False) + .count() + ) + nother = nobjs - nchars - nrooms - nexits + tweet = f"Chars: {ncars}, Rooms: {nrooms}, Objects: {nother}" + + # post the tweet + try: + response = api.PostUpdate(tweet) + except: + logger.log_trace(f"Tweet Error: When attempting to tweet {tweet}") +``` + +In the `at_script_creation` method, we configure the script to fire immediately (useful for testing) +and setup the delay (1 day) as well as script information seen when you use `@scripts` + +In the `at_repeat` method (which is called immediately and then at interval seconds later) we setup +the Twitter API (just like in the initial configuration of twitter). We then show the number of Player Characters, Rooms and Other/Objects. + +The [Scripts docs](../Components/Scripts.md) will show you how to add it as a Global script, however, for testing +it may be useful to start/stop it quickly from within the game. Assuming that you create the file +as `mygame/typeclasses/tweet_stats.py` it can be started by using the following command + + script Here = tweet_stats.TweetStats \ No newline at end of file diff --git a/docs/1.0-dev/_sources/Setup/Channels-to-Twitter.md.txt b/docs/1.0-dev/_sources/Setup/Channels-to-Twitter.md.txt index e3a9c2e75a..2f913abf7c 100644 --- a/docs/1.0-dev/_sources/Setup/Channels-to-Twitter.md.txt +++ b/docs/1.0-dev/_sources/Setup/Channels-to-Twitter.md.txt @@ -96,4 +96,4 @@ This shows only a basic tweet setup, other things to do could be: * Changing locks to make tweeting open to more people * Echo your tweets to an in-game channel -Rather than using an explicit command you can set up a Script to send automatic tweets, for example to post updated game stats. See the [Tweeting Game Stats tutorial](../Howtos/Tutorial-Tweeting-Game-Stats.md) for help. \ No newline at end of file +Rather than using an explicit command you can set up a Script to send automatic tweets, for example to post updated game stats. See the [Tweeting Game Stats tutorial](../Howtos/Web-Tweeting-Game-Stats.md) for help. \ No newline at end of file diff --git a/docs/1.0-dev/_sources/Setup/Installation-Docker.md.txt b/docs/1.0-dev/_sources/Setup/Installation-Docker.md.txt index 8ad0ca4861..f310c80e21 100644 --- a/docs/1.0-dev/_sources/Setup/Installation-Docker.md.txt +++ b/docs/1.0-dev/_sources/Setup/Installation-Docker.md.txt @@ -1,11 +1,8 @@ # Installing with Docker -Evennia releases [docker images](https://hub.docker.com/r/evennia/evennia/) which makes -running an Evennia-based game in a Docker container easy. +Evennia releases [docker images](https://hub.docker.com/r/evennia/evennia/) as part of regular commits and releases. This makes running an Evennia-based game in a Docker container easy. -First, install the `docker` program so you can run the Evennia container. You can get it freely from -[docker.com](https://www.docker.com/). Linux users can likely also get it through their normal -package manager. +First, install the `docker` program so you can run the Evennia container. You can get it freely from [docker.com](https://www.docker.com/). Linux users can likely also get it through their normal package manager. To fetch the latest evennia docker image, run: @@ -30,11 +27,7 @@ the docker container: evennia|docker /usr/src/game $ ``` -This is a normal shell prompt. We are in the `/usr/src/game` location inside the docker container. -If you had anything in the folder you started from, you should see it here (with `ls`) since we -mounted the current directory to `usr/src/game` (with `-v` above). You have the `evennia` command -available and can now proceed to create a new game as per the normal [game setup](./Installation.md) -instructions (no virtualenv needed). +This is a normal shell prompt. We are in the `/usr/src/game` location inside the docker container. If you had anything in the folder you started from, you should see it here (with `ls`) since we mounted the current directory to `usr/src/game` (with `-v` above). You have the `evennia` command available and can now proceed to create a new game as per the normal [game setup](./Installation.md) instructions (no virtualenv needed). You can run Evennia from inside this container if you want to, it's like you are root in a little isolated Linux environment. To exit the container and all processes in there, press `Ctrl-D`. If you @@ -54,8 +47,7 @@ on your drive. ## Running your game as a docker image -If you run the `docker` command given in the previous section from your game dir you can then -easily start Evennia and have a running server without any further fuss. +If you run the `docker` command given in the previous section from your game dir you can then easily start Evennia and have a running server without any further fuss. But apart from ease of install, the primary benefit to running an Evennia-based game in a container is to simplify its deployment into a public production environment. Most cloud-based hosting providers these days support the ability to run container-based applications. This makes deploying @@ -63,7 +55,7 @@ or updating your game as simple as building a new container image locally, pushi ### Start Evennia and run through docker -For remote or automated deployment you may want to start Evennia immediately as soon as the docker container comes up. If you already have a game folder with a database set up you can also start the docker container and pass commands directly to it. The command you pass will be the main process to run in the container. From your game dir, run for example this command: +For remote or automated deployment you may want to start Evennia immediately as soon as the docker container comes up. If you already have a game folder with a database set up you can also start the docker container and pass commands directly to it. The command you pass will be the main process to run in the container. From your game dir, run for example this command: docker run -it --rm -p 4000:4000 -p 4001:4001 -p 4002:4002 --rm -v $PWD:/usr/src/game evennia/evennia evennia start -l @@ -92,16 +84,13 @@ To build the image: docker build -t mydhaccount/mygame . ``` -(don't forget the period at the end, it will use the `Dockerfile` from the current location). Here -`mydhaccount` is the name of your `dockerhub` account. If you don't have a dockerhub account you can build the image locally only (name the container whatever you like in that case, like just `mygame`). +(don't forget the period at the end, it will use the `Dockerfile` from the current location). Here `mydhaccount` is the name of your `dockerhub` account. If you don't have a dockerhub account you can build the image locally only (name the container whatever you like in that case, like just `mygame`). -Docker images are stored centrally on your computer. You can see which ones you have available -locally with `docker images`. Once built, you have a couple of options to run your game. +Docker images are stored centrally on your computer. You can see which ones you have available locally with `docker images`. Once built, you have a couple of options to run your game. ### Run container from your game image for development -To run the container based on your game image locally for development, mount the local game -directory as before: +To run the container based on your game image locally for development, mount the local game directory as before: ``` docker run -it --rm -p 4000:4000 -p 4001:4001 -p 4002:4002 -v $PWD:/usr/src/game --user $UID:$GID @@ -160,11 +149,9 @@ container will get a new container id to reference. ## How it Works -The `evennia/evennia` docker image holds the evennia library and all of its dependencies. It also has an `ONBUILD` directive which is triggered during builds of images derived from it. This -`ONBUILD` directive handles setting up a volume and copying your game directory code into the proper location within the container. +The `evennia/evennia` docker image holds the evennia library and all of its dependencies. It also has an `ONBUILD` directive which is triggered during builds of images derived from it. This `ONBUILD` directive handles setting up a volume and copying your game directory code into the proper location within the container. -In most cases, the Dockerfile for an Evennia-based game will only need the `FROM evennia/evennia:latest` directive, and optionally a `MAINTAINER` directive if you plan to publish -your image on Docker Hub and would like to provide contact info. +In most cases, the Dockerfile for an Evennia-based game will only need the `FROM evennia/evennia:latest` directive, and optionally a `MAINTAINER` directive if you plan to publish your image on Docker Hub and would like to provide contact info. For more information on Dockerfile directives, see the [Dockerfile Reference](https://docs.docker.com/engine/reference/builder/). @@ -222,8 +209,7 @@ services: volumes: - .:/usr/src/game ``` -With this file in the game directory next to the `Dockerfile`, starting the container is as simple -as +With this file in the game directory next to the `Dockerfile`, starting the container is as simple as ``` docker-compose up ``` diff --git a/docs/1.0-dev/_sources/Setup/Installation-Git.md.txt b/docs/1.0-dev/_sources/Setup/Installation-Git.md.txt index b63c7f1c9d..626323470a 100644 --- a/docs/1.0-dev/_sources/Setup/Installation-Git.md.txt +++ b/docs/1.0-dev/_sources/Setup/Installation-Git.md.txt @@ -39,31 +39,38 @@ not recognize `localhost`). A Python [virtual environment](https://docs.python.org/3/library/venv.html) allows you to install Evennia in its own little folder, separate from the rest of the system. You also won't need any extra permissions. It's optional to use a virtualenv, but it's highly recommended. Python supports this natively: - python3.11 -m venv evenv (linux/mac) - python -m venv venv evenv (Windows) - - > If you have older versions of Python installed on Windows, you should instead use `py` instead of `python` - the `py` launcher automatically selects the latest python version among those you installed. +```{sidebar} Using py on Windows +If you have older versions of Python installed on Windows, you should instead use `py` here instead of `python`. The `py` launcher automatically selects the latest python version among those you installed. +``` +```bash +python3.11 -m venv evenv (linux/mac) +python -m venv evenv (Windows) +``` This will create a new folder `evenv` in your current directory. Activate it like this: -`source evenv/bin/activate` (Linux, Mac) -`evenv\Scripts\activate` (Windows) -`.\evenv\scripts\activate` (Windows with PS Shell, Git Bash etc) - +``` +source evenv/bin/activate (Linux, Mac) +evenv\Scripts\activate (Windows Console) +.\evenv\scripts\activate (Windows PS Shell, + Git Bash etc) +``` The text `(evenv)` should appear next to your prompt to show that the virtual environment is active. You _don't_ need to actually be in or near the `evenv` folder for the environment to be active. -> Remember that you need to re-activate the virtualenv like this *every time* you -> start a new terminal/console. Otherwise the `evennia` command will not be available. +```{important} +Remember that you need to (re-)activate the virtualenv like this *every time* you +start a new terminal/console (or restart your computer). Until you do, the `evennia` command will not be available. +``` ## Linux Install For Debian-derived systems (like Ubuntu, Mint etc), start a terminal and install the requirements: -``` +```bash sudo apt-get update sudo apt-get install python3.11 python3.11-venv python3.11-dev gcc ``` @@ -71,7 +78,7 @@ You should make sure to *not* be `root` after this step, running as `root` is a security risk. Now create a folder where you want to do all your Evennia development: -``` +```bash mkdir muddev cd muddev ``` @@ -88,7 +95,9 @@ At this point it's now optional but recommended that you initialize and activate Next, install Evennia (system-wide, or into your active virtualenv). Make sure you are standing at the top of your mud directory tree (so you see the `evennia/` folder, and likely the `evenv` virtualenv folder) and do - +```{sidebar} +The `-e ` means that we install evennia in editable mode. If you want to develop on Evennia itself, it means that changes you do to the code is immediately reflected on your running server (you don't have to reinstall every time you make a change). +``` ``` pip install -e evennia ``` diff --git a/docs/1.0-dev/_sources/Setup/Installation-Troubleshooting.md.txt b/docs/1.0-dev/_sources/Setup/Installation-Troubleshooting.md.txt index 8aca6ecdba..ee7c5e885c 100644 --- a/docs/1.0-dev/_sources/Setup/Installation-Troubleshooting.md.txt +++ b/docs/1.0-dev/_sources/Setup/Installation-Troubleshooting.md.txt @@ -1,21 +1,19 @@ # Installation Troubleshooting -If you have an issue not covered here, [please report it](https://github.com/evennia/evennia/issues/new/choose) -so it can be fixed or a workaround found! +If you have an issue not covered here, [please report it](https://github.com/evennia/evennia/issues/new/choose) so it can be fixed or a workaround found! The server logs are in `mygame/server/logs/`. To easily view server logs in the terminal, -you can run `evennia -l`, or (in the future) start the server with `evennia start -l`. +you can run `evennia -l`, or start/reload the server with `evennia start -l` or `evennia reload -l`. ## Check your Requirements -Any system that supports Python3.9+ should work. We'll describe how to install -everything in the following sections. +Any system that supports Python3.9+ should work. - Linux/Unix - Windows (Win7, Win8, Win10, Win11) - Mac OSX (>10.5 recommended) -- [Python](https://www.python.org) (v3.9, 3.10 and 3.11 are tested) -- [Twisted](https://twistedmatrix.com) (v22.0+) +- [Python](https://www.python.org) (v3.9, 3.10 and 3.11 are tested. 3.11 is recommended) +- [Twisted](https://twistedmatrix.com) (v22.3+) - [ZopeInterface](https://www.zope.org/Products/ZopeInterface) (v3.0+) - usually included in Twisted packages - Linux/Mac users may need the `gcc` and `python-dev` packages or equivalent. - Windows users need [MS Visual C++](https://aka.ms/vs/16/release/vs_buildtools.exe) and *maybe* [pypiwin32](https://pypi.python.org/pypi/pypiwin32). diff --git a/docs/1.0-dev/_sources/Setup/Installation-Upgrade.md.txt b/docs/1.0-dev/_sources/Setup/Installation-Upgrade.md.txt index 8b784e5f40..342dc8a556 100644 --- a/docs/1.0-dev/_sources/Setup/Installation-Upgrade.md.txt +++ b/docs/1.0-dev/_sources/Setup/Installation-Upgrade.md.txt @@ -7,29 +7,26 @@ over things manually. ### Upgrading the Evennia library -Prior to 1.0, all Evennia installs were [Git-installs](./Installation-Git.md). These instructions -assume that you have a cloned `evennia` repo and use a virtualenv (best practices). +Prior to 1.0, all Evennia installs were [Git-installs](./Installation-Git.md). These instructions assume that you have a cloned `evennia` repo and use a virtualenv (best practices). -- Make sure to stop Evennia 0.9.5 entirely with `evennia stop`. +- Make sure to stop Evennia 0.9.5 entirely with `evennia stop` from your game dir. - `deactivate` to leave your active virtualenv. -- Make a _backup_ of your entire `mygame` folder, just to be sure! - Install Python 3.11 (recommended). Follow the [Git-installation](./Installation-Git.md) for your OS if needed. - Delete the old virtualenv `evenv` folder, or rename it (in case you want to keep using 0.9.5 for a while). - Make _new_ `evenv` virtualenv (see the [virtualenv instructions](./Installation-Git.md#virtualenv) for help) - `cd` into your `evennia/` root folder (you want to see the `docs/` and `bin/` directories as well as a nested `evennia/` folder) - `git pull` +- `git checkout develop` TODO - only until 1.0 release. - `pip install -e .` - If you want the optional extra libs (needed by some contribs), do `pip install -e .[extra]` - Test that you can run the `evennia` command. ### Upgrading your game dir -If you don't have anything you want to keep in your existing game dir, you can just start a new onew -using the normal [install instructions](./Installation.md). If you want to keep/convert your existing -game dir, continue below. +If you don't have anything you want to keep in your existing game dir, you can just start a new one using the normal [install instructions](./Installation.md). If you want to keep/convert your existing game dir, continue below. -- First, make a backup of your exising game dir! If you use version control, make sure to commit your current state. -- `cd` to your existing 0.9.5-based game folder (like `mygame`.) +- First, make a _backup_ of your exising game dir! If you use version control, make sure to commit your current state. +- `cd` to your existing 0.9.5-based game folder (like `mygame`). - If you have changed `mygame/web`, _rename_ the folder to `web_0.9.5`. If you didn't change anything (or don't have anything you want to keep), you can _delete_ it entirely. - Copy `evennia/evennia/game_template/web` to `mygame/` (e.g. using `cp -Rf` or a file manager). This new `web` folder _replaces the old one_ and has a very different structure. - It's possible you need to replace/comment out import and calls to the deprecated diff --git a/docs/1.0-dev/_sources/Setup/Installation.md.txt b/docs/1.0-dev/_sources/Setup/Installation.md.txt index 7e32b83a0c..74a0b7152f 100644 --- a/docs/1.0-dev/_sources/Setup/Installation.md.txt +++ b/docs/1.0-dev/_sources/Setup/Installation.md.txt @@ -124,4 +124,4 @@ See [here](./Evennia-Game-Index.md) for more instructions and please [check out You are good to go! -Next, why not head into the [Starting Tutorial](../Howtos/Beginner-Tutorial/Part1/Beginner-Tutorial-Part1-Intro.md) to learn how to start making your new game! \ No newline at end of file +Next, why not head into the [Starting Tutorial](../Howtos/Beginner-Tutorial/Beginner-Tutorial-Overview.md) to learn how to start making your new game! \ No newline at end of file diff --git a/docs/1.0-dev/_sources/Setup/Online-Setup.md.txt b/docs/1.0-dev/_sources/Setup/Online-Setup.md.txt index 2c4889e01c..3788c64314 100644 --- a/docs/1.0-dev/_sources/Setup/Online-Setup.md.txt +++ b/docs/1.0-dev/_sources/Setup/Online-Setup.md.txt @@ -19,8 +19,7 @@ Out of the box, Evennia uses three ports for outward communication. If your comp Evennia will by default accept incoming connections on all interfaces (`0.0.0.0`) so in principle anyone knowing the ports to use and has the IP address to your machine should be able to connect to your game. ```{sidebar} Closing the log view - If you need to close the log-view, use `Ctrl-C`. Use just `evennia --log` on its own to -start tailing the logs again. +If you need to close the log-view, use `Ctrl-C`. Use just `evennia --log` on its own to start tailing the logs again. ``` - Make sure Evennia is installed and that you have activated the virtualenv. Start the server with `evennia start --log`. The `--log` (or `-l`) will make sure that the logs are echoed to the terminal. - Make sure you can connect with your web browser to `http://localhost:4001` or, alternatively, `http://127.0.0.1:4001` which is the same thing. You should get your Evennia web site and be able to play the game in the web client. Also check so that you can connect with a mud client to host `localhost`, port `4000` or host `127.0.0.1`, port `4000`. diff --git a/docs/1.0-dev/_sources/Setup/Setup-Overview.md.txt b/docs/1.0-dev/_sources/Setup/Setup-Overview.md.txt index 0fc5b2a4bd..5987dc2545 100644 --- a/docs/1.0-dev/_sources/Setup/Setup-Overview.md.txt +++ b/docs/1.0-dev/_sources/Setup/Setup-Overview.md.txt @@ -41,6 +41,6 @@ Online-Setup Client-Support-Grid Security-Practices Config-HAProxy -Config-Apache +Config-Apache-Proxy ``` \ No newline at end of file diff --git a/docs/1.0-dev/_sources/index.md.txt b/docs/1.0-dev/_sources/index.md.txt index 13de8991ac..aba84e1043 100644 --- a/docs/1.0-dev/_sources/index.md.txt +++ b/docs/1.0-dev/_sources/index.md.txt @@ -48,7 +48,7 @@ This is the manual of [Evennia](https://www.evennia.com), the open source Python
    - Click here to expand the full list of Documentation sections. + Click here to expand the full Documentation index. ```{toctree} diff --git a/docs/1.0-dev/api/evennia.commands.default.account.html b/docs/1.0-dev/api/evennia.commands.default.account.html index b8c1c7e5ff..e271df0c7e 100644 --- a/docs/1.0-dev/api/evennia.commands.default.account.html +++ b/docs/1.0-dev/api/evennia.commands.default.account.html @@ -133,7 +133,7 @@ method. Otherwise all text will be returned to all connected sessions.

    -aliases = ['l', 'ls']
    +aliases = ['ls', 'l']
    @@ -164,7 +164,7 @@ method. Otherwise all text will be returned to all connected sessions.

    -search_index_entry = {'aliases': 'l ls', 'category': 'general', 'key': 'look', 'no_prefix': ' l ls', 'tags': '', 'text': '\n look while out-of-character\n\n Usage:\n look\n\n Look in the ooc state.\n '}
    +search_index_entry = {'aliases': 'ls l', 'category': 'general', 'key': 'look', 'no_prefix': ' ls l', 'tags': '', 'text': '\n look while out-of-character\n\n Usage:\n look\n\n Look in the ooc state.\n '}
    diff --git a/docs/1.0-dev/api/evennia.commands.default.building.html b/docs/1.0-dev/api/evennia.commands.default.building.html index b194c1c8e9..4eac3e188e 100644 --- a/docs/1.0-dev/api/evennia.commands.default.building.html +++ b/docs/1.0-dev/api/evennia.commands.default.building.html @@ -1345,7 +1345,7 @@ server settings.

    -aliases = ['@swap', '@type', '@update', '@parent', '@typeclasses']
    +aliases = ['@swap', '@typeclasses', '@update', '@parent', '@type']
    @@ -1376,7 +1376,7 @@ server settings.

    -search_index_entry = {'aliases': '@swap @type @update @parent @typeclasses', 'category': 'building', 'key': '@typeclass', 'no_prefix': 'typeclass swap type update parent typeclasses', 'tags': '', 'text': "\n set or change an object's typeclass\n\n Usage:\n typeclass[/switch] <object> [= typeclass.path]\n typeclass/prototype <object> = prototype_key\n\n typeclasses or typeclass/list/show [typeclass.path]\n swap - this is a shorthand for using /force/reset flags.\n update - this is a shorthand for using the /force/reload flag.\n\n Switch:\n show, examine - display the current typeclass of object (default) or, if\n given a typeclass path, show the docstring of that typeclass.\n update - *only* re-run at_object_creation on this object\n meaning locks or other properties set later may remain.\n reset - clean out *all* the attributes and properties on the\n object - basically making this a new clean object. This will also\n reset cmdsets!\n force - change to the typeclass also if the object\n already has a typeclass of the same name.\n list - show available typeclasses. Only typeclasses in modules actually\n imported or used from somewhere in the code will show up here\n (those typeclasses are still available if you know the path)\n prototype - clean and overwrite the object with the specified\n prototype key - effectively making a whole new object.\n\n Example:\n type button = examples.red_button.RedButton\n type/prototype button=a red button\n\n If the typeclass_path is not given, the current object's typeclass is\n assumed.\n\n View or set an object's typeclass. If setting, the creation hooks of the\n new typeclass will be run on the object. If you have clashing properties on\n the old class, use /reset. By default you are protected from changing to a\n typeclass of the same name as the one you already have - use /force to\n override this protection.\n\n The given typeclass must be identified by its location using python\n dot-notation pointing to the correct module and class. If no typeclass is\n given (or a wrong typeclass is given). Errors in the path or new typeclass\n will lead to the old typeclass being kept. The location of the typeclass\n module is searched from the default typeclass directory, as defined in the\n server settings.\n\n "}
    +search_index_entry = {'aliases': '@swap @typeclasses @update @parent @type', 'category': 'building', 'key': '@typeclass', 'no_prefix': 'typeclass swap typeclasses update parent type', 'tags': '', 'text': "\n set or change an object's typeclass\n\n Usage:\n typeclass[/switch] <object> [= typeclass.path]\n typeclass/prototype <object> = prototype_key\n\n typeclasses or typeclass/list/show [typeclass.path]\n swap - this is a shorthand for using /force/reset flags.\n update - this is a shorthand for using the /force/reload flag.\n\n Switch:\n show, examine - display the current typeclass of object (default) or, if\n given a typeclass path, show the docstring of that typeclass.\n update - *only* re-run at_object_creation on this object\n meaning locks or other properties set later may remain.\n reset - clean out *all* the attributes and properties on the\n object - basically making this a new clean object. This will also\n reset cmdsets!\n force - change to the typeclass also if the object\n already has a typeclass of the same name.\n list - show available typeclasses. Only typeclasses in modules actually\n imported or used from somewhere in the code will show up here\n (those typeclasses are still available if you know the path)\n prototype - clean and overwrite the object with the specified\n prototype key - effectively making a whole new object.\n\n Example:\n type button = examples.red_button.RedButton\n type/prototype button=a red button\n\n If the typeclass_path is not given, the current object's typeclass is\n assumed.\n\n View or set an object's typeclass. If setting, the creation hooks of the\n new typeclass will be run on the object. If you have clashing properties on\n the old class, use /reset. By default you are protected from changing to a\n typeclass of the same name as the one you already have - use /force to\n override this protection.\n\n The given typeclass must be identified by its location using python\n dot-notation pointing to the correct module and class. If no typeclass is\n given (or a wrong typeclass is given). Errors in the path or new typeclass\n will lead to the old typeclass being kept. The location of the typeclass\n module is searched from the default typeclass directory, as defined in the\n server settings.\n\n "}
    @@ -1531,7 +1531,7 @@ If object is not specified, the current location is examined.

    -aliases = ['@ex', '@exam']
    +aliases = ['@exam', '@ex']
    @@ -1799,7 +1799,7 @@ the cases, see the module doc.

    -search_index_entry = {'aliases': '@ex @exam', 'category': 'building', 'key': '@examine', 'no_prefix': 'examine ex exam', 'tags': '', 'text': '\n get detailed information about an object\n\n Usage:\n examine [<object>[/attrname]]\n examine [*<account>[/attrname]]\n\n Switch:\n account - examine an Account (same as adding *)\n object - examine an Object (useful when OOC)\n script - examine a Script\n channel - examine a Channel\n\n The examine command shows detailed game info about an\n object and optionally a specific attribute on it.\n If object is not specified, the current location is examined.\n\n Append a * before the search string to examine an account.\n\n '}
    +search_index_entry = {'aliases': '@exam @ex', 'category': 'building', 'key': '@examine', 'no_prefix': 'examine exam ex', 'tags': '', 'text': '\n get detailed information about an object\n\n Usage:\n examine [<object>[/attrname]]\n examine [*<account>[/attrname]]\n\n Switch:\n account - examine an Account (same as adding *)\n object - examine an Object (useful when OOC)\n script - examine a Script\n channel - examine a Channel\n\n The examine command shows detailed game info about an\n object and optionally a specific attribute on it.\n If object is not specified, the current location is examined.\n\n Append a * before the search string to examine an account.\n\n '}
    @@ -1833,7 +1833,7 @@ one is given.

    -aliases = ['@locate', '@search']
    +aliases = ['@search', '@locate']
    @@ -1864,7 +1864,7 @@ one is given.

    -search_index_entry = {'aliases': '@locate @search', 'category': 'building', 'key': '@find', 'no_prefix': 'find locate search', 'tags': '', 'text': '\n search the database for objects\n\n Usage:\n find[/switches] <name or dbref or *account> [= dbrefmin[-dbrefmax]]\n locate - this is a shorthand for using the /loc switch.\n\n Switches:\n room - only look for rooms (location=None)\n exit - only look for exits (destination!=None)\n char - only look for characters (BASE_CHARACTER_TYPECLASS)\n exact - only exact matches are returned.\n loc - display object location if exists and match has one result\n startswith - search for names starting with the string, rather than containing\n\n Searches the database for an object of a particular name or exact #dbref.\n Use *accountname to search for an account. The switches allows for\n limiting object matches to certain game entities. Dbrefmin and dbrefmax\n limits matches to within the given dbrefs range, or above/below if only\n one is given.\n '}
    +search_index_entry = {'aliases': '@search @locate', 'category': 'building', 'key': '@find', 'no_prefix': 'find search locate', 'tags': '', 'text': '\n search the database for objects\n\n Usage:\n find[/switches] <name or dbref or *account> [= dbrefmin[-dbrefmax]]\n locate - this is a shorthand for using the /loc switch.\n\n Switches:\n room - only look for rooms (location=None)\n exit - only look for exits (destination!=None)\n char - only look for characters (BASE_CHARACTER_TYPECLASS)\n exact - only exact matches are returned.\n loc - display object location if exists and match has one result\n startswith - search for names starting with the string, rather than containing\n\n Searches the database for an object of a particular name or exact #dbref.\n Use *accountname to search for an account. The switches allows for\n limiting object matches to certain game entities. Dbrefmin and dbrefmax\n limits matches to within the given dbrefs range, or above/below if only\n one is given.\n '}
    diff --git a/docs/1.0-dev/api/evennia.commands.default.general.html b/docs/1.0-dev/api/evennia.commands.default.general.html index ea6d01d238..168d1193df 100644 --- a/docs/1.0-dev/api/evennia.commands.default.general.html +++ b/docs/1.0-dev/api/evennia.commands.default.general.html @@ -175,7 +175,7 @@ look *<account&g
    -aliases = ['l', 'ls']
    +aliases = ['ls', 'l']
    @@ -206,7 +206,7 @@ look *<account&g
    -search_index_entry = {'aliases': 'l ls', 'category': 'general', 'key': 'look', 'no_prefix': ' l ls', 'tags': '', 'text': '\n look at location or object\n\n Usage:\n look\n look <obj>\n look *<account>\n\n Observes your location or objects in your vicinity.\n '}
    +search_index_entry = {'aliases': 'ls l', 'category': 'general', 'key': 'look', 'no_prefix': ' ls l', 'tags': '', 'text': '\n look at location or object\n\n Usage:\n look\n look <obj>\n look *<account>\n\n Observes your location or objects in your vicinity.\n '}
    @@ -323,7 +323,7 @@ inv

    -aliases = ['inv', 'i']
    +aliases = ['i', 'inv']
    @@ -354,7 +354,7 @@ inv

    -search_index_entry = {'aliases': 'inv i', 'category': 'general', 'key': 'inventory', 'no_prefix': ' inv i', 'tags': '', 'text': '\n view inventory\n\n Usage:\n inventory\n inv\n\n Shows your inventory.\n '}
    +search_index_entry = {'aliases': 'i inv', 'category': 'general', 'key': 'inventory', 'no_prefix': ' i inv', 'tags': '', 'text': '\n view inventory\n\n Usage:\n inventory\n inv\n\n Shows your inventory.\n '}
    @@ -709,7 +709,7 @@ automatically begin with your name.

    -aliases = ['emote', ':']
    +aliases = [':', 'emote']
    @@ -750,7 +750,7 @@ space.

    -search_index_entry = {'aliases': 'emote :', 'category': 'general', 'key': 'pose', 'no_prefix': ' emote :', 'tags': '', 'text': "\n strike a pose\n\n Usage:\n pose <pose text>\n pose's <pose text>\n\n Example:\n pose is standing by the wall, smiling.\n -> others will see:\n Tom is standing by the wall, smiling.\n\n Describe an action being taken. The pose text will\n automatically begin with your name.\n "}
    +search_index_entry = {'aliases': ': emote', 'category': 'general', 'key': 'pose', 'no_prefix': ' : emote', 'tags': '', 'text': "\n strike a pose\n\n Usage:\n pose <pose text>\n pose's <pose text>\n\n Example:\n pose is standing by the wall, smiling.\n -> others will see:\n Tom is standing by the wall, smiling.\n\n Describe an action being taken. The pose text will\n automatically begin with your name.\n "}
    @@ -773,7 +773,7 @@ which permission groups you are a member of.

    -aliases = ['hierarchy', 'groups']
    +aliases = ['groups', 'hierarchy']
    @@ -804,7 +804,7 @@ which permission groups you are a member of.

    -search_index_entry = {'aliases': 'hierarchy groups', 'category': 'general', 'key': 'access', 'no_prefix': ' hierarchy groups', 'tags': '', 'text': '\n show your current game access\n\n Usage:\n access\n\n This command shows you the permission hierarchy and\n which permission groups you are a member of.\n '}
    +search_index_entry = {'aliases': 'groups hierarchy', 'category': 'general', 'key': 'access', 'no_prefix': ' groups hierarchy', 'tags': '', 'text': '\n show your current game access\n\n Usage:\n access\n\n This command shows you the permission hierarchy and\n which permission groups you are a member of.\n '}
    diff --git a/docs/1.0-dev/api/evennia.commands.default.system.html b/docs/1.0-dev/api/evennia.commands.default.system.html index e450185933..972851c8a4 100644 --- a/docs/1.0-dev/api/evennia.commands.default.system.html +++ b/docs/1.0-dev/api/evennia.commands.default.system.html @@ -683,7 +683,7 @@ See |luhttps://ww
    -aliases = ['@task', '@delays']
    +aliases = ['@delays', '@task']
    @@ -729,7 +729,7 @@ to all the variables defined therein.

    -search_index_entry = {'aliases': '@task @delays', 'category': 'system', 'key': '@tasks', 'no_prefix': 'tasks task delays', 'tags': '', 'text': "\n Display or terminate active tasks (delays).\n\n Usage:\n tasks[/switch] [task_id or function_name]\n\n Switches:\n pause - Pause the callback of a task.\n unpause - Process all callbacks made since pause() was called.\n do_task - Execute the task (call its callback).\n call - Call the callback of this task.\n remove - Remove a task without executing it.\n cancel - Stop a task from automatically executing.\n\n Notes:\n A task is a single use method of delaying the call of a function. Calls are created\n in code, using `evennia.utils.delay`.\n See |luhttps://www.evennia.com/docs/latest/Command-Duration.html|ltthe docs|le for help.\n\n By default, tasks that are canceled and never called are cleaned up after one minute.\n\n Examples:\n - `tasks/cancel move_callback` - Cancels all movement delays from the slow_exit contrib.\n In this example slow exits creates it's tasks with\n `utils.delay(move_delay, move_callback)`\n - `tasks/cancel 2` - Cancel task id 2.\n\n "}
    +search_index_entry = {'aliases': '@delays @task', 'category': 'system', 'key': '@tasks', 'no_prefix': 'tasks delays task', 'tags': '', 'text': "\n Display or terminate active tasks (delays).\n\n Usage:\n tasks[/switch] [task_id or function_name]\n\n Switches:\n pause - Pause the callback of a task.\n unpause - Process all callbacks made since pause() was called.\n do_task - Execute the task (call its callback).\n call - Call the callback of this task.\n remove - Remove a task without executing it.\n cancel - Stop a task from automatically executing.\n\n Notes:\n A task is a single use method of delaying the call of a function. Calls are created\n in code, using `evennia.utils.delay`.\n See |luhttps://www.evennia.com/docs/latest/Command-Duration.html|ltthe docs|le for help.\n\n By default, tasks that are canceled and never called are cleaned up after one minute.\n\n Examples:\n - `tasks/cancel move_callback` - Cancels all movement delays from the slow_exit contrib.\n In this example slow exits creates it's tasks with\n `utils.delay(move_delay, move_callback)`\n - `tasks/cancel 2` - Cancel task id 2.\n\n "}
    diff --git a/docs/1.0-dev/api/evennia.commands.default.tests.html b/docs/1.0-dev/api/evennia.commands.default.tests.html index 90d47c81f3..41af78e6b2 100644 --- a/docs/1.0-dev/api/evennia.commands.default.tests.html +++ b/docs/1.0-dev/api/evennia.commands.default.tests.html @@ -902,7 +902,7 @@ main test suite started with

    Test the batch processor.

    -red_button = <module 'evennia.contrib.tutorials.red_button.red_button' from '/tmp/tmpz0bofrlj/b13f5aee6f67688c5812751f800bae63380c046d/evennia/contrib/tutorials/red_button/red_button.py'>
    +red_button = <module 'evennia.contrib.tutorials.red_button.red_button' from '/tmp/tmpp30qwhx2/3965f928febc10c0ad2087926b6acc7493183a66/evennia/contrib/tutorials/red_button/red_button.py'>
    diff --git a/docs/1.0-dev/api/evennia.commands.default.unloggedin.html b/docs/1.0-dev/api/evennia.commands.default.unloggedin.html index e9ca784e8d..21fc5fca0d 100644 --- a/docs/1.0-dev/api/evennia.commands.default.unloggedin.html +++ b/docs/1.0-dev/api/evennia.commands.default.unloggedin.html @@ -122,7 +122,7 @@ connect “account name” “pass word”

    -aliases = ['conn', 'co', 'con']
    +aliases = ['con', 'conn', 'co']
    @@ -157,7 +157,7 @@ there is no object yet before the account has logged in)

    -search_index_entry = {'aliases': 'conn co con', 'category': 'general', 'key': 'connect', 'no_prefix': ' conn co con', 'tags': '', 'text': '\n connect to the game\n\n Usage (at login screen):\n connect accountname password\n connect "account name" "pass word"\n\n Use the create command to first create an account before logging in.\n\n If you have spaces in your name, enclose it in double quotes.\n '}
    +search_index_entry = {'aliases': 'con conn co', 'category': 'general', 'key': 'connect', 'no_prefix': ' con conn co', 'tags': '', 'text': '\n connect to the game\n\n Usage (at login screen):\n connect accountname password\n connect "account name" "pass word"\n\n Use the create command to first create an account before logging in.\n\n If you have spaces in your name, enclose it in double quotes.\n '}
    @@ -335,7 +335,7 @@ for simplicity. It shows a pane of info.

    -aliases = ['h', '?']
    +aliases = ['?', 'h']
    @@ -361,7 +361,7 @@ for simplicity. It shows a pane of info.

    -search_index_entry = {'aliases': 'h ?', 'category': 'general', 'key': 'help', 'no_prefix': ' h ?', 'tags': '', 'text': '\n get help when in unconnected-in state\n\n Usage:\n help\n\n This is an unconnected version of the help command,\n for simplicity. It shows a pane of info.\n '}
    +search_index_entry = {'aliases': '? h', 'category': 'general', 'key': 'help', 'no_prefix': ' ? h', 'tags': '', 'text': '\n get help when in unconnected-in state\n\n Usage:\n help\n\n This is an unconnected version of the help command,\n for simplicity. It shows a pane of info.\n '}
    diff --git a/docs/1.0-dev/api/evennia.contrib.base_systems.email_login.email_login.html b/docs/1.0-dev/api/evennia.contrib.base_systems.email_login.email_login.html index 907cfbaad9..499d3cb455 100644 --- a/docs/1.0-dev/api/evennia.contrib.base_systems.email_login.email_login.html +++ b/docs/1.0-dev/api/evennia.contrib.base_systems.email_login.email_login.html @@ -139,7 +139,7 @@ the module given by settings.CONNECTION_SCREEN_MODULE.

    -aliases = ['conn', 'co', 'con']
    +aliases = ['con', 'conn', 'co']
    @@ -169,7 +169,7 @@ there is no object yet before the account has logged in)

    -search_index_entry = {'aliases': 'conn co con', 'category': 'general', 'key': 'connect', 'no_prefix': ' conn co con', 'tags': '', 'text': '\n Connect to the game.\n\n Usage (at login screen):\n connect <email> <password>\n\n Use the create command to first create an account before logging in.\n '}
    +search_index_entry = {'aliases': 'con conn co', 'category': 'general', 'key': 'connect', 'no_prefix': ' con conn co', 'tags': '', 'text': '\n Connect to the game.\n\n Usage (at login screen):\n connect <email> <password>\n\n Use the create command to first create an account before logging in.\n '}
    @@ -335,7 +335,7 @@ for simplicity. It shows a pane of info.

    -aliases = ['h', '?']
    +aliases = ['?', 'h']
    @@ -361,7 +361,7 @@ for simplicity. It shows a pane of info.

    -search_index_entry = {'aliases': 'h ?', 'category': 'general', 'key': 'help', 'no_prefix': ' h ?', 'tags': '', 'text': '\n This is an unconnected version of the help command,\n for simplicity. It shows a pane of info.\n '}
    +search_index_entry = {'aliases': '? h', 'category': 'general', 'key': 'help', 'no_prefix': ' ? h', 'tags': '', 'text': '\n This is an unconnected version of the help command,\n for simplicity. It shows a pane of info.\n '}
    diff --git a/docs/1.0-dev/api/evennia.contrib.base_systems.ingame_python.commands.html b/docs/1.0-dev/api/evennia.contrib.base_systems.ingame_python.commands.html index bb080d9107..6c2ac9fd1a 100644 --- a/docs/1.0-dev/api/evennia.contrib.base_systems.ingame_python.commands.html +++ b/docs/1.0-dev/api/evennia.contrib.base_systems.ingame_python.commands.html @@ -116,7 +116,7 @@
    -aliases = ['@calls', '@callback', '@callbacks']
    +aliases = ['@callbacks', '@calls', '@callback']
    @@ -197,7 +197,7 @@ on user permission.

    -search_index_entry = {'aliases': '@calls @callback @callbacks', 'category': 'building', 'key': '@call', 'no_prefix': 'call calls callback callbacks', 'tags': '', 'text': '\n Command to edit callbacks.\n '}
    +search_index_entry = {'aliases': '@callbacks @calls @callback', 'category': 'building', 'key': '@call', 'no_prefix': 'call callbacks calls callback', 'tags': '', 'text': '\n Command to edit callbacks.\n '}
    diff --git a/docs/1.0-dev/api/evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.html b/docs/1.0-dev/api/evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.html index 6f256818e3..4a6704c4be 100644 --- a/docs/1.0-dev/api/evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.html +++ b/docs/1.0-dev/api/evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.html @@ -160,7 +160,7 @@ aliases to an already joined channel.

    -aliases = ['chanalias', 'aliaschan']
    +aliases = ['aliaschan', 'chanalias']
    @@ -191,7 +191,7 @@ aliases to an already joined channel.

    -search_index_entry = {'aliases': 'chanalias aliaschan', 'category': 'comms', 'key': 'addcom', 'no_prefix': ' chanalias aliaschan', 'tags': '', 'text': '\n Add a channel alias and/or subscribe to a channel\n\n Usage:\n addcom [alias=] <channel>\n\n Joins a given channel. If alias is given, this will allow you to\n refer to the channel by this alias rather than the full channel\n name. Subsequent calls of this command can be used to add multiple\n aliases to an already joined channel.\n '}
    +search_index_entry = {'aliases': 'aliaschan chanalias', 'category': 'comms', 'key': 'addcom', 'no_prefix': ' aliaschan chanalias', 'tags': '', 'text': '\n Add a channel alias and/or subscribe to a channel\n\n Usage:\n addcom [alias=] <channel>\n\n Joins a given channel. If alias is given, this will allow you to\n refer to the channel by this alias rather than the full channel\n name. Subsequent calls of this command can be used to add multiple\n aliases to an already joined channel.\n '}
    diff --git a/docs/1.0-dev/api/evennia.contrib.full_systems.evscaperoom.commands.html b/docs/1.0-dev/api/evennia.contrib.full_systems.evscaperoom.commands.html index 8642104f00..cdecdfa891 100644 --- a/docs/1.0-dev/api/evennia.contrib.full_systems.evscaperoom.commands.html +++ b/docs/1.0-dev/api/evennia.contrib.full_systems.evscaperoom.commands.html @@ -211,7 +211,7 @@ the operation will be general or on the room.

    -aliases = ['abort', 'chicken out', 'quit', 'q']
    +aliases = ['chicken out', 'abort', 'q', 'quit']
    @@ -235,7 +235,7 @@ set in self.parse())

    -search_index_entry = {'aliases': 'abort chicken out quit q', 'category': 'evscaperoom', 'key': 'give up', 'no_prefix': ' abort chicken out quit q', 'tags': '', 'text': '\n Give up\n\n Usage:\n give up\n\n Abandons your attempts at escaping and of ever winning the pie-eating contest.\n\n '}
    +search_index_entry = {'aliases': 'chicken out abort q quit', 'category': 'evscaperoom', 'key': 'give up', 'no_prefix': ' chicken out abort q quit', 'tags': '', 'text': '\n Give up\n\n Usage:\n give up\n\n Abandons your attempts at escaping and of ever winning the pie-eating contest.\n\n '}
    @@ -256,7 +256,7 @@ set in self.parse())

    -aliases = ['l', 'ls']
    +aliases = ['ls', 'l']
    @@ -290,7 +290,7 @@ set in self.parse())

    -search_index_entry = {'aliases': 'l ls', 'category': 'evscaperoom', 'key': 'look', 'no_prefix': ' l ls', 'tags': '', 'text': '\n Look at the room, an object or the currently focused object\n\n Usage:\n look [obj]\n\n '}
    +search_index_entry = {'aliases': 'ls l', 'category': 'evscaperoom', 'key': 'look', 'no_prefix': ' ls l', 'tags': '', 'text': '\n Look at the room, an object or the currently focused object\n\n Usage:\n look [obj]\n\n '}
    @@ -371,7 +371,7 @@ shout

    -aliases = [';', 'shout', 'whisper']
    +aliases = ['shout', 'whisper', ';']
    @@ -400,7 +400,7 @@ set in self.parse())

    -search_index_entry = {'aliases': '; shout whisper', 'category': 'general', 'key': 'say', 'no_prefix': ' ; shout whisper', 'tags': '', 'text': '\n Perform an communication action.\n\n Usage:\n say <text>\n whisper\n shout\n\n '}
    +search_index_entry = {'aliases': 'shout whisper ;', 'category': 'general', 'key': 'say', 'no_prefix': ' shout whisper ;', 'tags': '', 'text': '\n Perform an communication action.\n\n Usage:\n say <text>\n whisper\n shout\n\n '}
    @@ -428,7 +428,7 @@ emote /me points to /box and /lever.

    -aliases = ['pose', ':']
    +aliases = [':', 'pose']
    @@ -467,7 +467,7 @@ set in self.parse())

    -search_index_entry = {'aliases': 'pose :', 'category': 'general', 'key': 'emote', 'no_prefix': ' pose :', 'tags': '', 'text': '\n Perform a free-form emote. Use /me to\n include yourself in the emote and /name\n to include other objects or characters.\n Use "..." to enact speech.\n\n Usage:\n emote <emote>\n :<emote\n\n Example:\n emote /me smiles at /peter\n emote /me points to /box and /lever.\n\n '}
    +search_index_entry = {'aliases': ': pose', 'category': 'general', 'key': 'emote', 'no_prefix': ' : pose', 'tags': '', 'text': '\n Perform a free-form emote. Use /me to\n include yourself in the emote and /name\n to include other objects or characters.\n Use "..." to enact speech.\n\n Usage:\n emote <emote>\n :<emote\n\n Example:\n emote /me smiles at /peter\n emote /me points to /box and /lever.\n\n '}
    @@ -490,7 +490,7 @@ looks and what actions is available.

    -aliases = ['unfocus', 'examine', 'e', 'ex']
    +aliases = ['e', 'ex', 'unfocus', 'examine']
    @@ -519,7 +519,7 @@ set in self.parse())

    -search_index_entry = {'aliases': 'unfocus examine e ex', 'category': 'evscaperoom', 'key': 'focus', 'no_prefix': ' unfocus examine e ex', 'tags': '', 'text': '\n Focus your attention on a target.\n\n Usage:\n focus <obj>\n\n Once focusing on an object, use look to get more information about how it\n looks and what actions is available.\n\n '}
    +search_index_entry = {'aliases': 'e ex unfocus examine', 'category': 'evscaperoom', 'key': 'focus', 'no_prefix': ' e ex unfocus examine', 'tags': '', 'text': '\n Focus your attention on a target.\n\n Usage:\n focus <obj>\n\n Once focusing on an object, use look to get more information about how it\n looks and what actions is available.\n\n '}
    @@ -581,7 +581,7 @@ set in self.parse())

    -aliases = ['inv', 'give', 'i', 'inventory']
    +aliases = ['i', 'inventory', 'inv', 'give']
    @@ -605,7 +605,7 @@ set in self.parse())

    -search_index_entry = {'aliases': 'inv give i inventory', 'category': 'evscaperoom', 'key': 'get', 'no_prefix': ' inv give i inventory', 'tags': '', 'text': '\n Use focus / examine instead.\n\n '}
    +search_index_entry = {'aliases': 'i inventory inv give', 'category': 'evscaperoom', 'key': 'get', 'no_prefix': ' i inventory inv give', 'tags': '', 'text': '\n Use focus / examine instead.\n\n '}
    diff --git a/docs/1.0-dev/api/evennia.contrib.game_systems.barter.barter.html b/docs/1.0-dev/api/evennia.contrib.game_systems.barter.barter.html index 60f08ffd36..2be2efb51c 100644 --- a/docs/1.0-dev/api/evennia.contrib.game_systems.barter.barter.html +++ b/docs/1.0-dev/api/evennia.contrib.game_systems.barter.barter.html @@ -745,7 +745,7 @@ try to influence the other part in the deal.

    -aliases = ['offers', 'deal']
    +aliases = ['deal', 'offers']
    @@ -771,7 +771,7 @@ try to influence the other part in the deal.

    -search_index_entry = {'aliases': 'offers deal', 'category': 'trading', 'key': 'status', 'no_prefix': ' offers deal', 'tags': '', 'text': "\n show a list of the current deal\n\n Usage:\n status\n deal\n offers\n\n Shows the currently suggested offers on each sides of the deal. To\n accept the current deal, use the 'accept' command. Use 'offer' to\n change your deal. You might also want to use 'say', 'emote' etc to\n try to influence the other part in the deal.\n "}
    +search_index_entry = {'aliases': 'deal offers', 'category': 'trading', 'key': 'status', 'no_prefix': ' deal offers', 'tags': '', 'text': "\n show a list of the current deal\n\n Usage:\n status\n deal\n offers\n\n Shows the currently suggested offers on each sides of the deal. To\n accept the current deal, use the 'accept' command. Use 'offer' to\n change your deal. You might also want to use 'say', 'emote' etc to\n try to influence the other part in the deal.\n "}
    diff --git a/docs/1.0-dev/api/evennia.contrib.game_systems.clothing.clothing.html b/docs/1.0-dev/api/evennia.contrib.game_systems.clothing.clothing.html index 9755fdb7f3..669695bb9f 100644 --- a/docs/1.0-dev/api/evennia.contrib.game_systems.clothing.clothing.html +++ b/docs/1.0-dev/api/evennia.contrib.game_systems.clothing.clothing.html @@ -692,7 +692,7 @@ inv

    -aliases = ['inv', 'i']
    +aliases = ['i', 'inv']
    @@ -723,7 +723,7 @@ inv

    -search_index_entry = {'aliases': 'inv i', 'category': 'general', 'key': 'inventory', 'no_prefix': ' inv i', 'tags': '', 'text': '\n view inventory\n\n Usage:\n inventory\n inv\n\n Shows your inventory.\n '}
    +search_index_entry = {'aliases': 'i inv', 'category': 'general', 'key': 'inventory', 'no_prefix': ' i inv', 'tags': '', 'text': '\n view inventory\n\n Usage:\n inventory\n inv\n\n Shows your inventory.\n '}
    diff --git a/docs/1.0-dev/api/evennia.contrib.grid.extended_room.extended_room.html b/docs/1.0-dev/api/evennia.contrib.grid.extended_room.extended_room.html index 9d99bb9288..d90f992bc4 100644 --- a/docs/1.0-dev/api/evennia.contrib.grid.extended_room.extended_room.html +++ b/docs/1.0-dev/api/evennia.contrib.grid.extended_room.extended_room.html @@ -340,7 +340,7 @@ look *<account&g
    -aliases = ['l', 'ls']
    +aliases = ['ls', 'l']
    @@ -360,7 +360,7 @@ look *<account&g
    -search_index_entry = {'aliases': 'l ls', 'category': 'general', 'key': 'look', 'no_prefix': ' l ls', 'tags': '', 'text': '\n look\n\n Usage:\n look\n look <obj>\n look <room detail>\n look *<account>\n\n Observes your location, details at your location or objects in your vicinity.\n '}
    +search_index_entry = {'aliases': 'ls l', 'category': 'general', 'key': 'look', 'no_prefix': ' ls l', 'tags': '', 'text': '\n look\n\n Usage:\n look\n look <obj>\n look <room detail>\n look *<account>\n\n Observes your location, details at your location or objects in your vicinity.\n '}
    diff --git a/docs/1.0-dev/api/evennia.contrib.rpg.dice.dice.html b/docs/1.0-dev/api/evennia.contrib.rpg.dice.dice.html index c485bd9dc5..f934d57a9e 100644 --- a/docs/1.0-dev/api/evennia.contrib.rpg.dice.dice.html +++ b/docs/1.0-dev/api/evennia.contrib.rpg.dice.dice.html @@ -305,7 +305,7 @@ everyone but the person rolling.

    -aliases = ['@dice', 'roll']
    +aliases = ['roll', '@dice']
    @@ -331,7 +331,7 @@ everyone but the person rolling.

    -search_index_entry = {'aliases': '@dice roll', 'category': 'general', 'key': 'dice', 'no_prefix': ' dice roll', 'tags': '', 'text': "\n roll dice\n\n Usage:\n dice[/switch] <nr>d<sides> [modifier] [success condition]\n\n Switch:\n hidden - tell the room the roll is being done, but don't show the result\n secret - don't inform the room about neither roll nor result\n\n Examples:\n dice 3d6 + 4\n dice 1d100 - 2 < 50\n\n This will roll the given number of dice with given sides and modifiers.\n So e.g. 2d6 + 3 means to 'roll a 6-sided die 2 times and add the result,\n then add 3 to the total'.\n Accepted modifiers are +, -, * and /.\n A success condition is given as normal Python conditionals\n (<,>,<=,>=,==,!=). So e.g. 2d6 + 3 > 10 means that the roll will succeed\n only if the final result is above 8. If a success condition is given, the\n outcome (pass/fail) will be echoed along with how much it succeeded/failed\n with. The hidden/secret switches will hide all or parts of the roll from\n everyone but the person rolling.\n "}
    +search_index_entry = {'aliases': 'roll @dice', 'category': 'general', 'key': 'dice', 'no_prefix': ' roll dice', 'tags': '', 'text': "\n roll dice\n\n Usage:\n dice[/switch] <nr>d<sides> [modifier] [success condition]\n\n Switch:\n hidden - tell the room the roll is being done, but don't show the result\n secret - don't inform the room about neither roll nor result\n\n Examples:\n dice 3d6 + 4\n dice 1d100 - 2 < 50\n\n This will roll the given number of dice with given sides and modifiers.\n So e.g. 2d6 + 3 means to 'roll a 6-sided die 2 times and add the result,\n then add 3 to the total'.\n Accepted modifiers are +, -, * and /.\n A success condition is given as normal Python conditionals\n (<,>,<=,>=,==,!=). So e.g. 2d6 + 3 > 10 means that the roll will succeed\n only if the final result is above 8. If a success condition is given, the\n outcome (pass/fail) will be echoed along with how much it succeeded/failed\n with. The hidden/secret switches will hide all or parts of the roll from\n everyone but the person rolling.\n "}
    diff --git a/docs/1.0-dev/api/evennia.contrib.rpg.rpsystem.rpsystem.html b/docs/1.0-dev/api/evennia.contrib.rpg.rpsystem.rpsystem.html index d9ebb1ed4d..bd424df5b5 100644 --- a/docs/1.0-dev/api/evennia.contrib.rpg.rpsystem.rpsystem.html +++ b/docs/1.0-dev/api/evennia.contrib.rpg.rpsystem.rpsystem.html @@ -865,7 +865,7 @@ Using the command without arguments will list all current recogs.

    -aliases = ['recognize', 'forget']
    +aliases = ['forget', 'recognize']
    @@ -892,7 +892,7 @@ Using the command without arguments will list all current recogs.

    -search_index_entry = {'aliases': 'recognize forget', 'category': 'general', 'key': 'recog', 'no_prefix': ' recognize forget', 'tags': '', 'text': '\n Recognize another person in the same room.\n\n Usage:\n recog\n recog sdesc as alias\n forget alias\n\n Example:\n recog tall man as Griatch\n forget griatch\n\n This will assign a personal alias for a person, or forget said alias.\n Using the command without arguments will list all current recogs.\n\n '}
    +search_index_entry = {'aliases': 'forget recognize', 'category': 'general', 'key': 'recog', 'no_prefix': ' forget recognize', 'tags': '', 'text': '\n Recognize another person in the same room.\n\n Usage:\n recog\n recog sdesc as alias\n forget alias\n\n Example:\n recog tall man as Griatch\n forget griatch\n\n This will assign a personal alias for a person, or forget said alias.\n Using the command without arguments will list all current recogs.\n\n '}
    diff --git a/docs/1.0-dev/api/evennia.contrib.tutorials.evadventure.commands.html b/docs/1.0-dev/api/evennia.contrib.tutorials.evadventure.commands.html index d1e473348a..a15639e603 100644 --- a/docs/1.0-dev/api/evennia.contrib.tutorials.evadventure.commands.html +++ b/docs/1.0-dev/api/evennia.contrib.tutorials.evadventure.commands.html @@ -256,7 +256,7 @@ set in self.parse())

    -aliases = ['inv', 'i']
    +aliases = ['i', 'inv']
    @@ -280,7 +280,7 @@ set in self.parse())

    -search_index_entry = {'aliases': 'inv i', 'category': 'general', 'key': 'inventory', 'no_prefix': ' inv i', 'tags': '', 'text': '\n View your inventory\n\n Usage:\n inventory\n\n '}
    +search_index_entry = {'aliases': 'i inv', 'category': 'general', 'key': 'inventory', 'no_prefix': ' i inv', 'tags': '', 'text': '\n View your inventory\n\n Usage:\n inventory\n\n '}
    @@ -357,7 +357,7 @@ unwear <item>

    -aliases = ['unwear', 'unwield']
    +aliases = ['unwield', 'unwear']
    @@ -381,7 +381,7 @@ set in self.parse())

    -search_index_entry = {'aliases': 'unwear unwield', 'category': 'general', 'key': 'remove', 'no_prefix': ' unwear unwield', 'tags': '', 'text': '\n Remove a remove a weapon/shield, armor or helmet.\n\n Usage:\n remove <item>\n unwield <item>\n unwear <item>\n\n To remove an item from the backpack, use |wdrop|n instead.\n\n '}
    +search_index_entry = {'aliases': 'unwield unwear', 'category': 'general', 'key': 'remove', 'no_prefix': ' unwield unwear', 'tags': '', 'text': '\n Remove a remove a weapon/shield, armor or helmet.\n\n Usage:\n remove <item>\n unwield <item>\n unwear <item>\n\n To remove an item from the backpack, use |wdrop|n instead.\n\n '}
    diff --git a/docs/1.0-dev/api/evennia.contrib.tutorials.red_button.red_button.html b/docs/1.0-dev/api/evennia.contrib.tutorials.red_button.red_button.html index dfde070cba..f83e7286c2 100644 --- a/docs/1.0-dev/api/evennia.contrib.tutorials.red_button.red_button.html +++ b/docs/1.0-dev/api/evennia.contrib.tutorials.red_button.red_button.html @@ -153,7 +153,7 @@ such as when closing the lid and un-blinding a character.

    -aliases = ['press button', 'push', 'press']
    +aliases = ['press', 'press button', 'push']
    @@ -182,7 +182,7 @@ check if the lid is open or closed.

    -search_index_entry = {'aliases': 'press button push press', 'category': 'general', 'key': 'push button', 'no_prefix': ' press button push press', 'tags': '', 'text': '\n Push the red button (lid closed)\n\n Usage:\n push button\n\n '}
    +search_index_entry = {'aliases': 'press press button push', 'category': 'general', 'key': 'push button', 'no_prefix': ' press press button push', 'tags': '', 'text': '\n Push the red button (lid closed)\n\n Usage:\n push button\n\n '}
    @@ -252,7 +252,7 @@ check if the lid is open or closed.

    -aliases = ['break lid', 'smash lid', 'smash']
    +aliases = ['smash', 'smash lid', 'break lid']
    @@ -279,7 +279,7 @@ break.

    -search_index_entry = {'aliases': 'break lid smash lid smash', 'category': 'general', 'key': 'smash glass', 'no_prefix': ' break lid smash lid smash', 'tags': '', 'text': '\n Smash the protective glass.\n\n Usage:\n smash glass\n\n Try to smash the glass of the button.\n\n '}
    +search_index_entry = {'aliases': 'smash smash lid break lid', 'category': 'general', 'key': 'smash glass', 'no_prefix': ' smash smash lid break lid', 'tags': '', 'text': '\n Smash the protective glass.\n\n Usage:\n smash glass\n\n Try to smash the glass of the button.\n\n '}
    @@ -379,7 +379,7 @@ be mutually exclusive.

    -aliases = ['press button', 'push', 'press']
    +aliases = ['press', 'press button', 'push']
    @@ -408,7 +408,7 @@ set in self.parse())

    -search_index_entry = {'aliases': 'press button push press', 'category': 'general', 'key': 'push button', 'no_prefix': ' press button push press', 'tags': '', 'text': '\n Push the red button\n\n Usage:\n push button\n\n '}
    +search_index_entry = {'aliases': 'press press button push', 'category': 'general', 'key': 'push button', 'no_prefix': ' press press button push', 'tags': '', 'text': '\n Push the red button\n\n Usage:\n push button\n\n '}
    @@ -506,7 +506,7 @@ be mutually exclusive.

    -aliases = ['l', 'examine', 'get', 'ex', 'listen', 'feel']
    +aliases = ['l', 'feel', 'get', 'examine', 'ex', 'listen']
    @@ -532,7 +532,7 @@ be mutually exclusive.

    -search_index_entry = {'aliases': 'l examine get ex listen feel', 'category': 'general', 'key': 'look', 'no_prefix': ' l examine get ex listen feel', 'tags': '', 'text': "\n Looking around in darkness\n\n Usage:\n look <obj>\n\n ... not that there's much to see in the dark.\n\n "}
    +search_index_entry = {'aliases': 'l feel get examine ex listen', 'category': 'general', 'key': 'look', 'no_prefix': ' l feel get examine ex listen', 'tags': '', 'text': "\n Looking around in darkness\n\n Usage:\n look <obj>\n\n ... not that there's much to see in the dark.\n\n "}
    diff --git a/docs/1.0-dev/api/evennia.contrib.tutorials.tutorial_world.objects.html b/docs/1.0-dev/api/evennia.contrib.tutorials.tutorial_world.objects.html index c9d3a3dd93..3aeab41b2a 100644 --- a/docs/1.0-dev/api/evennia.contrib.tutorials.tutorial_world.objects.html +++ b/docs/1.0-dev/api/evennia.contrib.tutorials.tutorial_world.objects.html @@ -425,7 +425,7 @@ of the object. We overload it with our own version.

    -aliases = ['light', 'burn']
    +aliases = ['burn', 'light']
    @@ -452,7 +452,7 @@ to sit on a “lightable” object, we operate only on self.obj.

    -search_index_entry = {'aliases': 'light burn', 'category': 'tutorialworld', 'key': 'on', 'no_prefix': ' light burn', 'tags': '', 'text': '\n Creates light where there was none. Something to burn.\n '}
    +search_index_entry = {'aliases': 'burn light', 'category': 'tutorialworld', 'key': 'on', 'no_prefix': ' burn light', 'tags': '', 'text': '\n Creates light where there was none. Something to burn.\n '}
    @@ -556,7 +556,7 @@ shift green root up/down

    -aliases = ['shiftroot', 'push', 'pull', 'move']
    +aliases = ['move', 'shiftroot', 'push', 'pull']
    @@ -592,7 +592,7 @@ yellow/green - horizontal roots

    -search_index_entry = {'aliases': 'shiftroot push pull move', 'category': 'tutorialworld', 'key': 'shift', 'no_prefix': ' shiftroot push pull move', 'tags': '', 'text': '\n Shifts roots around.\n\n Usage:\n shift blue root left/right\n shift red root left/right\n shift yellow root up/down\n shift green root up/down\n\n '}
    +search_index_entry = {'aliases': 'move shiftroot push pull', 'category': 'tutorialworld', 'key': 'shift', 'no_prefix': ' move shiftroot push pull', 'tags': '', 'text': '\n Shifts roots around.\n\n Usage:\n shift blue root left/right\n shift red root left/right\n shift yellow root up/down\n shift green root up/down\n\n '}
    @@ -609,7 +609,7 @@ yellow/green - horizontal roots

    -aliases = ['press button', 'button', 'push button']
    +aliases = ['push button', 'button', 'press button']
    @@ -635,7 +635,7 @@ yellow/green - horizontal roots

    -search_index_entry = {'aliases': 'press button button push button', 'category': 'tutorialworld', 'key': 'press', 'no_prefix': ' press button button push button', 'tags': '', 'text': '\n Presses a button.\n '}
    +search_index_entry = {'aliases': 'push button button press button', 'category': 'tutorialworld', 'key': 'press', 'no_prefix': ' push button button press button', 'tags': '', 'text': '\n Presses a button.\n '}
    @@ -779,7 +779,7 @@ parry - forgoes your attack but will make you harder to hit on next

    -aliases = ['thrust', 'hit', 'chop', 'bash', 'kill', 'stab', 'pierce', 'slash', 'parry', 'fight', 'defend']
    +aliases = ['pierce', 'slash', 'defend', 'thrust', 'fight', 'chop', 'bash', 'parry', 'kill', 'stab', 'hit']
    @@ -805,7 +805,7 @@ parry - forgoes your attack but will make you harder to hit on next

    -search_index_entry = {'aliases': 'thrust hit chop bash kill stab pierce slash parry fight defend', 'category': 'tutorialworld', 'key': 'attack', 'no_prefix': ' thrust hit chop bash kill stab pierce slash parry fight defend', 'tags': '', 'text': '\n Attack the enemy. Commands:\n\n stab <enemy>\n slash <enemy>\n parry\n\n stab - (thrust) makes a lot of damage but is harder to hit with.\n slash - is easier to land, but does not make as much damage.\n parry - forgoes your attack but will make you harder to hit on next\n enemy attack.\n\n '}
    +search_index_entry = {'aliases': 'pierce slash defend thrust fight chop bash parry kill stab hit', 'category': 'tutorialworld', 'key': 'attack', 'no_prefix': ' pierce slash defend thrust fight chop bash parry kill stab hit', 'tags': '', 'text': '\n Attack the enemy. Commands:\n\n stab <enemy>\n slash <enemy>\n parry\n\n stab - (thrust) makes a lot of damage but is harder to hit with.\n slash - is easier to land, but does not make as much damage.\n parry - forgoes your attack but will make you harder to hit on next\n enemy attack.\n\n '}
    diff --git a/docs/1.0-dev/api/evennia.contrib.tutorials.tutorial_world.rooms.html b/docs/1.0-dev/api/evennia.contrib.tutorials.tutorial_world.rooms.html index a291a00b0d..39aed555ee 100644 --- a/docs/1.0-dev/api/evennia.contrib.tutorials.tutorial_world.rooms.html +++ b/docs/1.0-dev/api/evennia.contrib.tutorials.tutorial_world.rooms.html @@ -248,7 +248,7 @@ code except for adding in the details.

    -aliases = ['l', 'ls']
    +aliases = ['ls', 'l']
    @@ -263,7 +263,7 @@ code except for adding in the details.

    -search_index_entry = {'aliases': 'l ls', 'category': 'tutorialworld', 'key': 'look', 'no_prefix': ' l ls', 'tags': '', 'text': '\n looks at the room and on details\n\n Usage:\n look <obj>\n look <room detail>\n look *<account>\n\n Observes your location, details at your location or objects\n in your vicinity.\n\n Tutorial: This is a child of the default Look command, that also\n allows us to look at "details" in the room. These details are\n things to examine and offers some extra description without\n actually having to be actual database objects. It uses the\n return_detail() hook on TutorialRooms for this.\n '}
    +search_index_entry = {'aliases': 'ls l', 'category': 'tutorialworld', 'key': 'look', 'no_prefix': ' ls l', 'tags': '', 'text': '\n looks at the room and on details\n\n Usage:\n look <obj>\n look <room detail>\n look *<account>\n\n Observes your location, details at your location or objects\n in your vicinity.\n\n Tutorial: This is a child of the default Look command, that also\n allows us to look at "details" in the room. These details are\n things to examine and offers some extra description without\n actually having to be actual database objects. It uses the\n return_detail() hook on TutorialRooms for this.\n '}
    @@ -816,7 +816,7 @@ if they fall off the bridge.

    -aliases = ['h', '?']
    +aliases = ['?', 'h']
    @@ -842,7 +842,7 @@ if they fall off the bridge.

    -search_index_entry = {'aliases': 'h ?', 'category': 'tutorial world', 'key': 'help', 'no_prefix': ' h ?', 'tags': '', 'text': '\n Overwritten help command while on the bridge.\n '}
    +search_index_entry = {'aliases': '? h', 'category': 'tutorial world', 'key': 'help', 'no_prefix': ' ? h', 'tags': '', 'text': '\n Overwritten help command while on the bridge.\n '}
    @@ -968,7 +968,7 @@ to find something.

    -aliases = ['l', 'fiddle', 'feel around', 'search', 'feel']
    +aliases = ['l', 'feel', 'search', 'fiddle', 'feel around']
    @@ -996,7 +996,7 @@ random chance of eventually finding a light source.

    -search_index_entry = {'aliases': 'l fiddle feel around search feel', 'category': 'tutorialworld', 'key': 'look', 'no_prefix': ' l fiddle feel around search feel', 'tags': '', 'text': '\n Look around in darkness\n\n Usage:\n look\n\n Look around in the darkness, trying\n to find something.\n '}
    +search_index_entry = {'aliases': 'l feel search fiddle feel around', 'category': 'tutorialworld', 'key': 'look', 'no_prefix': ' l feel search fiddle feel around', 'tags': '', 'text': '\n Look around in darkness\n\n Usage:\n look\n\n Look around in the darkness, trying\n to find something.\n '}
    diff --git a/docs/1.0-dev/api/evennia.contrib.utils.git_integration.git_integration.html b/docs/1.0-dev/api/evennia.contrib.utils.git_integration.git_integration.html index 374b47bc83..059a78dc28 100644 --- a/docs/1.0-dev/api/evennia.contrib.utils.git_integration.git_integration.html +++ b/docs/1.0-dev/api/evennia.contrib.utils.git_integration.git_integration.html @@ -208,7 +208,7 @@ git evennia pull - Pull the latest evennia code.

    -directory = '/tmp/tmpz0bofrlj/b13f5aee6f67688c5812751f800bae63380c046d/evennia'
    +directory = '/tmp/tmpp30qwhx2/3965f928febc10c0ad2087926b6acc7493183a66/evennia'
    @@ -269,7 +269,7 @@ git pull - Pull the latest code from your current branch.

    -directory = '/tmp/tmpz0bofrlj/b13f5aee6f67688c5812751f800bae63380c046d/evennia/game_template'
    +directory = '/tmp/tmpp30qwhx2/3965f928febc10c0ad2087926b6acc7493183a66/evennia/game_template'
    diff --git a/docs/1.0-dev/api/evennia.prototypes.prototypes.html b/docs/1.0-dev/api/evennia.prototypes.prototypes.html index 3a74de4ba2..de7d91f448 100644 --- a/docs/1.0-dev/api/evennia.prototypes.prototypes.html +++ b/docs/1.0-dev/api/evennia.prototypes.prototypes.html @@ -315,7 +315,7 @@ Note that no locks will be checked if**caller** is not passed.

    -evennia.prototypes.prototypes.search_prototype(key=None, tags=None, require_single=False, return_iterators=False, no_db=False, page_size=None, page_no=None)[source]
    +evennia.prototypes.prototypes.search_prototype(key=None, tags=None, require_single=False, return_iterators=False, no_db=False)[source]

    Find prototypes based on key and/or tags, or all prototypes.

    Keyword Arguments
    diff --git a/docs/1.0-dev/api/evennia.utils.eveditor.html b/docs/1.0-dev/api/evennia.utils.eveditor.html index 1dc64f6357..7c726982f3 100644 --- a/docs/1.0-dev/api/evennia.utils.eveditor.html +++ b/docs/1.0-dev/api/evennia.utils.eveditor.html @@ -336,7 +336,7 @@ indentation.

    -aliases = ['::', ':f', ':dw', ':uu', ':::', ':', ':h', ':A', ':fi', ':UU', ':echo', ':p', ':s', ':wq', ':>', ':dd', ':u', ':r', ':<', ':I', ':fd', ':!', ':q!', ':x', ':q', ':j', ':=', ':y', ':S', ':i', ':w', ':DD']
    +aliases = [':r', ':A', ':::', ':echo', ':S', ':w', ':', ':i', ':!', ':fd', ':uu', ':=', ':u', ':UU', ':fi', ':dd', ':y', ':dw', '::', ':x', ':j', ':DD', ':f', ':s', ':p', ':I', ':q!', ':wq', ':q', ':h', ':>', ':<']
    @@ -364,7 +364,7 @@ efficient presentation.

    -search_index_entry = {'aliases': ':: :f :dw :uu ::: : :h :A :fi :UU :echo :p :s :wq :> :dd :u :r :< :I :fd :! :q! :x :q :j := :y :S :i :w :DD', 'category': 'general', 'key': ':editor_command_group', 'no_prefix': ' :: :f :dw :uu ::: : :h :A :fi :UU :echo :p :s :wq :> :dd :u :r :< :I :fd :! :q! :x :q :j := :y :S :i :w :DD', 'tags': '', 'text': '\n Commands for the editor\n '}
    +search_index_entry = {'aliases': ':r :A ::: :echo :S :w : :i :! :fd :uu := :u :UU :fi :dd :y :dw :: :x :j :DD :f :s :p :I :q! :wq :q :h :> :<', 'category': 'general', 'key': ':editor_command_group', 'no_prefix': ' :r :A ::: :echo :S :w : :i :! :fd :uu := :u :UU :fi :dd :y :dw :: :x :j :DD :f :s :p :I :q! :wq :q :h :> :<', 'tags': '', 'text': '\n Commands for the editor\n '}
    diff --git a/docs/1.0-dev/api/evennia.utils.evmenu.html b/docs/1.0-dev/api/evennia.utils.evmenu.html index a86cbfdc10..0f4c1d00c3 100644 --- a/docs/1.0-dev/api/evennia.utils.evmenu.html +++ b/docs/1.0-dev/api/evennia.utils.evmenu.html @@ -931,7 +931,7 @@ single question.

    -aliases = ['yes', 'abort', 'a', 'y', 'n', '__nomatch_command', 'no']
    +aliases = ['__nomatch_command', 'abort', 'a', 'yes', 'n', 'y', 'no']
    @@ -957,7 +957,7 @@ single question.

    -search_index_entry = {'aliases': 'yes abort a y n __nomatch_command no', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' yes abort a y n __nomatch_command no', 'tags': '', 'text': '\n Handle a prompt for yes or no. Press [return] for the default choice.\n\n '}
    +search_index_entry = {'aliases': '__nomatch_command abort a yes n y no', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' __nomatch_command abort a yes n y no', 'tags': '', 'text': '\n Handle a prompt for yes or no. Press [return] for the default choice.\n\n '}
    diff --git a/docs/1.0-dev/api/evennia.utils.evmore.html b/docs/1.0-dev/api/evennia.utils.evmore.html index 7e8ced9390..23c15a5f09 100644 --- a/docs/1.0-dev/api/evennia.utils.evmore.html +++ b/docs/1.0-dev/api/evennia.utils.evmore.html @@ -137,7 +137,7 @@ the caller.msg() construct every time the page is updated.

    -aliases = ['end', 'next', 'p', 'top', 't', 'q', 'abort', 'a', 'n', 'previous', 'quit', 'e']
    +aliases = ['top', 'abort', 'quit', 'a', 'q', 'previous', 'end', 'e', 'n', 'next', 'p', 't']
    @@ -163,7 +163,7 @@ the caller.msg() construct every time the page is updated.

    -search_index_entry = {'aliases': 'end next p top t q abort a n previous quit e', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' end next p top t q abort a n previous quit e', 'tags': '', 'text': '\n Manipulate the text paging. Catch no-input with aliases.\n '}
    +search_index_entry = {'aliases': 'top abort quit a q previous end e n next p t', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' top abort quit a q previous end e n next p t', 'tags': '', 'text': '\n Manipulate the text paging. Catch no-input with aliases.\n '}
    diff --git a/docs/1.0-dev/index.html b/docs/1.0-dev/index.html index a456f85dc8..de172bdcf8 100644 --- a/docs/1.0-dev/index.html +++ b/docs/1.0-dev/index.html @@ -156,7 +156,7 @@ or the original github wiki. You have been warned.

    All Sections

    - Click here to expand the full list of Documentation sections. + Click here to expand the full Documentation index.
  • Tutorials and Howto’s