mirror of
https://github.com/evennia/evennia.git
synced 2026-03-16 21:06:30 +01:00
Update CHANGELOG and autodocs with recent changes
This commit is contained in:
Griatch
parent
6787f9e5f0
commit
84e8ca129f
11 changed files with 97 additions and 24 deletions
24
CHANGELOG.md
24
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
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
||||
```
|
||||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
10
docs/source/api/evennia.server.portal.service.md
Normal file
10
docs/source/api/evennia.server.portal.service.md
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
```{eval-rst}
|
||||
evennia.server.portal.service
|
||||
====================================
|
||||
|
||||
.. automodule:: evennia.server.portal.service
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
```
|
||||
10
docs/source/api/evennia.server.service.md
Normal file
10
docs/source/api/evennia.server.service.md
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
```{eval-rst}
|
||||
evennia.server.service
|
||||
=============================
|
||||
|
||||
.. automodule:: evennia.server.service
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
```
|
||||
|
|
@ -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.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue