Commands: Difference between revisions

From xat wiki
m (small punctuation)
(Debug commands.)
Line 1: Line 1:
<languages/><translate>xat has support for special "/" commands, which allow for advanced actions that are not in the graphical user interface. Some commands are available for everyone on the chat, while other commands require a specific rank (temp owner by default without [[Gcontrol|GControl]]). Some '''powers''' also allow more commands, which can improve a user's experience and help them to manage a chat.
<languages/>
<div style="float:right; margin: 15px 0 0 15px">__TOC__</div>
<translate>
xat has support for special "/" (slash) commands, which allow for advanced actions that are not available in the graphical user interface. Some commands are available for everyone on the chat, while other commands require a specific rank or [[<tvar|1>Special:MyLanguage/Powers</>|power]].


== Default "/" commands ==
== Default "/" commands ==
Line 5: Line 8:
These commands can be used by everyone in any chat, though sometimes you need a certain rank.
These commands can be used by everyone in any chat, though sometimes you need a certain rank.


=== /o Smiley Effects ===
=== /o Smiley effects ===


You can make the chat box automatically add smiley effects to all the smilies you send. To do this, type /o followed by the code of the effect without the # sign.
You can make the chat box automatically add smiley effects to all the smilies you send. To do this, type "/o" followed by the code of the effect without the # sign.


For example, if you want all your smileys to be mirrored and you have the [[Mirror]] power, type /om in the chat box and send it like a message. You can also combine effects. For example, /omis will make all the smileys mirrored, inverted and made square, as long as you have all the required [[Powers]]. You can also combine color effects. For example, /oFFFFFF will make all your smileys white.
For example, if you want all of your smilies to be mirrored and you have the [[Mirror]] power, type "/om" in to the chat box and send it like a message. You can also combine effects. For example, "/omis" will make all the smileys mirrored, inverted and made square, as long as you have all the required [[<tvar|1>Special:MyLanguage/Powers</>|powers]]. You can also combine color effects. For example, "/oFFFFFF" will make all of your smileys white.


If you want to remove the smiley effect you made, simply type /o in a chat.
If you want to remove the smiley effect you made, simply type "/o" in to the chat.


=== /f Add as Friend by ID ===
=== /f Add as friend by ID ===


To add any xat user to your friends list when you only have their xat ID, type /f followed by their ID, then one space and the name you want to appear on your friends list.
To add any xat user to your friends list when you only have their ID, type "/f" followed by their ID. Optionally, you can add a name that you want to appear on your friends list.


For example, "/f999999999 Abcd" will add the user with the ID 999999999 to your friends list with the name "Abcd".
For example, "/f999999999 Abcd" will add the user with the ID 999999999 to your friends list with the name "Abcd".


=== /t Ignore a User ===
=== /t Ignore a user ===


Type /t in a private chat to ignore a user. If you have the [[Ttth|TTTH]] power, you can also send a full-screen smiley/message along with ignoring.
Type "/t" in a private chat to ignore a user. If you have the [[<tvar|1>Special:MyLanguage/TTTH</>|TTTH]] power, you can also send a full-screen smiley/message along with ignoring.


You can also use the same command in PC to Un-Ignore a user.
You can also use the same command in PC to un-ignore a user.


=== /+ or /- Enable or Disable Powers ===
=== /+ or /- enable or disable Powers ===


Type '''/+powername''' to enable a power or '''/-powername''' to disable a power.
Type "/+powername" to enable a power or "/-powername" to disable a power.


For example, if you type '''/-nopc''' on the chat, it will disable the [[Nopc|NoPC]] power.
For example, if you type "/-nopc" on the chat, it will disable the [[<tvar|1>Special:MyLanguage/NoPC</>|NoPC]] power.


=== /go Moving from a chat to another ===
=== /go Moving from a chat to another ===
Line 43: Line 46:
Example 1. Setting a scroll message.</translate>}}
Example 1. Setting a scroll message.</translate>}}
<translate>
<translate>
=== /s Scroll Message ===
=== /s Scroll message ===


If you are an Owner or a Main Owner, you can set a scroll message to the bottom of the typing box by typing it in the chat. (See Example 1.)
If you are an owner or a main owner, you can set a scroll message to show at the bottom of the typing box by typing it in the chat. (See Example 1.)


You can, for example, type:
You can, for example, type:
Line 51: Line 54:
*/sWelcome to my chat. Please behave well or you will be banned.
*/sWelcome to my chat. Please behave well or you will be banned.


You can change the color by adding a color code. For example, add #FF0000 to the end of the message for red.
You can change the color by adding a color code. For example, add #FF0000 to the end of the message for red:
 
*/sWelcome to my chat. Please behave well or you will be banned.#FF0000 will produce a red scrolling message.
 
You can also set the scroll remotely using an API: [[SetScroller]].


<span id="protect"></span>
*/sWelcome to my chat. Please behave well or you will be banned.#FF0000


=== /p Protect your group from raids ===
=== /p Protect your group from raids ===
Line 80: Line 79:
=== /i Information ===
=== /i Information ===


If you are an owner, you can find out who changed the scroll or who entered protect mode by typing /i in the main chat. The chat will reply with a message like: "/s 1345634 /p 2365342", which shows you the IDs of the last users to use the /s and /p commands.
If you are an owner, you can find out who last changed the scroll or who entered protect mode by typing "/i" in the main chat. You will then receive an automated message along the lines of "/s 1345634 /p 2365342", which shows you the IDs of the last users to use the "/s" and "/p" commands.
 
=== /m Make a user a moderator ===
 
Owners and main owners can type "/m" in a user's private chat to make them a moderator.


== Power "/" commands ==
== Power "/" commands ==
Line 88: Line 91:
== Debug "/" commands ==
== Debug "/" commands ==


On the Debug chats (chats having a blue 8ball instead of the classic black one), you can use more commands.
On the debug chats (chats that have a blue 8ball instead of the classic black one), there are some special commands you can use. You can also use the following commands on your own chat if you add "?test" to the end of your group's URL.
 
These commands seem (and are) generally useless, however they were once used by admins to create and test features.
 
Note that any messages sent are seen by you only.
 
=== /debug See debug information ===
 
The default "/debug" command will display some technical details about the chat; the memory usage; how many frames per second (FPS); the average frames per second (aFPS).
 
=== /debug clearlists Clear some cached chat data ===
 
When you use this command, some of the cached chat data will be cleared. The main chat and user list will be cleared, you will be added back to the top of the list with no cached rank and relationship. The data will begin to cache from that point on, adding users back to the user list when they sign in and begin to chat again.
 
=== /debug avs Control avatar effects ===
 
This command is used to control avatar effetcs, much like the $glitter [[<tvar|1>Special:MyLanguage/Macros</>|macro]]. This effect is not persistent like the macro.
 
Use "/debug avs" or "/debug avs 0" to disable avatar effects, and "/debug avs 1" to enable them again.
 
=== /debug cacheback See swfs loaded into cache===
 
This command puts a "back" on any swfs (pawns, smilies, etc.) that are loaded into cache. Use "/debug cacheback 1" to turn it on.
 
=== /debug zappri/primary/shadow Change the chat's connection details ===
 
These three commands all change the IP addresses that the chat connects on, but seem to have no effect.
 
=== /debug gctrick Send a "gctrick" Help message ===
 
Using "/debug gctrick 1" or any integer will cause the chat to send a Help message back with the same command you sent.
 
=== /debug smilietest Test different types of smilies ===
 
Test different types of smilies ising "/debug smilietest 1" where "1" can be one of the following numbers:
*1 - Test random smilies
*2 - Test random smiley combinations
*3 - Test free smilies.
 
=== /debug fakemessage Send a number of dummy messages ===
 
Use "/debug fakemessage 1" where "1" can be any number up to 200, and that number of [<tvar|1>https://en.wikipedia.org/wiki/Lorem_ipsum</> lorem ipsum] extracts will be posted on to the chat.
 
=== /debug avtest Test two random avatars ===
 
Use "/debug avtest 1" and you will start sending messages with two random avatars.
 
=== /debug graph See graphs based on debug information ===
 
For this command to work, you must first type "/debug". In itself, the graph command has 4 options:
*0 - Off.
*1 - A horizontal line graph representing your memory usage.
*2 - A vertical line graph representing your memory usage.
*3 - Both of the above.
*4 - A vertical line graph representing your frames per second (FPS).
 
=== /debug msgcount Count your messages ===
 
Type "/debug msgcount 1" for the chat to automatically start counting your messages from 1. Use "/debug msgcount off" to stop counting.
 
You can also use any other number instead of 1 to start counting from then.
 
=== /debug fps Change the frames per second (FPS) of the chat ===
 
The higher the FPS, the faster the animations in the chat. Use "/debug fps 24" to make the chat twice as fast.
 
Use "/debug fps 0" or "/debug fps 12" to go back to normal.
 
=== /debug cache Load an array of smilies into your cache ===
 
Type "/debug cache" and a load of smilies (12x12 by default) will overlay the chat. You can use "/debug cache 1 2", where 1 is the speed, and 2 is the number of rows. Repeating the command does not clear the previous smilies.
 
You must refresh to make it disappear.
 
You need to refresh to get rid of it.
 
=== /debug nocache Load smilies on to the chat ===
 
You use this command by typing "/debug nocache 12 pty" where 12 is the number of rows, and pty is the smiley. Repeating the command does not clear the previous smilies.
 
You must refresh to make it disappear.
 
=== /debug dp Testing assigning group powers ===
 
Use "/debug dp power 1" where power is the power name. If you own the power, it will return a "Power unassigned ok" message. otherwise it will return "Power system error (db down)" message.
 
=== /debug bump Test the bump noise ===
 
This command simply plays the bump sound and plays the animation.
 
=== /debug stest Smiley testing mechanism ===
 
The chat has a built in smiley testing mechanism that is turned on using this command. You must run the chat swf locally, put smiley swfs "C:\smilies\test\"
and set the names in the macro $stest like so: "$stest=placeholder,smiley1,smiley2,smiley3", use the /debug stest command and sign out and in.
</translate>
</translate>

Revision as of 19:23, 16 January 2017

xat has support for special "/" (slash) commands, which allow for advanced actions that are not available in the graphical user interface. Some commands are available for everyone on the chat, while other commands require a specific rank or power.

Default "/" commands

These commands can be used by everyone in any chat, though sometimes you need a certain rank.

/o Smiley effects

You can make the chat box automatically add smiley effects to all the smilies you send. To do this, type "/o" followed by the code of the effect without the # sign.

For example, if you want all of your smilies to be mirrored and you have the Mirror power, type "/om" in to the chat box and send it like a message. You can also combine effects. For example, "/omis" will make all the smileys mirrored, inverted and made square, as long as you have all the required powers. You can also combine color effects. For example, "/oFFFFFF" will make all of your smileys white.

If you want to remove the smiley effect you made, simply type "/o" in to the chat.

/f Add as friend by ID

To add any xat user to your friends list when you only have their ID, type "/f" followed by their ID. Optionally, you can add a name that you want to appear on your friends list.

For example, "/f999999999 Abcd" will add the user with the ID 999999999 to your friends list with the name "Abcd".

/t Ignore a user

Type "/t" in a private chat to ignore a user. If you have the TTTH power, you can also send a full-screen smiley/message along with ignoring.

You can also use the same command in PC to un-ignore a user.

/+ or /- enable or disable Powers

Type "/+powername" to enable a power or "/-powername" to disable a power.

For example, if you type "/-nopc" on the chat, it will disable the NoPC power.

/go Moving from a chat to another

On any chat you can use the /go command to move on another chat. All you need to have is the name of the group or its identification number.

For example, if you type /go xat5, you will be redirected to xat_test. Typing /go xat_test will do the same.

As group names are unique, the command isn't case sensitive.

Template:Img is only allowed in User: namespace. Use [[File:]] (more on that here) or Template:Gallery on articles instead.

/s Scroll message

If you are an owner or a main owner, you can set a scroll message to show at the bottom of the typing box by typing it in the chat. (See Example 1.)

You can, for example, type:

  • /sWelcome to my chat. Please behave well or you will be banned.

You can change the color by adding a color code. For example, add #FF0000 to the end of the message for red:

  • /sWelcome to my chat. Please behave well or you will be banned.#FF0000

/p Protect your group from raids

If your chat is being raided, an owner can enter protect mode by typing "/p" in the main chat. For 1 hour, new unregistered users will have to solve a captcha to join the chat. You can turn off protect mode by typing /p again. Note: There is a 15-second delay after you toggle protect mode on or off and when you may toggle it on or off again.

If "/p" does not work, you can use these alternative modes to increase the protection:

  • /pg or /p2 Captcha unregistered users and gag new guests for 3 minutes
  • /pc or /p3 Captcha all guests
  • /pr or /p4 Make the chat registered users only
  • /pm or /p5 Make the chat members only

The main owner of the chat can use Gcontrol power to change the default duration of hours and the default rank of who can turn on protect mode.

Note: Members and above do not need to complete a captcha when protect mode is on.

/i Information

If you are an owner, you can find out who last changed the scroll or who entered protect mode by typing "/i" in the main chat. You will then receive an automated message along the lines of "/s 1345634 /p 2365342", which shows you the IDs of the last users to use the "/s" and "/p" commands.

/m Make a user a moderator

Owners and main owners can type "/m" in a user's private chat to make them a moderator.

Power "/" commands

Some powers allow you to use more "/" commands, such as Tempown, Tempmod, Tempmem, Hush, Sinbin, and Nick.

Debug "/" commands

On the debug chats (chats that have a blue 8ball instead of the classic black one), there are some special commands you can use. You can also use the following commands on your own chat if you add "?test" to the end of your group's URL.

These commands seem (and are) generally useless, however they were once used by admins to create and test features.

Note that any messages sent are seen by you only.

/debug See debug information

The default "/debug" command will display some technical details about the chat; the memory usage; how many frames per second (FPS); the average frames per second (aFPS).

/debug clearlists Clear some cached chat data

When you use this command, some of the cached chat data will be cleared. The main chat and user list will be cleared, you will be added back to the top of the list with no cached rank and relationship. The data will begin to cache from that point on, adding users back to the user list when they sign in and begin to chat again.

/debug avs Control avatar effects

This command is used to control avatar effetcs, much like the $glitter macro. This effect is not persistent like the macro.

Use "/debug avs" or "/debug avs 0" to disable avatar effects, and "/debug avs 1" to enable them again.

/debug cacheback See swfs loaded into cache

This command puts a "back" on any swfs (pawns, smilies, etc.) that are loaded into cache. Use "/debug cacheback 1" to turn it on.

/debug zappri/primary/shadow Change the chat's connection details

These three commands all change the IP addresses that the chat connects on, but seem to have no effect.

/debug gctrick Send a "gctrick" Help message

Using "/debug gctrick 1" or any integer will cause the chat to send a Help message back with the same command you sent.

/debug smilietest Test different types of smilies

Test different types of smilies ising "/debug smilietest 1" where "1" can be one of the following numbers:

  • 1 - Test random smilies
  • 2 - Test random smiley combinations
  • 3 - Test free smilies.

/debug fakemessage Send a number of dummy messages

Use "/debug fakemessage 1" where "1" can be any number up to 200, and that number of lorem ipsum extracts will be posted on to the chat.

/debug avtest Test two random avatars

Use "/debug avtest 1" and you will start sending messages with two random avatars.

/debug graph See graphs based on debug information

For this command to work, you must first type "/debug". In itself, the graph command has 4 options:

  • 0 - Off.
  • 1 - A horizontal line graph representing your memory usage.
  • 2 - A vertical line graph representing your memory usage.
  • 3 - Both of the above.
  • 4 - A vertical line graph representing your frames per second (FPS).

/debug msgcount Count your messages

Type "/debug msgcount 1" for the chat to automatically start counting your messages from 1. Use "/debug msgcount off" to stop counting.

You can also use any other number instead of 1 to start counting from then.

/debug fps Change the frames per second (FPS) of the chat

The higher the FPS, the faster the animations in the chat. Use "/debug fps 24" to make the chat twice as fast.

Use "/debug fps 0" or "/debug fps 12" to go back to normal.

/debug cache Load an array of smilies into your cache

Type "/debug cache" and a load of smilies (12x12 by default) will overlay the chat. You can use "/debug cache 1 2", where 1 is the speed, and 2 is the number of rows. Repeating the command does not clear the previous smilies.

You must refresh to make it disappear.

You need to refresh to get rid of it.

/debug nocache Load smilies on to the chat

You use this command by typing "/debug nocache 12 pty" where 12 is the number of rows, and pty is the smiley. Repeating the command does not clear the previous smilies.

You must refresh to make it disappear.

/debug dp Testing assigning group powers

Use "/debug dp power 1" where power is the power name. If you own the power, it will return a "Power unassigned ok" message. otherwise it will return "Power system error (db down)" message.

/debug bump Test the bump noise

This command simply plays the bump sound and plays the animation.

/debug stest Smiley testing mechanism

The chat has a built in smiley testing mechanism that is turned on using this command. You must run the chat swf locally, put smiley swfs "C:\smilies\test\" and set the names in the macro $stest like so: "$stest=placeholder,smiley1,smiley2,smiley3", use the /debug stest command and sign out and in.