The Auto Processor command help file - To run any of the following commands, send me mail with the following SUBJECT: VGAP ... Most of the commands ignore the BODY of your message (but not all). Note that commands are case-sensitive (e.g., 'Signon' is not the same as 'signon'). Note that some of the following commands may not be available if the host has disabled access to these commands. Check with your host. - The following commands are available: Command: signon Parameters: game name, racial preferences, email address, password Description: Signs up a player for the game named . Racial preferences are given, in order, in a single string (NO SPACES!). The first available race from the list will be assigned to the player. Use "a" for race 10, "b" for 11. Example: VGAP signon Ragnarok 57B8a killer@death.com Biteme This would sign up the player for the Ragnarok game, with the top 5 race choices as: Privateers, Crystals, Colonies, Empire, or Rebels. RST files should be mailed to killer@death.com, and the player's password should be "Biteme". Note that passwords are for the Auto Processor, not the game, although you may use the same one for both if you wish. Neither Planets nor the Auto Processor checks each other's passwords. Passwords and game names are case sensitive and limited to a single word. Only letters and/or digits are allowed. Command: trn Parameters: game name, player number, password Description: Submits a player's .trn file, if it matches the password. Attach the .trn file to the mail. EXAMPLE: VGAP trn game1 3 mypassword Command: rst Parameters: game name, player number, password, *optional address* Description: Mails the latest rst to the address, if given, or the email address on file. EXAMPLE: VGAP rst game1 3 mypassword VGAP rst game1 10 pass alternate@addr.net Command: playerfiles Parameters: game name, player number, password, *optional address* Description: Mails the player files to the address, if given, or the email address on file. EXAMPLE: VGAP playerfiles game1 3 mypassword VGAP playerfiles game1 10 pass alternate@addr.net Command: passwd Parameters: game name, player number, old password, new password Description: Changes password "old passwd" to "new passwd". Passwords are limited to a single word, but may be any length. They are case sensitive. Only letters and/or digits are allowed. EXAMPLE: VGAP passwd newgame 5 oldpass newpass Command: email Parameters: game name, player number, password, new address Description: Changes player's email address to "new address". The new address may be multiple addresses if you want to mail the rst's to multiple addresses, but only the first will get reminders. EXAMPLE: VGAP email PHOSTGame 7 pass7 mynewaddr@addr.net VGAP email game 11 thepass addr1@net addr2@net Command: resign Parameters: game name, player number, password Description: Resigns player from game. No rst's will be sent, trn's will not be accepted, and player will no longer have access to any function which requires his password. EXAMPLE: VGAP resign staleGame 9 dufus Command: msg Parameters: game name, player number, password, recipients Description: Sends a message from player to each of . Each recipient will be notified of who the sender is. (Contrast with "rumor".) The recipient list is the same format as the racial prefences in the "signon" command. Somewhat superfluous with PHOST's messaging ability, but this is via email, which is faster than the planets' interface. In the body of the email, make sure the message you want to send begins with "## begin", and ends with "## end". Nothing else will be sent as part of the message. Example: The subject of the mail is: VGAP msg Ragnarok 5 BiteMe 123456789ab The body of the mail is: ## begin *********************** *Privateer News Flash!* *********************** I, Commander Keen, declare my supreme being-hood over all the universe. Join me or prepare to die! All alliances I have held are now null, since you will all soon be under my boot-heel, and rightfully so. ## end Command: rumor OR rumour Parameters: game name, player number, password, recipients Description: The exact same thing as the msg command, but you, as the sender are not revealed to the recipients. (Unless you do so yourself in the body of the message.) The format of the mail is exactly the same as in the msg command. Command: post Parameters: game name, player number, password Description: posts to the newsletter. Format of the post is essentially same as in msg and rumor. Command: news Parameters: game name Description: Sends out the current newsletter for the game. EXAMPLE: VGAP news game1 Command: score Parameters: game name Description: Sends the latest score. EXAMPLE: VGAP score game1 Command: title Parameters: game name, player number, password, new title Description: Changes player's title to "new title". The new title is allowed to be multiple words, (i.e. "The Mercilous Louts"). The title is then used for the msg and post commands. EXAMPLE: VGAP title thegame 2 pwd The Leapin' Lizards Command: status Parameters: game name, player number, password Description: Returns current settings for the player. The player's current e-mail address(es), title, number of activity points, and whether or not the player has submitted a valid TRN for the next turn are mailed back to the player. Command: help Parameters: (none) Description: Sends help (this file). EXAMPLE: VGAP help Host-Specific Commands ---------------------- The following commands are only meant for hosts. They can be used to modify the game from a remote location. Command: suspend Parameters: game name, master password Description: This command suspends the game. No more turns will be run until the host resumes the game using the 'resume' command. The only password accepted is the 'master password' that the host sets for himself when the game is created. The body of the e-mail message may contain one or more reasons for the suspension. These reasons will be communicated to the players if they use the 'status' command (described above). The reasons for suspension are indicated within '## begin' and '## end' delimiters as for the 'msg' and 'rumor' commands (see above). The successful execution of this command creates a file named 'suspend.why' in the hosting directory. PHOSTRUN will not perform the hosting process if it finds this file in the hosting directory. The contents of this file are the reason for suspension given by the host. Hosts can manually suspend games by simply creating this file in the hosting directory. Command: resume Parameters: game name, master password Description: This command resumes a previously suspended game. The only password accepted is the 'master password' that the host sets for himself when the game is created. The body of the e-mail message is ignored for this command. This command simply attempts to remove the 'suspend.why' file in the hosting directory, thus allowing PHOSTRUN to perform the hosting process.