Author Topic: New help format, thoughts?  (Read 2318 times)

0 Members and 2 Guests are viewing this topic.

Offline Megiddo

  • Ulysses Team Member
  • Hero Member
  • *****
  • Posts: 6214
  • Karma: 394
  • Project Lead
New help format, thoughts?
« on: September 12, 2009, 11:05:17 AM »
Here's what I've got for the new ulx help formatting so far, what do y'all think of it?

Quote
] ulx help
ULX Help:
If a command can take multiple targets, it will usually let you use the keywords '*' for target
all, '^' to target yourself, '@' for target your picker, and '%<group>' for targetting groups. IE,
ulx slap %user slaps all players who are in the default guest access group. Any of these keywords
can be preceded by '!' to negate it. IE, ulx slap !^ slaps everyone but you.
You can also separate multiple target by commas. IE, ulx slap bob,jeff,henry.
All commands must be preceded by "ulx ", ie "ulx slap"

Command Help:


Category: User Management
   o ulx addgroup <group> [<inherits from>] - Create a new group with optional inheritance.
   o ulx adduser <player> <group> - Add a user to specified group.
   o ulx adduserid <SteamID, IP, or UniqueID> <group> - Add a user by ID to specified group.
   o ulx groupallow <group> <command> [<access tag>] [<revoke access: 0/1>] - Manipulate a group's access.
   o ulx removegroup <group> - Removes a group. USE WITH CAUTION.
   o ulx removeuser <player> - Permanently removes a user's access.
   o ulx renamegroup <current group> <new group> - Renames a group.
   o ulx userallow <player> <command> [<access tag>] [<revoke access from list: 0/1>] [<use deny list: 0/1>] - Manipulate a user's access.
   o ulx usermanagementhelp - See the user management help.


Category: Fun
   o ulx ignite <players> [<seconds: 0<=x<=300, default 300>] - Ignites target(s). (say: !ignite) (opposite: ulx unignite)
   o ulx playsound <sound> - Plays a sound (relative to sound dir).
   o ulx slap <players> [<damage: 0<=x, default 0>] - Slaps target(s) with given damage. (say: !slap)
   o ulx slay <players> - Slays target(s). (say: !slay)
   o ulx sslay <players> - Silently slays target(s). (say: !sslay)
   o ulx unigniteall - Extinguishes all players and all entities. (say: !unigniteall)
   o ulx whip <players> [<times: 2<=x<=100, default 10>] [<damage: 0<=x, default 0>] - Slaps target(s) x times with given damage each time. (say: !whip)


Category: Utility
   o ulx help - Shows this help.


-End of help
ULX version: <SVN> revision 61

Things of note:
  • Numeric arguments show the valid ranges. This is generated automatically, and can vary depending on who is looking at the help and what their permissions are
  • "Opposite" commands are no longer fully shown in order to improve clarity. See "ulx unignite" and notice that the "opposite" command is defined there.
Experiencing God's grace one day at a time.

Offline atomicspark

  • Full Member
  • ***
  • Posts: 196
  • Karma: 12
Re: New help format, thoughts?
« Reply #1 on: September 12, 2009, 12:43:57 PM »
I like the removal of the uncommands. The list was getting pretty long. :P

Offline JamminR

  • Ulysses Team Member
  • Hero Member
  • *****
  • Posts: 8096
  • Karma: 390
  • Sertafide Ulysses Jenius
    • Team Ulysses [ULib/ULX, other fine releases]
Re: New help format, thoughts?
« Reply #2 on: September 12, 2009, 09:39:57 PM »
Like it.
I agree with atomicspark.. the old one was getting messy.
Not that many ever seem to read or follow it, at least it will be somewhat easier for when it is read. :)
"Though a program be but three lines long, someday it will have to be maintained." -- The Tao of Programming