modules/game_character/README.txt

// $Id$

CONTENTS OF THIS FILE
---------------------

 * Introduction and Initial Design Goals
 * Installation


INTRODUCTION AND INITIAL DESIGN GOALS
=====================================

The Game Character module provides a structure and API for Game Character nodes
on your site. You can set one or more node types to be Game Character types
from the Game Character administration page, at admin/settings/game_characters.
At that point, any nodes of that type will be set as game characters, which
may be activated by the owning user, or any user with administrative
permissions.

Characters may be activated or inactivated with provided links. Additionally,
if the node is created by an anonymous user, and that user later logs in, they
may be provided with a unique 'claim character' link which will change
ownership of the node.

By itself, this API currently does little more. However, it may be used in
conjunction with other modules. See the project page for other modules
currently using the Game Character API.


INSTALLATION
============

1. Copy the files to your sites/SITENAME/modules directory.
   Or, alternatively, to your sites/all/modules directory.

2. Enable the Game Character module at admin/build/modules.

3. You can configure Game Characters at admin/settings/game_characters.
   Make sure to enable at least one game character node type from this page.

4. Set any required permissions at admin/user/permissions.

5. To create a character, head to node/add/[node-type].

1	// $Id$
2
3	CONTENTS OF THIS FILE
4	---------------------
5
6	* Introduction and Initial Design Goals
7	* Installation
8
9
10	INTRODUCTION AND INITIAL DESIGN GOALS
11	=====================================
12
13	The Game Character module provides a structure and API for Game Character nodes
14	on your site. You can set one or more node types to be Game Character types
15	from the Game Character administration page, at admin/settings/game_characters.
16	At that point, any nodes of that type will be set as game characters, which
17	may be activated by the owning user, or any user with administrative
18	permissions.
19
20	Characters may be activated or inactivated with provided links. Additionally,
21	if the node is created by an anonymous user, and that user later logs in, they
22	may be provided with a unique 'claim character' link which will change
23	ownership of the node.
24
25	By itself, this API currently does little more. However, it may be used in
26	conjunction with other modules. See the project page for other modules
27	currently using the Game Character API.
28
29
30	INSTALLATION
31	============
32
33	1. Copy the files to your sites/SITENAME/modules directory.
34	Or, alternatively, to your sites/all/modules directory.
35
36	2. Enable the Game Character module at admin/build/modules.
37
38	3. You can configure Game Characters at admin/settings/game_characters.
39	Make sure to enable at least one game character node type from this page.
40
41	4. Set any required permissions at admin/user/permissions.
42
43	5. To create a character, head to node/add/[node-type].
44