Installing SGP on Your Game

SGP is meant to work together smoothly and quote into your database with any client that has file uploading capability. The code itself is packaged as a series of quotable files that create necessary code objects and write attributes to them. Each of these files, as a means to guage the progess of loading, has a series of emits built in to let you know where you are in the quoting process. At the end of each file, you will recieve an emit that will tell you anything special you need to do with the code objects.

SGP is released 'as is' and bugs related directly to the code package may be sumbitted via web reply form here.

System Requirements:

• You must have a compiled and running MUSH server to use this code.
• You must have wizard permissions on the game.
• You must set the following configuration parameters in your .conf file in the master account:

  master_room
  access @function wizard
  access @function/priviledged wizard
  

• Have a MUSH client that allows for the uploading of files.
• For TinyMUSH and MUX, use @admin to set the player_queue_limit to 1000. PennMUSH does not require this.

About the Organization of the Code:

SGP code is organized so that you quote in the pieces you need for your game. ALL SGP code assumes that you will have installed the base code. For a social game, much less and different code is required for success than in a complicated RPG game, so quoting in a bunch of useless judging and other code is a pointless waste of DB space.

If a file is listed as a 'beta', it means that there is still work being done and the code could change radically. Versions of beta code are listed by date in the directory.

Picking the right SGP installers and support files:

Each of the target platforms has different requirements to assure that the system works. In all actuality, SGP will work as a totally softcoded system on all platforms, given appropriate changes to the server configuration. MUX users wishing to use all softcode will need to consult server documentation for instructions. The files required on vanilla implementations of the target servers are listed below.

Files required for installation of SGP Base Globals on TinyMUSH 2.2.x servers:

• SGP-README.txt - Read before installing the softcode.
  • SGP-Installer.txt
  • SGP-+help.txt
  • SGP-RPpack.txt
  • PLACES-SGP.txt

Files required for installation of SGP Base Globals on PennMUSH 1.7.2 and later servers:

• SGP-README.txt - Read before installing the softcode.
  • SGP-Installer.txt
  • SGP-+help.txt
  • SGP-RPpack.txt
  • PLACES-SGP.txt

Files required for installation of SGP Base Globals on MUX 2.0.x servers:

• SGP-README.txt - Read before installing the softcode.
  • SGP-Installer.txt
  • SGP-plushelp.txt
  • SGP-staffhelp.txt
  • SGP-RPpack.txt
  • PLACES-SGP.txt

Files required for installation of SGP Base Globals on RhostMUSH servers:

• SGP-README.txt - Read before installing the softcode.
  • SGP-Installer.txt
  • SGP-+help.txt
  • SGP-RPpack.txt
  • PLACES-SGP.txt

Note that all code should be installed, file by file, in the order listed. In PennMUSH, TinyMUSH 2.2, and RhostMUSH, installing the globals files out of order will result in incorrectly installed helpfiles.