Skip to content

Commit 930f12d

Browse files
docs: sync documentation from SharpMUSH/SharpMUSH
Updated documentation: - Functions: 556 files - Commands: 312 files - Configuration: 14 files Source: SharpMUSH/SharpMUSH repository Date: 2026-03-04 06:09:11 UTC
1 parent 85c312b commit 930f12d

525 files changed

Lines changed: 1927 additions & 1938 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

Command Documentation/@-ATTRIBUTES.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ These '@' commands set standard message/action sets on objects. Each comes in 3
88
| [@move] | [@payment] | [@receive] | [@success] | [@tport] |
99
| [@ufail] | [@unfollow] | [@use] | [@zenter] | [@zleave] |
1010

11+
1112
These '@' command set other standard attributes on objects that don't follow the pattern above:
1213

1314
| | | | |

Command Documentation/@.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# ATTRIB_SET
22
# @_
3-
`&<attr> <object>[=<value>]`
4-
`@_<attr> <object>[=<value>]`
3+
`&<attr> <object>[=<value>]`<br>
4+
`@_<attr> <object>[=<value>]`<br>
55
`ATTRIB_SET/<attr> <object>=<value>`
66

77
The `&<attr>` and `@_<attr>` commands can be used to set or clear an attribute from an object. When entered directly from a client, they do not evaluate the `<value>`.

Command Documentation/@ANAME.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @ONAME
22
# @ANAME
3-
`@oname <object>[=<message>]`
3+
`@oname <object>[=<message>]`<br>
44
`@aname <object>[=<action list>]`
55

66
Whenever `<object>`'s name is changed (via @name), others in the same location will see the contents of `<object>`'s ONAME attribute, prepended with `<object>`'s new name. At the same time, `<object>`'s ANAME attribute will be triggered. Both attributes receive the old name as %0, and the new name as %1.

Command Documentation/@HTTP.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# @HTTP
2-
`@http <obj>/<attr>=<URL>`
3-
`@http/delete <obj>/<att>=<URL>[,<data>]`
4-
`@http/post <obj>/<att>=<URL>[,<data>]`
2+
`@http <obj>/<attr>=<URL>`<br>
3+
`@http/delete <obj>/<att>=<URL>[,<data>]`<br>
4+
`@http/post <obj>/<att>=<URL>[,<data>]`<br>
55
`@http/put <obj>/<att>=<URL>[,<data>]`
66

77
Attempts to retrieve URL with a HTTP GET request, and upon doing so, queues the action list in `<obj>/<attr>`. The body of the reply from the remote web server is passed as %0, with the HTTP status in %q`<status>` and the Content-Type header in %q`<content-type>`. Any commas in the URL need to be escaped.

Command Documentation/@ONAME.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @ONAME
22
# @ANAME
3-
`@oname <object>[=<message>]`
3+
`@oname <object>[=<message>]`<br>
44
`@aname <object>[=<action list>]`
55

66
Whenever `<object>`'s name is changed (via @name), others in the same location will see the contents of `<object>`'s ONAME attribute, prepended with `<object>`'s new name. At the same time, `<object>`'s ANAME attribute will be triggered. Both attributes receive the old name as %0, and the new name as %1.

Command Documentation/@SLAVE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@
55

66
Two different daemons are used:
77

8-
info: Resolves IP addresses into host names whenever a new connection is established.
8+
info: Resolves IP addresses into host names whenever a new connection is established.<br>
99
ssl : Handles encrypted SSL connections across @shutdown/reboots.
1010

Command Documentation/@SOCKSET.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @SOCKSET
22
# SOCKSET
3-
`SOCKSET [<option>=<value>]`
3+
`SOCKSET [<option>=<value>]`<br>
44
`@sockset [<descriptor>][=<option>, <value>[, ..., <optionN>, <valueN>]]`
55

66
SOCKSET is a socket command which sets or queries socket-specific options. These options are usually set automatically, or negotiated by the MUSH and your client, but this command lets you override those settings.

Command Documentation/@SUGGEST.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @SUGGEST
2-
`@suggest[/list]`
3-
`@suggest/add <category>=<word>`
2+
`@suggest[/list]`<br>
3+
`@suggest/add <category>=<word>`<br>
44
`@suggest/delete <category>=<word>`
55

66
Given a list of known good words in a category, the mush can suggest ones based on misspelled or otherwise invalid words. This is used for suggesting function names, help entries, etc. @suggest provides a way to add custom categories and vocabulary words.

Command Documentation/@aahear.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# @ahear
22
# @amhear
33
# @aahear
4-
`@ahear <object>[=<action list>]`
5-
`@amhear <object>[=<action list>]`
4+
`@ahear <object>[=<action list>]`<br>
5+
`@amhear <object>[=<action list>]`<br>
66
`@aahear <object>[=<action list>]`
77

88
Sets the actions to be taken after the object's @listen is matched. @ahear will only be triggered by sound made by other objects, and @amhear is only triggered by sound made by `<object>` itself. @aahear will be triggered by all matching sound, regardless of the source.

Command Documentation/@abuy.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# @buy
22
# @abuy
33
# @obuy
4-
`@buy <object>[=<message>]`
5-
`@obuy <object>[=<message>]`
4+
`@buy <object>[=<message>]`<br>
5+
`@obuy <object>[=<message>]`<br>
66
`@abuy <object>[=<message>]`
77

88
These attributes contain the message shown to a player who successfully buys something from `<object>` using the "buy" command, the message shown to others in the room when something is bought from `<object>` (prefixed with the buyer's name), and the actions to be taken by `<object>` when something is bought from it, respectively. Each attribute is passed the item being purchased as %0 and the amount paid for it as %1.

0 commit comments

Comments
 (0)