From 98e7fecd379b9e5a04bb6dcd87d0572b9354a2d0 Mon Sep 17 00:00:00 2001 From: Evennia docbuilder action Date: Wed, 10 Jul 2024 17:03:41 +0000 Subject: [PATCH] Updated HTML docs. --- docs/latest/.buildinfo | 2 +- docs/latest/Concepts/Colors.html | 102 +++++++++++++++++- .../Concepts/Tags-Parsed-By-Evennia.html | 1 + .../evennia/commands/default/building.html | 2 +- .../_modules/evennia/objects/objects.html | 12 +-- docs/latest/_sources/Concepts/Colors.md.txt | 53 ++++++++- docs/latest/_sources/index.md.txt | 2 +- .../api/evennia.commands.default.admin.html | 4 +- ...evennia.commands.default.batchprocess.html | 4 +- .../evennia.commands.default.building.html | 8 +- .../api/evennia.commands.default.comms.html | 8 +- .../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 | 16 +-- ....base_systems.email_login.email_login.html | 16 +-- ...b.base_systems.ingame_python.commands.html | 4 +- ...systems.mux_comms_cmds.mux_comms_cmds.html | 4 +- ...rib.full_systems.evscaperoom.commands.html | 16 +-- ...ame_systems.achievements.achievements.html | 4 +- ...ia.contrib.game_systems.barter.barter.html | 4 +- ...ontrib.game_systems.clothing.clothing.html | 4 +- ...evennia.contrib.grid.xyzgrid.commands.html | 4 +- ...utorials.evadventure.combat_turnbased.html | 4 +- ...ontrib.tutorials.evadventure.commands.html | 4 +- ...ntrib.tutorials.red_button.red_button.html | 16 +-- ...trib.tutorials.tutorial_world.objects.html | 16 +-- ...ontrib.tutorials.tutorial_world.rooms.html | 8 +- ...utils.git_integration.git_integration.html | 4 +- docs/latest/api/evennia.objects.objects.html | 31 +++++- docs/latest/api/evennia.utils.eveditor.html | 4 +- docs/latest/api/evennia.utils.evmenu.html | 4 +- docs/latest/api/evennia.utils.evmore.html | 4 +- docs/latest/genindex.html | 8 +- docs/latest/index.html | 2 +- docs/latest/objects.inv | Bin 170348 -> 170426 bytes docs/latest/searchindex.js | 2 +- 37 files changed, 281 insertions(+), 118 deletions(-) diff --git a/docs/latest/.buildinfo b/docs/latest/.buildinfo index 754441ca55..ca2f68b5bf 100644 --- a/docs/latest/.buildinfo +++ b/docs/latest/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 84f0b659142f5d5adf5b42274a4bf582 +config: b26d044560cd04bc8dd1676294af2977 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/latest/Concepts/Colors.html b/docs/latest/Concepts/Colors.html index 664fa89331..8cf3cdb22d 100644 --- a/docs/latest/Concepts/Colors.html +++ b/docs/latest/Concepts/Colors.html @@ -72,6 +72,7 @@
  • Xterm256 Colours
    • +
  • 24-bit Colors (True color)
    • @@ -219,10 +220,28 @@ will see the text in the specified colour, otherwise the tags will be stripped (

    foreground color that inherits brightness from previous tags. Always uppcase, like |!R

    |h

    -

    make any following foreground ANSI colors bright (no effect on Xterm colors). Use with |!#. Technically, |h|G == |g.

    +

    make any following foreground ANSI colors bright (for Xterm256/true color makes the font bold if client supports it). Use with |!#. Technically, |h|G == |g.

    |H

    -

    negates the effects of |h, return foreground to normal (no effect on Xterm colors)

    +

    negates the effects of |h

    + +

    |u

    +

    underline font if client supports it

    + +

    |U

    +

    negates the effects of |u

    + +

    |i

    +

    italic font if client supports it

    + +

    |I

    +

    negates the effects of |i

    + +

    |s

    +

    strikethrough font if client supports it

    + +

    |S

    +

    negates the effects of |s

    |/

    line break. Use instead of Python \n when adding strings from in-game.

    @@ -293,8 +312,8 @@ actually change the background color instead of the foreground:

    -

    For a detailed explanation of these caveats, see the [Understanding Color Tags](Understanding-Color- -Tags) tutorial. But most of the time you might be better off to simply avoid |* and mark your text +

    For a detailed explanation of these caveats, see the Understanding Color Tags +tutorial. But most of the time you might be better off to simply avoid |* and mark your text manually instead.

    @@ -382,6 +401,81 @@ the closest equivalent ANSI color. You can mix Xterm256 tags with ANSI tags as y

    to get a table of all the 256 colours and the codes that produce them. If the table looks broken up into a few blocks of colors, it means Xterm256 is not supported and ANSI are used as a replacement. You can use the options command to see if xterm256 is active for you. This depends on if your client told Evennia what it supports - if not, and you know what your client supports, you may have to activate some features manually.

    +
    +

    24-bit Colors (True color)

    + +

    Some clients support 24-bit colors. This is also called true color. +Not all clients support true color, they will instead see the closest equivalent. It’s important to bear in mind that things may look quite +different from what you intended if you use subtle gradations in true color and it’s viewed with a client that doesn’t support true color. +The hexadecimal color codes used here are the same ones used in web design.

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

    Tag

    Effect

    |#$$$$$$

    foreground RGB (red/green/blue), 6-digit hexadecimal format, where $ = 0-F

    |[#$$$$$$

    background RGB

    |#$$$

    foreground RGB (red/green/blue), 3-digit hexadecimal format.

    |[#$$$

    background RGB

    +

    Some 6-digit examples:

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

    Tag

    Effect

    |#ff0000

    bright red foreground

    |#00ff00

    bright green foreground

    |#0000ff

    bright blue foreground

    |#[ff0000

    bright red background

    +

    Some 3-digit examples:

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

    Tag

    Effect

    |#f00

    bright red foreground

    |#0f0

    bright green foreground

    |#00f

    bright blue foreground

    |[#f00

    bright red background

    +
    diff --git a/docs/latest/Concepts/Tags-Parsed-By-Evennia.html b/docs/latest/Concepts/Tags-Parsed-By-Evennia.html index 6dfa30666e..fc758a3fa8 100644 --- a/docs/latest/Concepts/Tags-Parsed-By-Evennia.html +++ b/docs/latest/Concepts/Tags-Parsed-By-Evennia.html @@ -117,6 +117,7 @@
  • Colors
  • Clickable links