User guide for Console

This is the user guide for the Console version of KouChat.

It’s part of KouChat for Desktop, and must be started with the --console startup argument for the console mode to be enabled.

• Main chat
  • Chat area
  • User list
  • Input field
• Private chat
• Away mode
• Topic
• Settings
  • Storage
• File transfers
  • Send file
  • Receive file
• Commands
• Startup arguments
  • Log location

Main chat

The main chat is a public chat containing all the users on the network. It looks like this:

Chat area

The whole screen displays information messages and chat messages. Information messages are prefixed with ***. Chat messages are prefixed with the nick name of the user who sent the message.

User list

There is no user list visible at all times. Use the command /users to see a list of currently online users, and /whois to see details about a certain user.

Input field

Everyone can send a message to the main chat, as long as they are not away. Type a message or command and press the Enter/Return key to send.

Private chat

You can start a private chat with a user if you do not want everyone to see the conversation.

Use the command /msg to send a private chat message. Received private chat messages are shown in the main chat. The messages are prefixed with (privmsg).

Away mode

You can use away mode to say that you do not wish to be disturbed. When you go away:

• You can not send or receive files.
• You can not change the topic.
• You can not change your nick name.
• You can not send any messages to the main chat.
• You can not send or receive private chat messages.

Use the command /away to go away. The away message can’t be empty.

Use the command /back to return from away mode.

Topic

You can set a topic in the main chat that all users, including users joining later, will see. The topic is shown when you log on.

Use the command /topic to see, set or change the topic.

Settings

Use the Settings to tweak certain aspects of KouChat.

Most settings have to be changed manually in kouchat.ini, and require a restart of KouChat before they take effect. See Storage for the location of this file. Here is a description of relevant settings for the console:

Storage

KouChat uses a folder called .kouchat for storage, located in your home folder. Settings are stored in kouchat.ini, while logs are stored in its own logs folder, unless the log folder is overridden by a startup argument.

Example locations:

File transfers

Send file

Use the command /send to send a file to a user:

/send christian /home/user/Brave_Trailer_HD.mp4
[12:15:49] *** Trying to send the file Brave_Trailer_HD.mp4 (#1) [12.47MB] to Christian
[12:15:59] *** Christian accepted sending of Brave_Trailer_HD.mp4
[12:16:10] *** Brave_Trailer_HD.mp4 successfully sent to Christian

The transfer will not start until the other user has accepted the file. Use the command /cancel during the file transfer to abort, and /transfers to see the progress.

Receive file

When someone sends a file to you, you need to use the command /receive to start receiving the file, or /reject if you don’t want to receive the file:

[13:01:33] *** Christian is trying to send the file Brave_Trailer_HD.mp4 (#2) [12.47MB]
[13:01:33] *** /receive or /reject the file
/receive Christian 2
[13:03:28] *** Receiving Brave_Trailer_HD.mp4 from Christian
[13:03:29] *** Successfully received Brave_Trailer_HD.mp4 from Christian, and saved as Brave_Trailer_HD.mp4

The transfer should start immediately after deciding to receive, and it will be stored in your home folder. If a file with the same name exists, the received file will be renamed automatically to avoid overwriting the existing file. Use the command /cancel during the file transfer to abort, and /transfers to see the progress.

Note the usage of the parameter “2” in the /receive command, which corresponds with the file transfer id (#2) seen in the first information message. This id will increase by one for each send/receive file request.

Commands

Write these commands in the main chat.

Startup arguments

These are arguments sent to KouChat on startup like this:

java -jar kouchat-x.x.x.jar <argument>

Replace <argument> with either the short or the full argument from the table below. Use from the command line or in shortcuts.

Log location

Remember to use quotes if the path contains spaces, and use double backslash at the end of Windows paths.

Example arguments: