Where can I find the documentation?

[Julian Moreno Cano]

Hello folks: I already installed it, but where can I find the documentation?

[ajaximrpg]

Hi, Julian,

This is a one-man operation so far and, as embarrassing as it is to admit, I don't have any real documentation.

I have 5 text files that have minimal information.  It isn't really documentation but it's something:

http://ajaximrpg.svn.sourceforge.net/viewvc/ajaximrpg/CONTRIB
http://ajaximrpg.svn.sourceforge.net/viewvc/ajaximrpg/INSTALL
http://ajaximrpg.svn.sourceforge.net/viewvc/ajaximrpg/LICENSE
http://ajaximrpg.svn.sourceforge.net/viewvc/ajaximrpg/README
http://ajaximrpg.svn.sourceforge.net/viewvc/ajaximrpg/UPDATES

There is also the somewhat commented source code:

http://ajaximrpg.svn.sourceforge.net/viewvc/ajaximrpg/

Is there are particular piece of information that you are seeking or is it just general information?

Dan
----------------
Play: http://www.svexpertise.com/ajaximrpg/server
Code: http://ajaximrpg.sourceforge.net
Tweet: http://www.twitter.com/ajaximrpg
Discuss: http://groups.google.com/group/ajaximrpg
Totally free.  Totally easy.  Totally open.  Play RPGs instantly.

[Julian Moreno Cano]

Hi ajaximrpg: Thanks, but I mean the settings after installation.

[ajaximrpg]

I knocked this out just now.

INSTALL_PASSWORD: INSTALL_PASSWORD protects the installation process which an online way to create or re-write config.php.  For example, if the database becomes inaccessible, the installation screen will be presented to any user who visits the main page which will allow that use to create or re-write config.php.  If INSTALL_PASSWORD is blank, anybody who visits the main page will be allowed to reconfigure the ajaximrpg instance.  If INSTALL_PASSWORD is set to "DISABLED", the installation screen will be disabled; config.php can only be edited using a text editor and no online changes are allowed.  If the INSTALL_PASSWORD is anything else (which is stored in plain text in config.php), the user will be prompted to enter the installation password to access the installation process.  INSTALL_PASSWORD is the mechanism for allowing online installation when you first install ajaximrpg but protecting you if a user stumbles across the online installation process later because the database is down or the ajaximrpg installation is malfunctioning in some way.

SQL_HOST: The IP address or DNS address of the MySQL database server.  This is relative to the server that ajaximrpg is running on, not the client that is accessing ajaximrpg.

SQL_USER: The MySQL user name that ajaximrpg will use to access the MySQL database server.

SQL_PASS: The MySQL password, in plain text, that ajaximrpg will use to access the MySQL database server.

SQL_DB: The MySQL database in the MySQL database server that ajaximrpg will use for ajaximrpg.

SQL_PREFIX: The prefix to use for all tables in the MySQL database.  This is a convenience so that ajaximrpg database tables will be grouped together and can co-exist in the same database as ajaximrpg plugins and other programs.

MAX_BUDDY_ICON_SIZE: There is a partially-implemented, partially-broken feature where a user can upload an avatar/image/icon that will be shown next to his name.  The MAX_BUDDY_ICON_SIZE limits the size of each of these images to prevent users from using up all the disk space on your server with giant images.

Is this what you are looking for?

Dan

----------------

Play: http://www.svexpertise.com/ajaximrpg/server

Code: http://ajaximrpg.sourceforge.net

Tweet: http://www.twitter.com/ajaximrpg

Discuss: http://groups.google.com/group/ajaximrpg

Totally free.  Totally easy.  Totally open.  Play RPGs instantly.