From 84e8ca129fe21040d13ec40bfd21c32e29e159f7 Mon Sep 17 00:00:00 2001 From: Griatch Date: Thu, 23 Nov 2023 19:08:46 +0100 Subject: [PATCH] Update CHANGELOG and autodocs with recent changes --- CHANGELOG.md | 24 +++++++++++++--- docs/source/Coding/Changelog.md | 28 +++++++++++++++---- docs/source/Contribs/Contrib-XYZGrid.md | 27 +++++++++--------- docs/source/Setup/Settings-Default.md | 5 ++++ ...nia.contrib.tutorials.evadventure.tests.md | 1 + ...rib.tutorials.evadventure.tests.test_ai.md | 10 +++++++ docs/source/api/evennia.server.md | 1 + docs/source/api/evennia.server.portal.md | 1 + .../api/evennia.server.portal.service.md | 10 +++++++ docs/source/api/evennia.server.service.md | 10 +++++++ evennia/objects/objects.py | 4 +-- 11 files changed, 97 insertions(+), 24 deletions(-) create mode 100644 docs/source/api/evennia.contrib.tutorials.evadventure.tests.test_ai.md create mode 100644 docs/source/api/evennia.server.portal.service.md create mode 100644 docs/source/api/evennia.server.service.md diff --git a/CHANGELOG.md b/CHANGELOG.md index b384bb6f29..3741ff6230 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,10 +5,12 @@ - [Feature][pull3313] (Backwards incompatible): `OptionHandler.set` now returns `BaseOption` rather than its `.value`. Instead access `.value` or `.display()` on this return for more control. (Volund) +- [Feature][pull3278]: (Backwards incompatible): Refactor home page into multiple sub-parts for easier + overriding and composition (johnnyvoruz) +- [Feature][pull3180]: (Can be backwards incompatible): Make build commands easier to override, with new utility + hooks (Volund) - [Feature][issue3273]: Allow passing `text_kwargs` kwarg to `EvMore.msg` in order to expand the outputfunc used for every evmore page. -- [Feature][pull3278]: Refactor home page into multiple sub-parts for easier - overriding and composition (johnnyvoruz) - [Feature][pull3286]: Allow Discord bot to change user's nickname and assign roles for a user on a given server (holl0wstar). - [Feature][pull3301]: Make EvenniaAdminSite include custom models better; adds @@ -16,9 +18,16 @@ settings.(Volund) - [Feature][pull3179]: Handling of the `.db._playable_characters` helper methods. Also adds events hooks to modify effects when this list changes (Volund) -- [Feature][pull3197]: Make sure Global scripts only start in one place, avoiding race conditions until server starts (Volund) - [Feature][pull3281]: Add `$your()` and `$Your()` for actor stance emoting (Volund) +- [Feature][pull3177]: 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][pull3319]: Refactor/cleanup of Evennia server/portal startup files + into services for easier overriding (Volund) +- [Fix][pull3197]: Make sure Global scripts only start in one place, +- [Fix][pull3324]: Make account-post-login-fail signal fire properly. Add + `CUSTOM_SIGNAL` for adding one's own signals (Volund) - [Fix][pull3267]: Missing recache step in ObjectSessionHandler (InspectorCaracal) - [Fix][pull3270]: Evennia is its own MSSP family now, so we should return that instead of 'Custom' (InspectorCaracal) @@ -26,8 +35,10 @@ (InspectorCaracal) - [Fix][issue3272]: Make sure `ScriptHandler.add` does not fail if passed an instantiated script. (Volund) +- [Fix][pull3338]: Resolve if/elif bug in XYZGrid contrib launch command + (jaborsh) - [Fix][pull3322]: Fix `BaseOption.display` to always return a string. -- Docs: Lots of Typo fixes (iLPdev, InspectorCaracal) +- Docs: Lots of Typo fixes (iLPdev, InspectorCaracal, jaborsh) - Beginner tutorial: Cleanup and starting earlier with explaining how to add to the default cmdsets. @@ -42,6 +53,11 @@ [pull3313]: https://github.com/evennia/evennia/pull/3313 [pull3281]: https://github.com/evennia/evennia/pull/3281 [pull3322]: https://github.com/evennia/evennia/pull/3322 +[pull3177]: https://github.com/evennia/evennia/pull/3177 +[pull3180]: https://github.com/evennia/evennia/pull/3180 +[pull3319]: https://github.com/evennia/evennia/pull/3319 +[pull3324]: https://github.com/evennia/evennia/pull/3324 +[pull3338]: https://github.com/evennia/evennia/pull/3338 [issue3272]: https://github.com/evennia/evennia/issues/3272 [issue3273]: https://github.com/evennia/evennia/issues/3273 diff --git a/docs/source/Coding/Changelog.md b/docs/source/Coding/Changelog.md index 8ee1820f7a..3741ff6230 100644 --- a/docs/source/Coding/Changelog.md +++ b/docs/source/Coding/Changelog.md @@ -5,10 +5,12 @@ - [Feature][pull3313] (Backwards incompatible): `OptionHandler.set` now returns `BaseOption` rather than its `.value`. Instead access `.value` or `.display()` on this return for more control. (Volund) +- [Feature][pull3278]: (Backwards incompatible): Refactor home page into multiple sub-parts for easier + overriding and composition (johnnyvoruz) +- [Feature][pull3180]: (Can be backwards incompatible): Make build commands easier to override, with new utility + hooks (Volund) - [Feature][issue3273]: Allow passing `text_kwargs` kwarg to `EvMore.msg` in order to expand the outputfunc used for every evmore page. -- [Feature][pull3278]: Refactor home page into multiple sub-parts for easier - overriding and composition (johnnyvoruz) - [Feature][pull3286]: Allow Discord bot to change user's nickname and assign roles for a user on a given server (holl0wstar). - [Feature][pull3301]: Make EvenniaAdminSite include custom models better; adds @@ -16,17 +18,27 @@ settings.(Volund) - [Feature][pull3179]: Handling of the `.db._playable_characters` helper methods. Also adds events hooks to modify effects when this list changes (Volund) -- [Feature][pull3197]: Make sure Global scripts only start in one place, avoiding race conditions until server starts (Volund) - [Feature][pull3281]: Add `$your()` and `$Your()` for actor stance emoting (Volund) +- [Feature][pull3177]: 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][pull3319]: Refactor/cleanup of Evennia server/portal startup files + into services for easier overriding (Volund) +- [Fix][pull3197]: Make sure Global scripts only start in one place, +- [Fix][pull3324]: Make account-post-login-fail signal fire properly. Add + `CUSTOM_SIGNAL` for adding one's own signals (Volund) - [Fix][pull3267]: Missing recache step in ObjectSessionHandler (InspectorCaracal) - [Fix][pull3270]: Evennia is its own MSSP family now, so we should return that instead of 'Custom' (InspectorCaracal) - [Fix][pull3274]: Traceback when creating objects with initial nattributes (InspectorCaracal) - [Fix][issue3272]: Make sure `ScriptHandler.add` does not fail if passed an - instantiated script. -- Docs: Lots of Typo fixes (iLPdev) + instantiated script. (Volund) +- [Fix][pull3338]: Resolve if/elif bug in XYZGrid contrib launch command + (jaborsh) +- [Fix][pull3322]: Fix `BaseOption.display` to always return a string. +- Docs: Lots of Typo fixes (iLPdev, InspectorCaracal, jaborsh) - Beginner tutorial: Cleanup and starting earlier with explaining how to add to the default cmdsets. @@ -40,6 +52,12 @@ [pull3197]: https://github.com/evennia/evennia/pull/3197 [pull3313]: https://github.com/evennia/evennia/pull/3313 [pull3281]: https://github.com/evennia/evennia/pull/3281 +[pull3322]: https://github.com/evennia/evennia/pull/3322 +[pull3177]: https://github.com/evennia/evennia/pull/3177 +[pull3180]: https://github.com/evennia/evennia/pull/3180 +[pull3319]: https://github.com/evennia/evennia/pull/3319 +[pull3324]: https://github.com/evennia/evennia/pull/3324 +[pull3338]: https://github.com/evennia/evennia/pull/3338 [issue3272]: https://github.com/evennia/evennia/issues/3272 [issue3273]: https://github.com/evennia/evennia/issues/3273 diff --git a/docs/source/Contribs/Contrib-XYZGrid.md b/docs/source/Contribs/Contrib-XYZGrid.md index 2bcb4d5d95..dfea992dcf 100644 --- a/docs/source/Contribs/Contrib-XYZGrid.md +++ b/docs/source/Contribs/Contrib-XYZGrid.md @@ -269,26 +269,28 @@ LEGEND = {} # the '*' are wildcards and allows for giving defaults on this map. PROTOTYPES = { (0, 0): { - "prototype_parent": "xyz_room", - "key": "A nice glade", - "desc": "Sun shines through the branches above.} + "prototype_parent": "xyz_room", + "key": "A nice glade", + "desc": "Sun shines through the branches above.", + }, (0, 0, 'e'): { - "prototype_parent": "xyz_exit", - "desc": "A quiet path through the foilage" - } + "prototype_parent": "xyz_exit", + "desc": "A quiet path through the foilage", + }, ('*', '*'): { - "prototype_parent": "xyz_room", - "key": "In a bright forest", - "desc": "There is green all around." + "prototype_parent": "xyz_room", + "key": "In a bright forest", + "desc": "There is green all around.", }, ('*', '*', '*'): { - "prototype_parent": "xyz_exit", - "desc": "The path leads further into the forest." + "prototype_parent": "xyz_exit", + "desc": "The path leads further into the forest.", + }, } # collect all info for this one map XYMAP_DATA = { - "zcoord": "mymap" # important! + "zcoord": "mymap", # important! "map": MAPSTR, "legend": LEGEND, "prototypes": PROTOTYPES, @@ -299,7 +301,6 @@ XYMAP_DATA = { XYMAP_DATA_LIST = [ XYMAP_DATA ] - ``` The above map would be added to the grid with diff --git a/docs/source/Setup/Settings-Default.md b/docs/source/Setup/Settings-Default.md index 519021f7b2..a6042aac4b 100644 --- a/docs/source/Setup/Settings-Default.md +++ b/docs/source/Setup/Settings-Default.md @@ -146,6 +146,7 @@ EVENNIA_ADMIN = True # operating between two processes on the same machine. You usually don't need to # change this unless you cannot use the default AMP port/host for # whatever reason. +AMP_ENABLED = True AMP_HOST = "localhost" AMP_PORT = 4006 AMP_INTERFACE = "127.0.0.1" @@ -1174,6 +1175,10 @@ REST_API_ENABLED = False # together with your own variations. You should usually never have to touch # this, and if so, you really need to know what you are doing. +# The primary Twisted Services used to start up Evennia. +EVENNIA_SERVER_SERVICE_CLASS = "evennia.server.service.EvenniaServerService" +EVENNIA_PORTAL_SERVICE_CLASS = "evennia.server.portal.service.EvenniaPortalService" + # The Base Session Class is used as a parent class for all Protocols such as # Telnet and SSH.) Changing this could be really dangerous. It will cascade # to tons of classes. You generally shouldn't need to touch protocols. diff --git a/docs/source/api/evennia.contrib.tutorials.evadventure.tests.md b/docs/source/api/evennia.contrib.tutorials.evadventure.tests.md index 78fb3c7812..3c4466534e 100644 --- a/docs/source/api/evennia.contrib.tutorials.evadventure.tests.md +++ b/docs/source/api/evennia.contrib.tutorials.evadventure.tests.md @@ -13,6 +13,7 @@ evennia.contrib.tutorials.evadventure.tests :maxdepth: 6 evennia.contrib.tutorials.evadventure.tests.mixins + evennia.contrib.tutorials.evadventure.tests.test_ai evennia.contrib.tutorials.evadventure.tests.test_characters evennia.contrib.tutorials.evadventure.tests.test_chargen evennia.contrib.tutorials.evadventure.tests.test_combat diff --git a/docs/source/api/evennia.contrib.tutorials.evadventure.tests.test_ai.md b/docs/source/api/evennia.contrib.tutorials.evadventure.tests.test_ai.md new file mode 100644 index 0000000000..1d2bf3956e --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.evadventure.tests.test_ai.md @@ -0,0 +1,10 @@ +```{eval-rst} +evennia.contrib.tutorials.evadventure.tests.test\_ai +=========================================================== + +.. automodule:: evennia.contrib.tutorials.evadventure.tests.test_ai + :members: + :undoc-members: + :show-inheritance: + +``` \ No newline at end of file diff --git a/docs/source/api/evennia.server.md b/docs/source/api/evennia.server.md index 5a8fc21fb4..9d3a18f77c 100644 --- a/docs/source/api/evennia.server.md +++ b/docs/source/api/evennia.server.md @@ -22,6 +22,7 @@ evennia.server evennia.server.models evennia.server.server evennia.server.serversession + evennia.server.service evennia.server.session evennia.server.sessionhandler evennia.server.signals diff --git a/docs/source/api/evennia.server.portal.md b/docs/source/api/evennia.server.portal.md index a59eb5f70d..bf48ae9f15 100644 --- a/docs/source/api/evennia.server.portal.md +++ b/docs/source/api/evennia.server.portal.md @@ -24,6 +24,7 @@ evennia.server.portal evennia.server.portal.portal evennia.server.portal.portalsessionhandler evennia.server.portal.rss + evennia.server.portal.service evennia.server.portal.ssh evennia.server.portal.ssl evennia.server.portal.suppress_ga diff --git a/docs/source/api/evennia.server.portal.service.md b/docs/source/api/evennia.server.portal.service.md new file mode 100644 index 0000000000..b8012ada9d --- /dev/null +++ b/docs/source/api/evennia.server.portal.service.md @@ -0,0 +1,10 @@ +```{eval-rst} +evennia.server.portal.service +==================================== + +.. automodule:: evennia.server.portal.service + :members: + :undoc-members: + :show-inheritance: + +``` \ No newline at end of file diff --git a/docs/source/api/evennia.server.service.md b/docs/source/api/evennia.server.service.md new file mode 100644 index 0000000000..bd758fe27f --- /dev/null +++ b/docs/source/api/evennia.server.service.md @@ -0,0 +1,10 @@ +```{eval-rst} +evennia.server.service +============================= + +.. automodule:: evennia.server.service + :members: + :undoc-members: + :show-inheritance: + +``` \ No newline at end of file diff --git a/evennia/objects/objects.py b/evennia/objects/objects.py index 94f602be4b..037260ac88 100644 --- a/evennia/objects/objects.py +++ b/evennia/objects/objects.py @@ -3033,8 +3033,8 @@ class DefaultExit(DefaultObject): location (Room): The room to create this exit in. Keyword Args: - account (obj): Account to associate this Exit with. - caller (ObjectDB): the Object creating this Object. + account (AccountDB): Account to associate this Exit with. + caller (ObjectDB): The Object creating this Object. description (str): Brief description for this object. ip (str): IP address of creator (for object auditing). destination (Room): The room to which this exit should go.