Evennia release announcements

[Griatch]

This thread tracks PyPi releases of Evennia. If you prefer using git, we do continuous releases of code on the main Evennia branch.

Use evennia --version from your gamedir to see the version you are currently using (if you use a virtualenv, make sure it's active).

Evennia uses Semantic versioning with a format x.y.z or MAJOR.MINOR.PATCH:

• Patch releases (a.b.z, like 1.1.1, 1.1.2 etc): These are backwards compatible fixes, security updates and refactorings. It does not require you to make any changes to your existing code.
• Minor releases (a.y.0, like 1.1.0, 1.2.0 etc): These are backwards compatible changes, such as new features and contribs. A minor releases can add considerabe new functionality - what matters is that it doesn't require you to change what you already have.
• Major releases (x.0.0, like 1.0.0, 2.0.0, 3.0.0 etc). These are backwards incompatible changes, such as changing the API, how a setting is formatted or how some core functionality operates. A major release will often require you to update something on your end for your game to keep working normally. We will explain how along with the release but to be sure you may want to back up your code before you upgrade. Note that even a relative 'small' code change could trigger a 'major' release, if it breaks backwards-compatibility.

As a reminder, how to upgrade Evennia:

If you are using PyPi packages with pip

If you installed using the default install instructions.

• Read any release notes (in this thread and in the changelog)
• Make sure you are in the right virtualenv (if you are using one) .
• pip install --upgrade evennia
• If the release note tells you to (and only then!), go to your game dir and do evennia migrate. Don't run any makemigrations operations, even if the prompt tells you to.
• Run evennia reboot.

If you are using git main branch

If you installed using the git install instructions.

• The main branch updates faster than the PyPi releases.
• Look at latest commits and/or release notes (in this thread and in the changelog)
• Make sure you are in the right virtualenv (if you are using one) .
• cd to the evennia repo you cloned. Use git branch to verify you are in the main branch.
• git pull
• If the release note tells you to (and only then!), go to your game dir and do evennia migrate. Don't run any makemigrations operations, even if the prompt tells you to.
• Run evennia reboot.

[Griatch]

Evennia 1.0 (Dec 3, 2022) - read release announcement here

[Griatch]

Evennia 1.0.1 (Dec 7, 2022) - bug fixes and release cleanup

[Griatch]

Evennia 1.0.2 (Dec 21, 2022) - bug fixes (notably issue with discord bot). Some doc fixes.

[Griatch]

Evennia 1.1.0 (Jan 7, 2023)

• settings.NEW_ACCOUNT_REGISTRATION_ENABLED added, to allow easily disabling new registrations.
• Bug fixes.

[Griatch]

Evennia 1.1.1 (Jan 15, 2023)

• Bug fix to avoid inconsistent server state if trying to alias channel with an alias containing a regex-sensitive character
• Add attr= keyword to create_channel; this means DEFAULT_CHANNELS setting now also supports adding attributes to channels on creation-time (also updated docs to match).
• Other bug fixes and documentation updates.

[Griatch]

Evennia 1.2.0 (Feb 25, 2023)

• Bug fix: TagHandler.get did not consistently cast to string (aMiss-aWry)
• Bug fix: Channels hard to manage if given in different case (aMiss-aWry)
• Feature: logger.delete_log function for deleting custom logs from inside ther server (aMiss-aWry)
• Doc: Nginx setup (InspectorCaracal)
• Feature: Add fly/dive commands to XYZGrid contrib to showcase treating its Z-axis as a full 3D grid. Also fixed minor bug in XYZGrid contrib when using a Z axis named using an integer rather than a string.
• Bug fix: $an() inlinefunc didn't understand to use 'an' words starting with a capital vowel
• Bug fix: Another case of the 'duplicate Discord bot connections' bug (InspectorCaracal)
• Fix: Make XYZGrid contrib's MapParserErrors more succinct

[Griatch]

Evennia 1.2.1 (Feb 26, 2023)

• Bug fix: Make sure command parser gives precedence to longer cmd-aliases. So if sending smile at and the cmd smile has alias smile at, the match is ordered so the result is never interpreted as smile with an argument at.
• Bug fix: || (escaped color tags) were parsed too early in help entries, leading to colors when wanting a | separator
• Bug fix: Make sure spawned objects get typeclass_path pointing to the true location rather than alias (in line with create_object).
• Bug fix: Building Menu contrib menu no using Replace over Union mergetype to avoid clashing with in-game commands while building
• Feature: RPSystem contrib sdesc command can now view/delete your sdesc.
• Bug fix: Change so script obj = [scriptname|id] is required to manipulate scripts on objects; script scriptname|id only works on global scripts.
• Doc: Add warning about Django-wiki (in wiki tutorial) only supporting Django <4.0.
• Doc: Expanded XYZGrid docstring to clarify MapLink class will not itself spawn anything, children must define their prototypes explicitly.
• Doc: Explained why AttributeProperty.at_get/set will not be called if accessing the Attribute from the AttributeHandler (bypassing the property)
• Bug fix: Evtable options showed spurious empty lines if set without desc
• Usage fix: The teleport: and teleport_here: locks where checked in CmdTeleport, but not actually set on any entities. These locks are now set with defaults on all objects,characters,rooms and exits.

[Griatch]

Evennia 1.3.0 (Apr 4, 2023)

• Feature: Better ANSI color fallbacks (InspectorCaracal).
• Feature: Add support for saving deque with maxlen to Attributes (before maxlen was ignored).
• Fix: The username validator did not display errors correctly in web registration form.
• Fix: Components contrib had issues with inherited typeclasses (ChrisLR)
• Fix: f-string fix in clothing contrib (aMiss-aWry)
• Fix: Have EvenniaTestCase properly flush idmapper cache (bradleymarques)
• Tools: More unit tests for scripts (Storsorken)
• Docs: Made separate doc pages for Exits, Characters and Rooms. Expanded on how to change the description of an in-game object with templating.
• Docs: A multitude of doc issues and typos fixed.

[Griatch]

Evennia 2.0.0 (June 10, 2023)

• Possible backwards incompatibility: Updated contrib ExtendedRoom now supports arbitrary room-states, state-based descriptions, embedded funcparser tags, details and random messages. While this feature is made to be as backwards-compatible as possible, so many people depend on this contrib class that we are updating the major Evennia version to indicate the big changes.
• New Contrib: Container typeclass with new commands for storing and retrieving things inside them (InspectorCaracal)
• Feature: Add TagCategoryProperty for setting categories with multiple tags as properties directly on objects. Complements TagProperty.
• Feature: Attribute-support for saving/loading deques with maxlen= set.
• Feature: Refactor to provide evennia.SESSION_HANDLER for easier overloading and less risks of circular import problems (Volund)
• Fix: Allow webclient's goldenlayout UI (default) to understand msg cls kwarg for customizing the CSS class for every resulting div (friarzen)
• Fix: The AttributeHandler.all() now actually accepts category= as keyword arg, like our docs already claimed it should (Volund)
  Fix: TickerHandler store key updating was refactored, fixing an issue with updating intervals (InspectorCaracal)
• Docs: Removed warning about Python3.11 on Windows; upstream Twistd now supports 3.11 on Windows.
• Docs: New Beginner-Tutorial lessons for NPCs, Base-Combat Twitch-Combat and Turnbased-combat (note that the Beginner tutorial is still WIP).
• Stabilize how to make the major update in the docs.
• Fix: A lot of other minor bug fixes.

[Griatch]

Evennia 2.0.1 (June 17, 2023)

• Fix: Resolve a detail-look bug reported on the new ExtendedRoom contrib (thanks, InspectorCaracal!)

[Griatch]

Evennia 2.1.0 (July 14, 2023)

• Feature: Add SSL_CERTIFICATE_ISSUERS setting for customizing Telnet+SSL.
• Fix: The new ExtendedRoom contrib has a bug when dug with no descriptions.
• Fix: Clean up get_sides function in evadventure tutorial to return also the calling combatant with its allies return, to make it easier to reason around.
• Contrib: Refactored dice.roll contrib function to use safe_eval. Can now optionally be used as dice.roll("2d10 + 4 > 10"). Old way works too.
• Lots of doc updates.

[Griatch]

Evennia 2.2.0 (August 6, 2023)

• Contrib: Large-language-model (LLM) AI integration; allows NPCs to talk using responses from an LLM server.
• Fix: Make sure at_server_reload is called also on non-repeating Scripts.
• Fix: Webclient was not giving a proper error when sending an unknown outputfunc to it.
• Fix: Make py command always send strings unless client_raw flag is set.
• Fix: Script.start with an integer start_delay caused a traceback.
• Fix: Removing "Guest" from the permission-hierarchy setting messed up access.
• Docs: Remove doc pages for Travis/TeamCity CI tools, they were both very much out of date, and Travis is not free for OSS anymore.
• Docs: A lot fixes of typos and bugs in tutorials.

[Griatch]

Evennia 2.3.0 (Sept 3, 2023)

• Feat: EvMenu tooltips for multiple help categories in a node (Seannio).
• Feat: Default examine command now also shows an account's last_login (michaelfaith84)
• Fix: Portal would accidentally start global scripts. (blongden)
• Fix: Traceback when printing CounterTrait contrib objects. (InspectorCaracal)
• Fix: Typo in evadventure twitch combat's call of create_combathandler.
• Docs: Fix bug in evadventure equipmenthandler blocking creation of npcs in-game.
• Docs: Plenty of typo fixes (iLPDev, moldikins, others)

[Griatch]

Note: Portal global script fix was wrongly attributed. Corrected now.

[Griatch]

Evennia 3.0.0 (2023-12-20)

• New Requirements: Twisted 23.10 (<24) to address upstream CVE alert. Django 4.2 (<4.3)

Backwards incompatible changes

• New Requirement (potentially Backwards incompatible): Django 4.2 (<4.3). Increases
  minimum supported versions of MariaDB, MySQL and PostgreSQL,
  see [django release nodes][django-release-notes]
• Feature (Backwards incompatible): OptionHandler.set now returns
  BaseOption rather than its .value. Instead access .value or .display()
  on this return for more control. (Volund)
• Feature: (Backwards incompatible): Refactor home page into multiple sub-parts for easier
  overriding and composition (johnnyvoruz)
• Fix (Backwards incompatible): Change settings._TEST_ENVIRONMENT to
  settings.TEST_ENVIRONMENT to address issues during refactored startup sequence.
• Feature: (Potentially Backwards incompatible): Make build commands
  easier to override, with new utility hooks (Volund)

Other changes

• Feature: Allow passing text_kwargs kwarg to EvMore.msg in order to expand
  the outputfunc used for every evmore page.
• Feature: Allow Discord bot to change user's nickname and assign
  roles for a user on a given server (holl0wstar).
• Feature: Make EvenniaAdminSite include custom models better; adds
  DJANGO_ADMIN_APP_ORDER and DJANGO_ADMIN_APP_EXCLUDE as modifable
  settings.(Volund)
• Feature: Handling of the .db._playable_characters helper
  methods. Also adds events hooks to modify effects when this list changes (Volund)
  avoiding race conditions until server starts (Volund)
• Feature: Add $your() and $Your() for actor stance emoting (Volund)
• Feature: Add Account.get_character_slots(),
  .get_available_character_slots(), .check_available_slots and
  at_post_create_character methods to allow better customization of character creation (Volund)
• Feature: Refactor/cleanup of Evennia server/portal startup files
  into services for easier overriding (Volund)
• Feature: Add support for Attribute-categories when using the monitorhandler
  with input funcs to monitor Attribute changes.
• Feature: Add Command.cmdset_source, referring to the cmdset each
  command was originally pulled from (Volund)
• Feature: Add access_type as optional kwarg to lockfuncs (Volund)
• Feature: New middleware for checking IP/subnets from requests. New
  tools evennia.utils.match_ip and utils.ip_from_request to help. (Volund)
• Feature: Refactored almost all default commands to use
  Command.msg over the command.caller.msg direct call (more flexible) (Volund)
• Feature: Refactor cmdhandler to be more extensible; make cmd merge
  a bit more deterministic (Volund)
• Feature: Make Fallback AJAX web client more customizable (same as
  the websocket client) (Volund)
• Feature: Add unique id to each webclient instance, separates play
  sessions run from the same browser. (InpsectorCaracal)
• Feature: Make the rpsystem contrib's prefix (/ by default)
  configurable with a setting (used to be hard-coded) (InspectorCaracal)
• Fix: New generate_default_locks() method on typeclasses;
  .create and lockhandler.add() will now properly handle emptry strings
  (Volund)
• Fix: Make sure Global scripts only start in one place,
• Fix: Make account-post-login-fail signal fire properly. Add
  CUSTOM_SIGNAL for adding one's own signals (Volund)
• Fix: Missing recache step in ObjectSessionHandler (InspectorCaracal)
• Fix: Evennia is its own MSSP family now, so we should return that
  instead of 'Custom' (InspectorCaracal)
• Fix: Traceback when creating objects with initial nattributes
  (InspectorCaracal)
• Fix: Make sure ScriptHandler.add does not fail if passed an
  instantiated script. (Volund)
• Fix: CmdHelp was using the wrong protocol-key identifier when
  routing to the ajax web client.
• Fix: Resolve if/elif bug in XYZGrid contrib launch command
  (jaborsh)
• fix: Made XYZGrid query zcoords in a case-insensitive manner.
• Fix: Fix BaseOption.display to always return a string.
• Fix: Fix so Portal resets server_restart_mode flag when having
  successfully reconnected to the Server after a restart. (InspectorCaracal)
• Fix: Fix gendersub contrib to use proper pronoun when referencing
  other objects than oneself (InspectorCaracal)
• Fix: Fix of monitoring Attributes with categories (scyfris)
• Docs & docstrings: Lots of Typo and other fixes (iLPdev, InspectorCaracal, jaborsh,
  HouseOfPoe etc)
• Beginner tutorial: Cleanup and starting earlier with explaining how to add to
  the default cmdsets.

[Griatch]

Evennia 3.1.0

Jan 8, 2023

• Feature: EvMenu will only use one column of options in
  screenreader mode (InspectorCaracal)
• Feature: Add VS code files to default gitignore (InspectorCaracal)
• Fix: Errors when using the default create command (InspectorCaracal).
• Fix: tunnel command didn't work with custom prefix (chromancer).
• Fix: Error when falling back to default cmdset fallback
  (InspectorCaracal)
• Fix: character_creator updated with new chargen system refactor
  in Evennia 3.0.0; fix issue not repspecting START_LOCATION
  (InspectorCaracal)
• Fix: Default-add 'where' as a LUNR search exception, since it's a
  common mud command that should not be ignored. (alephate)
• Fix: Make sure global scripts start properly on restart
  (InspectorCaracal)
• Fix: Fix time-of-day issue in ExpandedRoom contrib (jaborsh)
• Doc fixes (homeofpoe, gas-public-wooden-clean, InspectorCaracal)

[Griatch]

Evennia 3.1.1

Jan 14, 2024

Patch release.

• Fix: Fix to make e.g. elvish"Hello" work correctly in language rp
  contrib (InspectorCaracal)
• Fix: Fix/update of Godot client contrib to support Godot4 and
  latest Evennia portal changes (ChrisLR)
• Updated doc on wiki install (InspectorCaracal)
• Docstring fixes (bradleymarques)
• Doc tutorial fixes

[Griatch]

Evennia 3.2.0

Feb 25, 2024

Minor release.

• Feature: Add evennia.ON_DEMAND_HANDLER for making it
  easier to implement changes that are calculated on-demand (Griatch)
• Feature: Make it possible to add custom webclient css in
  webclient/css/custom.css, same as for website (InspectorCaracal)
• Feature: Component contrib got better
  inheritance, slot names to choose attr storage, speedups and fixes (ChrisLR)
• Feature: Break up DefaultObject.search method into several helpers to make
  it easier to override (Griatch)
• Fix: Resolve multimatch error with rpsystem contrib (Griatch)
• Fix: Remove AMP_ENABLED setting since it services no real purpose and
  erroring out on setting it would make it even less useful (Griatch).
• Feature: Remove too-strict password restrictions for Evennia logins, using
  django defaults instead for passwords with more varied characters. (Griatch)
• Fix services command with no args would traceback (regression) (Griatch)
• Fix: Fix wilderness contrib error moving to an already existing
  wilderness room (InspectorCaracal)
• Fix: Don't always include example the crafting recipe when
  using the crafting contrib (InspectorCaracal)
• Fix: Traceback banning a channel using with only one nick
  (InspectorCaracal)
• Fix: Adjust lunr search weights to void clashing of cmd-aliases over
  keys which caused some help entries to shadow others (InspectorCaracal)
• Fix: Make menu/email_login contribs honor NEW_ACCOUNT_REGISTRATION_ENABLED
  setting (Griatch)
• Doc fixes (InspectorCaracal, Griatch)

[Griatch]

Evennia 4.0.0

March 17, 2024

Major release. Check out for backwards-incompatible changes below.

Version updates

• Feature: Support Python 3.12 (Griatch). Currently supporting 3.10,3.11 and 3.12. Note that 3.10 support will be removed in a future release.
• Feature: Update evennia[extra] scipy dependency to 1.12 to support latest Python. Note that this may change which (equivalent) path is being picked when following an xyzgrid contrib pathfinding.

Backwards incompatible changes

• Feature: Backwards incompatible: DefaultObject.get_numbered_name now gets object's name via .get_display_name for better compatibility with recog systems.
• Feature: Backwards incompatible: Removed the (#dbref) display from DefaultObject.get_display_name, instead using new .get_extra_display_name_info method for getting this info. The Object's display template was extended for optionally adding this information. This makes showing extra object info to admins an explicit action and opens up get_display_name for general use.
• Fix: (partly Backwards incompatible depending on your usage): DefaultObject.get_numbered_name used .name instead of
  .get_display_name before, which broke recog systems.

New features

• Feature: Add ON_DEMAND_HANDLER.set_dt(key, category, dt) and .set_stage(key, category, stage) to allow manual tweaking of task timings, for example for a spell speeding a plant's growth (Griatch)
• Feature: Add ON_DEMAND_HANDLER.get_dt/stages(key,category, **kwargs), where the kwargs are passed into any stage-callable defined with the stages. (Griatch)
• Feature: Add use_assertequal kwarg to the EvenniaCommandTestMixin testing class; this uses django's assertEqual over the default more lenient checker, which can be useful for testing table whitespace (Griatch)
• Feature: New utils.group_objects_by_key_and_desc for grouping a list of objects based on the visible key and desc. Useful for inventory listings (Griatch)
• Feature: Add DefaultObject.get_numbered_name return_string bool kwarg, for only returning singular/plural based on count instead of a tuple with both (Griatch)

Bug and security fixes

• Fix Removed the @reboot alias to @reset to not mislead people into thinking you can do a portal+server reboot from in-game (you cannot) (Griatch)
• Fix: Refactor Clothing contrib's inventory command align with Evennia core's version (michaelfaith84, Griatch)
• Fix: Limiting search by tag didn't take search-string into account (Griatch)
• Fix: SSH connection caused a traceback in protocol (Griatch)
• Fix: Resolve a bug when loading on-demand-handler data from database (Griatch)
• Security: Potential O(n2) regex exploit in rpsystem regex (Griatch)
• Security: Fix potential redirect vulnerability in character page redirect (Griatch)
• Doc fixes (iLPdev, Griatch, CloudKeeper)

[Griatch]

Evennia 4.1.0

April 1, 2024

Deprecations

• [Deprecation]: DefaultObject.get_visible_contents - unused in core, will be removed in the future. Use the new .filter_visible together with the .get_display_* methods instead..
• [Deprecation]: DefaultObject.get_content_names - unused in core, will be removed in the future. Use the DefaultObject.get_display_* methods instead.

Features

• Feature: New utils.compress_whitespace utility used with default object's .format_appearance to make it easier to overload without adding line breaks in hook returns. (InspectorCaracal)
• Feature: New sethelp/category switch to change a help topic's category after it was created (chiizujin)
• Feature: Add alias/delete switch for removing object aliases from in-game with default command (chiizujin)
• Feature: The default page command now tags its Msg objects with tag 'page' (category 'comms') and also checks the Msg' 'read' lock. Made backwards compatible for old pages (Griatch)
• Feature: Add optional no_article kwarg to DefaultObject.get_numbered_name for the system to skip adding automatic
  articles. (chiizujin)
• Feature: Add ability to default get/drop to affect stacks of items, such as get/drop 3 rock by a custom class parent (InspectorCaracal)
• Feature: Clean up the default Command variable list shown when a command has no func() defined (Griatch)
• Feature: Add DefaultObject.filter_visible helper method to make it easier to customize object visibility rules. (Griatch)

Fixes

• Fix: Use plural ('no apples') instead of singular ('no apple') in get_numbered_name for better grammatical form (InspectorCaracal)
• Fix: Object aliases not showing in search multi-match disambiguation display (chiizujin)
• Fix: sethelp/edit <topic> without a = text created a None entry that would lose the edit. (chiiziujin)
• Fix: format_grid utility used for help command caused commands to disappear for wider client widths (chiizujin)
• Fix: Help topic categories with different case would appear as duplicates (chiizujin)
• Fix: Traceback in crafting contrib's recipe.msg (InspectorCaracal)
• Fix: EvEditor line-echo compacted whitespace erroneously (chiizujin)
• Fix: EvEditor :help described the :paste operation in the wrong way (chiizujin)
• Fix: EvEditor range:range specification didn't return correct range (chiizujin)
• Fix: EvEditor :UU and :DD etc commands were not properly differentiating from their lower-case alternatives (Griatch)
• Fix: The menu_login contrib regression caused it to error out when creating a new character (Griatch)
• Doc: Added Beginner Tutorial lessons for Monster and NPC AI, Quests and Making a Procedural dungeon (Griatch)
• Doc fixes (Griatch, InspectorCaracal, homeofpoe)

[Griatch]

Evennia 4.1.1

April 6, 2024

• Fix: Error with 'you' mapping in third-person style of msg_contents (InspectorCaracal)
• [Fix][pull3472]: The new filter_visible didn't exclude oneself by default (InspectorCaracal)
• Fix: find #dbref results didn't include the results of .get_extra_display_name_info (the #dbref display by default) (Griatch)
• Fix: Add DefaultAccount.get_extra_display_name_info method for API compliance with DefaultObject in commands. (Griatch)
• Fix: Show XYZRoom subclass when repr() it. (Griatch)
• Fix: Typo in sethome message (chiizujin)
• Fix: Fix traceback when using get,drop and give with no arguments (InspectorCaracal)
• Fix: Don't ignore EvEditor commands with wrong capitalization (Griatch)
• Fix: The at_server_reload_start() hook was not firing on a reload (regression).
• Fix: AttributeProperty(<default>, autocreate=False), where <default> was mutable would not update/save properly in-place (Griatch)
• [Docs] Added new Server-Lifecycle page to describe the hooks called on server start/stop/reload (Griatch)
• [Docs] Doc typo fixes (Griatch, chiizujin)