Komodo/Gecko

From Botdom Wiki
Jump to navigation Jump to search

NOTE: Gecko has changed since the 2.01 release. If you are looking for instructions on a previous version, please refer to previous edits of this page. This page is updated for the much-changed 2.02 version, and I recommend you update to 2.02 if you are still using 2.01 or lower.

Gecko (a play on the term 'echo', to repeat a message, also named after the Gecko client) allows you to chat through the bot's console window by simply typing and hitting enter. This features the usage of common /commands, hilighting, and switching which chats you talk in. Gecko used to pause the bot while you type, but now it features threaded input which runs alongside the main functions of the bot so nothing is interupted.

Pros

  • Sometimes, your browser fails to load dAmn completely, and you can't connect to the chat by any other means, yet the bot is still connected. You can use the bot to talk instead.
    • Note: I do NOT support people using this feature to talk to dAmn because of being banned, silenced, etc. This is against the rules of dAmn, and could result in even further action taken against your account(s).
  • Your browser may be using up alot of resources which you need to do something else, like work in Photoshop, yet you still wish to communicate with your friends/other chat members. Komodo uses up very little resources and is the perfect alternative to chat to dAmn while doing other things that demand more memory/cpu.
  • If you can't send messages in the chats for some reason, yet can still connect to it.
    • Note: I actually came up with this feature when I wasn't able to do this because of a SuperdAmn script bug that wouldn't allow me to send messages.
  • You can make the bot say something without having to use the !say #chatroom command.
  • It has functional dAmn commands, as well as a couple other commands. You can also still use your bot's regular triggered commands if it has them.
  • When your bot's name is mentioned it is highlighted, so you won't miss a message that was directed towards you
  • Has a beep option when you are hilighted to alert you when someone is trying to talk to you (off by default)
  • It's simply cool. :D

Cons

  • Title/topic/members list aren't viewable at all times. You can, however, view these by using the /title, /topic, and /members commands.
  • Inability to view bold/italics/other HTML text
  • inability to view icons, thumbs, and links

Usage

Since the threaded input was added, the ability to turn Gecko on/off has been removed, as it is not needed anymore. There is no risk of the bot timing out by accidentally pressing a key.

To chat using the window, all you need to do is start typing, and the bottom of the window will show what you are typing. To send the message, press enter. You can backspace the message, you can ctrl+backspace to delete the entire message instead of waiting while holding backspace, you can tab usernames and cycle through them like normal, you can switch chats by typing #chatname and hitting enter, and you can use various /commands, including all of those that you can use in a regular chat, and more, shown below

Once you start typing, you will notice a chat name to the left of the input field, like this:

  1. Chatroom> I am typing something!

This will be the chatroom that the message will be sent to. It is defaulted to the first chat that you have in your Autojoin list. You can change this by typing #chatroom and then your message, or just typing #chatroom, and hitting enter:

  1. Chatroom> #Botdom oh hai!

is the same as:

  1. Chatroom> #Botdom
  2. Botdom> oh hai!

The same can be done with @ instead of #, for pchats

Commands

You can use your bots commands with Gecko like this. You can also use regular /commands, like /join, /part, /kick, and /me, as well as many more functional and configuration commands. Here is a complete list and their syntax:

  • /about - Sends an about string of the client to the current chat
  • /action or /me - Sends an action. eg: /me is typing a message
  • /admin - Admin the current chatroom. eg: /admin show privclass, /admin create privclass Foobar order=3
  • /autojoin - See the current autojoin list. Use /autojoin add chat1 chat2... or del to add or delete chats.
  • /ban or /unban - Bans or unbans a user. eg: /ban Username
  • /channels - displays what channels the bot is in, including Pchats
  • /chat - Joins a pchat with someone. eg: /chat blazer-flamewing will make the bot join a pchat with me.
  • /clear - Clears the screen and reprints the banner.
  • /colors - View and change your colors settings. More info on usage here!
  • /commands - Prints a list of all of these commands.
  • /config - Edit various configuration settings. Type /config to see the settings you can edit. Type /config setting to view that setting's current configuration, and change it with on/off, add/del, whatever applies. The command will tell you how to edit certain settings.
  • /ctrig - Change the bot's trigger.
  • /demote and /promote - Demote or promote a user. eg: /promote Username' - promotes Username one level up; /promote Username Founders - promotes Username directly to Founders
  • /exec, /eval, or streval - Execute/evaluate some Python code. Use these carefully, and only if you know how Python works. eg: /eval Komodo.Settings. Streval is an easier to read version of eval, for large objects such as dictionaries.
  • /exit or /quit - Exit the bot.
  • /extensions - View the loaded extensions and which are on or off. You can turn an extension on or off by typing /extensions Welcomes on. Capitalization matters.
  • /gettitle or /gettopic - Inserts the topic or title directly to the buffer so you can add to the end of it.
  • /hilight - Edits the userhilighting list and turns it on or off. /hilight on/off turns it on or off, and /hilight add/del username adds or deletes a username
  • /join - Joins a chatroom. eg: /join Botdom - will join Botdom
  • /kick - Kick a user. eg: /kick Username - kicks Username out of the chat; /kick Username Please follow the rules - kicks Username with a message attached to the kick
  • /kickban - Used just like /kick, only bans the user directly after the kick.
  • /members - Prints all of the online users in their privclass groups in the current chat. Useful since you can't see them to the side like in dAmn.
  • /np or /npmsg - Sends a 'non-parsed' message, equivalent to you hitting enter while holding down shift in dAmn. eg: /np < code> < sup> This will send this code exactly as is without actually using the code < /sup> < /code>. You can also send an np-msg by pressing ctrl+enter after typing your message
  • /part - Part the current room or the given room. eg: /part - parts the room that you see on the left of the message; /part Botdom - parts Botdom
  • /restart - Restart the bot.
  • /say - Sends a regular message. You don't really need to use this to send a regular message, but I have it here anyways. eg: /say Hai thar!
  • /topic or /title - Gives you the current title or topic, or lets you set it. eg: /topic - prints the current topic to the screen; /title Welcome to my chatroom! - sets the title to 'Welcome to my chatroom!'
  • /whois - displays an online user's info, including joined chats, online time, and time since last message


Note that the dAmn commands are applied to the chatroom that is shown to the left of the typing area. You can change this by typing #chatroom /me is testing or #chatroom, enter, and then your message. Either works.

That's it for Gecko commands. You can also create your own by adding them to Gecko.py in the ~/komodo folder if you know how!


Credits

  • Photofroggy provided code for threaded input, which is very greatly appreciated, yet again!