About News Download Docs Bugs Contact





Personal grimoires

It's possible to create your own Grimoire for local usage or public consumption.

All you have to do is described in 3 steps:

  1. create a directory with the same structure (grimoire/section)
  2. add it to Sorcery config file with all grimoires defined (/etc/sorcery/local/grimoire) while incrementing an index
  3. mark it local with scribe localize (so scribe won't try to update it on scribe update)

For example:

# scribe index

Codex Listing

 [0] : stable : /var/lib/sorcery/codex/stable : 0.61-20

Let's create a new grimoire with a name "craft":

# mkdir /var/lib/sorcery/codex/craft
# cat /etc/sorcery/local/grimoire
# echo "GRIMOIRE_DIR[1]=/var/lib/sorcery/codex/craft" >> /etc/sorcery/local/grimoire

Note the GRIMOIRE_DIR[1].

Make sure it appears in the Codex:

# scribe index

Codex Listing

 [0] : stable : /var/lib/sorcery/codex/stable : 0.61-20
 [1] : craft : /var/lib/sorcery/codex/craft

Now we will copy some simple spell (which doesn't use specific functions from FUNCTIONS file in grimoire's root directory, otherwise you need to copy/link these files from the existent grimoire):

# mkdir /var/lib/sorcery/codex/craft/utils
# cp -R /var/lib/sorcery/codex/stable/utils/acpid /var/lib/sorcery/codex/craft/utils/

With the next command we will swap the grimoires to rise "craft" priority:

# scribe swap stable craft
# scribe index

Codex Listing

 [0] : craft : /var/lib/sorcery/codex/craft
 [1] : stable : /var/lib/sorcery/codex/stable : 0.61-20

and reindex all spells in it:

# scribe reindex craft

Note: you need to do this every time you add/remove any spell to/from it.

Since now cast acpid will cast "acpid" from your new "craft" grimoire. You can modify the spell (i.e. change version and update checksum to downgrade or upgrade it), add or remove configure flags and so on. Take a look at our Spellbook for more information about spell-writing.

Alternative way with Scribbler

You can also manage spells between grimoires with a scribbler command which does all that custom grimoire magic.

Grimoires from developers

Provider Name Type Description Use
~stealth Prototype rsync Missing spells from the stable grimoire and some spells' prototypes which will go into test when ready scribe add prototype from rsync://rsync.stealth.zone::codex/prototype/
~PyroBor pyrogrimoire git Personal grimoire of PyroBor (collection of spells that are not available in official grimoire) scribe add pyrogrimoire from git://github.com/PyroBor/pyrogrimoire.git
~Belxjander Shadows git scribe add shadows from git_http://code.google.com/p/belxjandershadow/
~Belxjander Vampire git Cross Development Toolkits scribe add vampire from git_http://code.google.com/p/belxjandervampire/
~ruskie arcane git Arcane grimoire for Source Mage with various bits and pieces scribe add arcane from git_http://repo.or.cz/r/grimoire-arcane.git
~ruskie witchcraft git Witchcraft grimoire with WIP changes for running Source Mage stuff on FreeBSD scribe add witchcraft from git_http://repo.or.cz/r/grimoire-witchcraft.git
~ruskie planeshift git A grimoire containing planeshift spells scribe add planeshift from git_http://repo.or.cz/r/grimoire-planeshift.git