rpg/contrib/README.txt

// $Id: README.txt,v 1.2 2007/09/19 11:54:53 aaron Exp $

=======================
RPG Contributed Modules
=======================

These are modules that depend on the RPG module, but are not necessarily required to run an RPG.

================
RPG Base Classes
================

This module provides the following base classes with which to create attributes.

Number: This will store an integer.
Text: This will store a raw text value. Make sure to run through check_plain, etc. before displaying.
Boolean: This will store true/false.
Array: This will store an array made up of any values.
Figured: This will not store any value, and is meant to be processed exclusively with the 'get' function.
Node: This will store the nid of a Drupal node object.
User: This will store the uid of a Drupal user object.
Object: This will store the rid of an RPG object.
Object Array: This will store an array made up only of RPG objects.

============
RPG Rulesets
============

This module allows Rulesets to be imported & exported, both by contributed Ruleset modules (such as RPG DRUDGE), and by admin screens
that import/export with eval'd php scripts.

You can import a new Ruleset module by visiting /admin/rpg/rulesets, and selecting the Ruleset module you would like to import. This
will take you to a screen with the types that may be imported, where you check the types you would like. If a type depends on another
Ruleset module type that has not yet been loaded, then that type will be grayed out.

After importing types, they will be available from the RPG Types admin screens, and may be modified as normal for other types. However,
make sure not to turn off the Ruleset module once you've imported its types (unless you know precisely what you're doing): most of these
types depend on functions defined in that module. However, you may safely turn off the RPG Rulesets module after importing, if you
desire.

To export types, go to the Export Ruleset tab of the Types admin screen. There, you will see a listing of all types defined in the system.
Check the types you wish to export, and hit submit. This will create a textarea with the php script required to define those types,
which may then be copied and pasted into the Import Ruleset tab on another site, or saved to be distributed as desired.

===========
RPG Message
===========

This allows messages to be displayed to a character. They will normally be displayed in a block (or other method) on page load,
generally at rpg/play. Messages will be displayed to all 'listeners' of an action or event, and may be modified by other modules.

=========
RPG Event
=========

RPG in-game events are processed in a queue. New events are added to the queue. Each event keeps track of when the event was created,
when it should be fired, what function to call, what object fired the event, and what args to call the event with. It also allows for
turns in a game, rather than using system time.

==========
RPG Action
==========

This allows actions to be created by players and NPC's, which will be processed as events.
1	// $Id: README.txt,v 1.2 2007/09/19 11:54:53 aaron Exp $
2
3	=======================
4	RPG Contributed Modules
5	=======================
6
7	These are modules that depend on the RPG module, but are not necessarily required to run an RPG.
8
9	================
10	RPG Base Classes
11	================
12
13	This module provides the following base classes with which to create attributes.
14
15	Number: This will store an integer.
16	Text: This will store a raw text value. Make sure to run through check_plain, etc. before displaying.
17	Boolean: This will store true/false.
18	Array: This will store an array made up of any values.
19	Figured: This will not store any value, and is meant to be processed exclusively with the 'get' function.
20	Node: This will store the nid of a Drupal node object.
21	User: This will store the uid of a Drupal user object.
22	Object: This will store the rid of an RPG object.
23	Object Array: This will store an array made up only of RPG objects.
24
25	============
26	RPG Rulesets
27	============
28
29	This module allows Rulesets to be imported & exported, both by contributed Ruleset modules (such as RPG DRUDGE), and by admin screens
30	that import/export with eval'd php scripts.
31
32	You can import a new Ruleset module by visiting /admin/rpg/rulesets, and selecting the Ruleset module you would like to import. This
33	will take you to a screen with the types that may be imported, where you check the types you would like. If a type depends on another
34	Ruleset module type that has not yet been loaded, then that type will be grayed out.
35
36	After importing types, they will be available from the RPG Types admin screens, and may be modified as normal for other types. However,
37	make sure not to turn off the Ruleset module once you've imported its types (unless you know precisely what you're doing): most of these
38	types depend on functions defined in that module. However, you may safely turn off the RPG Rulesets module after importing, if you
39	desire.
40
41	To export types, go to the Export Ruleset tab of the Types admin screen. There, you will see a listing of all types defined in the system.
42	Check the types you wish to export, and hit submit. This will create a textarea with the php script required to define those types,
43	which may then be copied and pasted into the Import Ruleset tab on another site, or saved to be distributed as desired.
44
45	===========
46	RPG Message
47	===========
48
49	This allows messages to be displayed to a character. They will normally be displayed in a block (or other method) on page load,
50	generally at rpg/play. Messages will be displayed to all 'listeners' of an action or event, and may be modified by other modules.
51
52	=========
53	RPG Event
54	=========
55
56	RPG in-game events are processed in a queue. New events are added to the queue. Each event keeps track of when the event was created,
57	when it should be fired, what function to call, what object fired the event, and what args to call the event with. It also allows for
58	turns in a game, rather than using system time.
59
60	==========
61	RPG Action
62	==========
63
64	This allows actions to be created by players and NPC's, which will be processed as events.