Michael Sinclair (rykos) wrote in gamine_dev,
Michael Sinclair
rykos
gamine_dev

Documentation Updated

!!!
// ==============================================
//	CONTENTS (Pg000)
// ==============================================
// 	To quickly get to one of these sections, simply press
//	Ctrl+F and search for the page code (Pg###)
//
// 	• Pg000 ............. Contents
// 	• Pg001 ............. Ability Details
// 	• Pg002 ............. Rank Details
//	... Pg002-01 ............. General Member
//	... Pg002-02 ............. Local Moderator
//	... Pg002-03 ............. Global Moderator
//	... Pg002-04 ............. Developer
//	... Pg002-05 ............. Land Leader
//	... Pg002-06 ............. Administrator
//	... Pg002-07 ............. Banned
// 	• Pg004 ............. Title Details
// 	• Pg005 ............. Class Details
// 	• Pg999 ............. Table Setups
//	... Pg999-01 ............. User Accounts
//	... Pg999-02 ............. User Permissions
//	... Pg999-03 ............. Characters
//	... Pg999-04 ............. Character Titles
//	... Pg999-05 ............. News
//	... Pg999-06 ............. (Forum) Areas
//	... Pg999-07 ............. (Forum) Topics
//	... Pg999-08 ............. (Forum) Posts
//	... Pg999-09 ............. Journal
//	... Pg999-10 ............. Messages
//	... Pg999-11 ............. Settings
//	... Pg999-12 ............. (Template) Cache
//	... Pg999-13 ............. (Template) Source
//	... Pg999-14 ............. Voting
//
//
//
// ==============================================
// [contents]	ABILITY DETAILS - BASIC GUIDE (Pg001)
// ==============================================
//
// A users site abilities determine what a user can and cannot do
// in regards to permissions. Most, if not all, are pretty much self
// explainatory. Abilities are not displayed except via the level
// management section. You are able to create any number of
// combinations to specify exactly what you want to allow your
// users what they can and cannot modify.
//
// These apply to administration of stated areas only, these do not
// apply to general user access. Eg. A user does not need "Voting"
// in order to vote.
//
// General Management:
//	• ** Currently unused
// Moderator:
//	• Delete posts
//	• Delete threads
//	• Move threads
//	• Move posts
//	• Moderate all areas even if not set
// Voting:
//	• Start new voting topics
//	• Reset voting topics
//	• Modifiy existing voting topics
// News:
//	• Post new News topics
//	• Remove/Modify posted topics (if original poster only)
// Users:
//	• Edit user information
//	• Delete users
//	• Ban users
//	• View all user information (this does not include password)
// Access log:
//	• View access log
// Levels:
//	• Create user levels
//	• Modify existing user levels
//	• Delete existing user levels
// Layout:
//	• Modify site layout
// Pages:
//	• Add/Remove pages
//	• Modify pages
//	• Set page restrictions
// Site Content:
//	• ** Currently unused
// Messageboard:
//	• Add/Remove areas
//	• Create topics/categories
//	• Modify existing topics/categories
//	• Set moderators
//
// ** Denotes an unassigned ability that may be used in the future
//
// #####################################################
//
// ==============================================
// [contents]	RANKS - BASIC GUIDE (Pg002)
// ==============================================
//
// Ranks distinguish general users' authority amongst one another.
// They are displayed with all information pertaining to a general
// user and his or her account.
//
// Ranks are modified by those with level management. They
// are applied to users via a dropdown list available in user
// management. This means you may have a user in charge of
// existing ranks, and another user in charge of who receives
// what rank.
//
// The following list is just a general idea:
//
// --------------------------------------------------------------------
// [contents] [ranks]	General Member (Pg002-01)
//
// All accounts submitted will start as a "General Member". This
// holds true unless an account is added manually by an admin,
// and the admin has a reason to add them as something other than
// a general member.
//
//	• Access to all unrestricted areas
//		Within unrestricted areas:
//		• Ability to post
//		• Ability to vote
//	• Ability to create/edit characters
// --------------------------------------------------------------------
//
// --------------------------------------------------------------------
// [contents] [ranks]	Local Moderator (Pg002-02)
//
// Local moderators hold the task of keeping their board(s) free of
// clutter, as well as moderating board activity. If there is a discrepancy
// within an area, that is where the local moderators come in. They
// may also enforce punishment within their area, which includes the
// ability to ban a player from the area(s) which they moderate.
//
//	• Able to delete posts/threads within assigned area(s)
//	• Able to move posts/threads from assigned area(s)
//	• Able to place/remove bans to assigned area(s) on players
// --------------------------------------------------------------------
//
// --------------------------------------------------------------------
// [contents] [ranks]	Global Moderator (Pg002-03)
//
// Much like a local moderator, except they have the ability to
// moderator all areas. As well, they can ban users from all areas.
// While local moderators are capable of keeping their area(s) clean,
// global moderators are always there should need arise for them to
// take care of cross-area problems. Local moderators are also
// encouraged to work together to take care of problems.
//
// While they can also recall bans made by other moderators, players
// should not think they can plead to another moderator to remove their
// ban. In most cases, the moderator in question put the ban in place
// for a reason. If a player feels a wrong has been made, they are free to
// take it up with an admin.
//
//	• Able to delete posts/threads within all areas
//	• Able to move posts/threads to and from all areas
//	• Able to place/remove bans to all areas
//	• Able to recall bans made by other moderators
// --------------------------------------------------------------------
//
// --------------------------------------------------------------------
// [contents] [ranks]	Developer (Pg002-04)
//
// Developer's are responsible for several areas, these include adding
// and updating site content and generally keeping the game fresh.
// When it comes to developing new story lines and bringing out the
// life in the world, these are the people you want to turn to.
//
//	• Able to work on site layout
//	• Able to work on pages
//	• Able to post news
//	• Can create voting topics
// --------------------------------------------------------------------
//
// --------------------------------------------------------------------
// [contents] [ranks]	Land Leader (Pg002-05)
//
// Each "site", or division of land is held accountable by one or more
// people. They are similar to admins, except they are only able to
// work on the site(s) they are assigned to. They are also responsible
// for keeping the boards clean and the gaming fresh. Land leaders
// are able to designate their own local moderators and developers.
// They may also restrict a player from their "site" should they feel the
// need. If necessary, that player may be restricted from the entire
// game and community.
//
//	• All of the above, within assigned "site"
// --------------------------------------------------------------------
//
// --------------------------------------------------------------------
// [contents] [ranks]	Administrator (Pg002-06)
//
// Administrators are the core of the game. Primarily made up of
// the founders and respected members of the community, this
// select group is in charge of accepting and adding new lands
// to the game, as well as keeping the assigned land leaders in
// check. Any complaints regarding staff listed above should be
// directed to the administrators for handling.
//
//	• Fully unrestricted
// --------------------------------------------------------------------
//
// --------------------------------------------------------------------
// [contents] [ranks]	Banned (Pg002-07)
//
// When it is deemed that a player is no longer fit for play, for
// whatever reason, they will be reduced to this rank. Reasons for
// banishment can be anything from repeated breaking of guidelines
// to refusing to heed warnings from staff. In the event of a player
// claiming they were unfairly banned, the administrators will look
// into the case to be sure the player was indeed fairly banned.
//
// Bans can, and sometimes most likely will, be revoked. Some bans
// may be put in place for temporary periods of time as punishment
// for mild, but still serious, offenses. These can be thought of as
// deterents for disruptiveness. As well, characters belonging to
// a banned player are at risk of being approached in character in
// such a way that could lead to their death, loss of title, or other such
// negative events.
//
//	• Fully restricted
//	• Unable to login
//	• Unable to access characters
// --------------------------------------------------------------------
//
// #####################################################
//
// ==============================================
// [contents]	TITLES - BASIC GUIDE (Pg003)
// ==============================================
//
//	Titles are displayed on all IC content. Titles represent
//	a characters status among the other player characters.
//	These can be assigned per user from a preset list.
//	At this time, no list is available.
//
// #####################################################
//
// ==============================================
// [contents]	CLASSES - BASIC GUIDE (Pg004)
// ==============================================
//
//	Classes represent the occupation of an individual
//	character. As such, there is no preset list. Instead,
//	it is assigned per character, giving greater control
//	over how he or she is looked upon during play.

// ==============================================
// [contents]	TABLE SETUPS (Pg999)
// ==============================================
//
// Key:
// Required field | Unique field | Primary key
//
// --------------------------------------------------------------------
// [contents] [tables]	USER ACCOUNTS (Pg999-01)
// --------------------------------------------------------------------
users
Contains forum area information
Field Name Field Type Default Value Description P U R I
uid INTEGER 0 ID of user X X X X
username VARCHAR(25) - Login name of user - X X X
alt_name VARCHAR(25) - Alternate display name - X X X
password VARCHAR(64) - Password of user stored as MD5 hash - - X -
user_title VARCHAR(25) - Displayed title (if unset, rank title is used) - - - -
rank INTEGER 0 ID of parent forum - - X X
id INTEGER 0 Forum area ID X X X X
pid INTEGER 0 ID of parent forum - - X X
id INTEGER 0 Forum area ID X X X X
pid INTEGER 0 ID of parent forum - - X X
id INTEGER 0 Forum area ID X X X X
pid INTEGER 0 ID of parent forum - - X X
id INTEGER 0 Forum area ID X X X X
pid INTEGER 0 ID of parent forum - - X X
id INTEGER 0 Forum area ID X X X X
pid INTEGER 0 ID of parent forum - - X X
id INTEGER 0 Forum area ID X X X X
pid INTEGER 0 ID of parent forum - - X X
login_last DATETIME - Date of last successful login - - - -
post_total INTEGER 0 Total number of OOC posts - - - -
post_last VARCHAR(200) - Date & location of most recent post - - - -
registered DATETIME - Date of registration - - - -
last_ip VARCHAR(20) - Most recent IP address of user - - - -
hide_email BOOLEAN 0 Setting to hide e-mail address from non-admins - - - -
hide_flagged BOOLEAN 0 Setting to hide flagged posts - - - -
enable_flagging BOOLEAN 0 Enable post flagging - - - -
// Table Name : users // Description : Stores general account information // // uid => User id // username => User login name; 25 letters max. // alt_name => Alternate dislay name; 25 letters max. // password => MD5 hash of password // user_title => Displayed title (if unset, rank title is used) // rank => General access level // rank_title => Title of rank to be displayed // email => E-mail address // location => User location // bio => Brief background of user // im_icq => ICQ number // im_aim => AIM screenname // im_yahoo => Yahoo screenname // im_msn => MSN ID // birthday => Date of birth; Displayed on realtime calendar // char_max => Maximum number of characters for user // char_total => Total characters created by user // char_active => Currently active character // login_total => Number of logins; Invisible except to admins // login_last => Date of last login // post_total => Total OOC posts // post_last => Date & location of last post // registered => Date registered // last_ip => Previous IP address // hide_email => Hide e-mail address from member list // hide_flagged => Hide flagged posts // enable_flagging => Enable post flagging // // // -------------------------------------------------------------------- // [contents] [tables] USER LEVELS (Pg999-02) // -------------------------------------------------------------------- // Table Name : user_levels // Description : Stores user access level information // // id => Level id; Used for cross-reference // title => Displayed text (OOC posts & CP) // aGM => Ability: General Management // aNM => Ability: News // aPM => Ability: Pages // aVM => Ability: Voting // aLM => Ability: Layout // aSC => Ability: Site Content // aUM => Ability: Users // aAL => Ability: Access Log // aLV => Ability: Levels // aCM => Ability: Characters // aMB => Ability: Message Board // aMOD => Ability: Moderator // aME => Ability: Mass E-Mail // aSU => Ability: Super User // // // -------------------------------------------------------------------- // [contents] [tables] CHARACTERS (Pg999-03) // -------------------------------------------------------------------- // Table Name : characters // Description : Stores character information // // uid => ID of the owner // id => Character ID // name => Character name; 25 letters max. // realm => Home realm // race => Character race // languages => List of languages known by character // gender => Character gender // age => Character age // alignment => Character alignment // class => Character occupation // title => Character title // physical => Physical description // charisma => Personality description // bio => Brief background // post_last => Date & location of last post by character // post_total => Total posts made by character // created => Date character created // // // -------------------------------------------------------------------- // [contents] [tables] CHARACTER TITLES (Pg999-04) // --------------------------------------------------------------------
character_titles
Stores character titles
Field Name Field Type Default Value Description P U R I
id INTEGER 0 ID of character title X X X X
title VARCHAR(25) - Title text (displayed with character information) - - X X
// // -------------------------------------------------------------------- // [contents] [tables] NEWS (Pg999-05) // --------------------------------------------------------------------
news
Stores news items
Field Name Field Type Default Value Description P U R I
id INTEGER 0 ID of news item X X X X
subject VARCHAR(100) - Subject of news item - - X X
entry TEXT - Body of news item - - X -
posted DATETIME - Time news item was posted - - - -
uid INTEGER - ID of entry author - - X X
comm_enabled BOOLEAN 1 Enable commenting on news item - - X -
comm_total INTEGER 0 Total number of comments made to news item - - - -
// // -------------------------------------------------------------------- // [contents] [tables] FORUM AREAS (Pg999-06) // --------------------------------------------------------------------
forum_areas
Contains forum area information
Field Name Field Type Default Value Description P U R I
id INTEGER 0 Forum area ID X X X X
pid INTEGER 0 ID of parent forum - - X X
title VARCHAR(100) - Title of forum area - - X X
desc TEXT - Description of forum area - - - -
posts INTEGER 0 Total number of posts - - - -
threads INTEGER 0 Total number of threads - - - -
last_updated DATETIME - Time of most recent post - - - -
last_uname VARCHAR(25) - Username of most recent poster - - - -
last_uid INTEGER - ID of most recent poster - - - -
last_post_id INTEGER - ID of most recent post - - - -
position INTEGER 0 Numerical order to display forum area - - - -
type VARCHAR - Board type (OOC / IC) - - X X
// // -------------------------------------------------------------------- // [contents] [tables] FORUM TOPICS (Pg999-07) // -------------------------------------------------------------------- // // -------------------------------------------------------------------- // [contents] [tables] FORUM POSTS (Pg999-08) // -------------------------------------------------------------------- // // -------------------------------------------------------------------- // [contents] [tables] JOURNAL (Pg999-09) // -------------------------------------------------------------------- // Table Name : journal_entries // Description : Contains all journal information // // j_id => Journal ID #; one per user // u_id => User ID // id => Entry ID # // subject => Entry subject // message => Entry text // entry_date => Date of posting // entry_edited => Date of last edit // // // // -------------------------------------------------------------------- // [contents] [tables] MESSAGES (Pg999-10) // -------------------------------------------------------------------- // Table Name : messages // Description : Stores all private messages // // id => Unique message ID // sender_id => Sender's user ID // recipient_id => Receiver's user ID // subject => Message subject // message => Message text // date_sent => Date sent // read => Determines if message has been read or not // // // // -------------------------------------------------------------------- // [contents] [tables] SETTINGS (Pg999-11) // -------------------------------------------------------------------- // Table Name : settings // Description : I can't remember // // // // -------------------------------------------------------------------- // [contents] [tables] TEMPLATE CACHE (Pg999-12) // -------------------------------------------------------------------- // Table Name : template_cache // Description : Caches template data for quick retrieval // // // // -------------------------------------------------------------------- // [contents] [tables] TEMPLATE SOURCE (Pg999-13) // -------------------------------------------------------------------- // Table Name : template_source // Description : Stores template structures // // // // -------------------------------------------------------------------- // [contents] [tables] VOTING (Pg999-14) // -------------------------------------------------------------------- // Table Name : voting // Description : Tracks all voting information // // id => Voting topic ID // subject => Voting topic subject // options => Available options for voting topic // date_open => Date topic started // date_close => Optional date to close topic // user_choice => List of users and their choice // -------------------------------------------------------------------- // // #####################################################
!!!
  • Post a new comment

    Error

    default userpic
  • 0 comments