summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--index.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/index.md b/index.md
index efad627..fd5bd2e 100644
--- a/index.md
+++ b/index.md
@@ -67,13 +67,23 @@ To create a new pack, simply create the following things:
* `images/` : existing SexScripts images folder.
* `toy/` : Toy specific sub-folder.
+ * `domme.groovy` : Default mistress configuration (don't change this, it will likely be overwritten).
* `<mistress-name>/` : Mistress specific folder ([Ancilla exmaple](/images/toy/ancilla)).
* `lounge.jpg` : default image used when waiting to be summoned.
+ * `person.groovy` : Mistress specific configuration (should include at least `name` and `fullName`, possibly title)
* `<sub-folder>/` : any number of sub-folders of sets of, ideally all matching, photos (periodically chosen at random based on event requirements and suitably tagged images).
* `tags` : text file containing image tags allowing selection of a suitable random image during play ([Ancilla example](/images/toy/ancilla/dress/tags)).
-
+ * `set.groovy` : Set specific configuration (not required, may be used to configure scene specific sessions)
* `<image-name.jpg>` : any number of images from the photo set. Must be listed in `tags` to be used.
+#### Configuration scripts
+`domme.groovy`, `person.groovy` and `set.groovy` provide the interface for mistress configuration, such as name and title, along with sessions, when the occur, what activities they include.
+
+`domme.groovy` is loaded first, values are then overridden with those from `person.groovy` next and finally overridden with values from `set.groovy`.
+
+`domme.groovy` is provided in the base install of Toy and can serve as an example as well as a capable mistress. Toy also provides `person.groovy` for Ancilla, setting her `name` and `fullName`, but nothing. No `set.groovy` is provided for Ancilla.
+
+#### Tags
The `tags` file should have the following format:
image1:tag1,tag2,tag3