From 4f76d255fabd125e5b750af3d1f08815526fd179 Mon Sep 17 00:00:00 2001 From: Griatch Date: Sat, 6 May 2017 14:42:52 +0200 Subject: [PATCH] Add warning about starting without main script. --- evennia/contrib/events/README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/evennia/contrib/events/README.md b/evennia/contrib/events/README.md index 4692f8d74..d72bf1647 100644 --- a/evennia/contrib/events/README.md +++ b/evennia/contrib/events/README.md @@ -62,7 +62,7 @@ When you pick up this object you should see something like: Being in a separate contrib, the event system isn't installed by default. You need to do it manually, following these steps: -1. Launch the main script: +1. Launch the main script (important!): ```@py evennia.create_script("evennia.contrib.events.scripts.EventHandler")``` 2. Set the permissions (optional): - `EVENTS_WITH_VALIDATION`: a group that can edit callbacks, but will need approval (default to @@ -81,6 +81,10 @@ manually, following these steps: The following sections describe in details each step of the installation. +> Note: If you were to start the game without having started the main script (such as when +resetting your database) you will most likely face a traceback when logging in, telling you +that a 'callback' property is not defined. After performing step `1` the error will go away. + ### Starting the event script To start the event script, you only need a single command, using `@py`.