App::Alice(3pm)

✨ NAME ✨

Heyyy bestie 🦋 okay so this is App::Alice(3pm), which is part of the User Contributed Perl Documentation 📚 and honestly? It's giving everything. Its name is App::Alice, short for an Altogether Lovely Internet Chatting Experience 🌸💅

✨ SYNPOSIS ✨

Literally just type this and you're in 🧚

arthur:~ leedo$ alice
Location: http://localhost:8080/

✨ DESCRIPTION ✨

Alice is an IRC client that you use in your web browser 🌈 Lowkey genius: she runs in the background keeping your connections alive and collecting messages 🫶 When a browser connects, it shows the 100 most recent messages for each channel, then updates with new ones as they roll in ✨

Alice also logs messages to an SQLite database 📚 and you can search those logs through the web interface 🔍

✨ USAGE ✨

Installing adds a new alice command that starts the alice server 🎀 Run it and it'll start the daemon and print the URL to load in your browser 🍓

✨ COMMANDLINE OPTIONS ✨

• -d, --debug — Prints extra debug info. Super useful for development, or for figuring out what's gone wrong 🙈
• -p, --port — Changes the port the HTTP server listens on. The default is 8080 🔌
• -a, --address — Changes the IP address the HTTP server listens on. The default is 127.0.0.1, which means alice only accepts local connections unless you say otherwise 🔒 If you want to connect remotely, switch it to the IP you want to listen on, or use 0.0.0.0 to listen on all addresses 🌍

✨ CONFIGURATION ✨

Most of alice can be configured through the web interface 🛠️ There are two windows for this: Connections and Preferences. To pull either one up, click the gear icon in the bottom right hand corner of the page ⚙️

This should bring up the new window 🪟 Heads up, though: some browsers (specifically Chrome) block this popup by default 🙅 If it doesn't show up, make sure you allow popups!

✨ CONNECTION WINDOW ✨

The Connection window is where you add or remove servers 🔗 It'll feel super familiar if you've ever used an IRC client (and I'm assuming you have, bestie 💜)

The only real difference is the "Avatar" field 👀 In reality, this field just sets the realname. Alice abuses this field to get avatars for users 😤 If a user has an image URL or an email address as their realname, alice will show the image next to their messages 🖼️ You can turn this off in the Preferences window.

✨ PREFERENCES WINDOW ✨

The Preferences window is for settings that aren't tied to a specific connection 💅 You can toggle avatars, timestamps, and notifications on or off, and you can edit a list of highlightable terms ✨

✨ HTTP AUTHENTICATION ✨

Some config options don't have a UI yet 🥺 The biggest one is HTTP authentication. If you want to use it, you'll have to edit your config file by hand. You'll find it at ~/.alice/config 📝

The config is just a perl hash 🧁 So if you know perl, it won't be too intimidating. If you don't know perl, sorry! :)

You'll need to add user and pass values to the auth hash. Your section of config might look something like this:

'auth' => {
  'user' => 'lee',
  'pass' => 'mypassword',
},

✨ COMMANDS ✨

• /j[oin] [-network] $channel — Takes a channel name plus an optional network flag. If you don't give a network flag, it uses the network of the current tab 🦋
• /close — Closes the current tab. If you use it in a channel, it'll also part the channel 👋
  • /wc and /part are aliases for /close 💖
• /clear — Clears the current tab's messages from your browser. It also clears the tab's message buffer, so refreshing won't bring them back 🧹
• /msg [-network] <nick> [<msg>] — Takes a nick and an optional network flag. No network flag? It uses the network of the current tab. A third argument can hold the message text. If you skip the message text, you'll get a blank tab opened for you 💌
  • /query is an alias for /msg 🫶
• /whois [-force] <nick> — Takes a nick and an optional force flag, then prints some info about that user 👀 If you add the force flag, the info gets refreshed from the server 🔄
• /quote <command> — Sends a string as a raw message to the server 🧾
  • /raw is an alias for /quote ✨
• /t[opic] [<topic>] — Takes an optional topic string and displays the topic for the current tab 📣 If you supply a string, it'll try to update the channel's topic. This only works in a channel 💅
• /n[ames] [-avatars] — Prints a table of all the nicks in the current tab 📋 Add the optional avatars flag to include avatars 🖼️
• /me <action> — Sends a string as an action to the channel 🎭 For example, e.g.:

* lee hits clint with a large trout

• /w[indow] <number> — Focuses the tab number you give it. It also accepts next or prev 🏃‍♀️ The space after the w can be left out, so /w4 focuses window 4 🎀
• /connect <network> — Connects to a network. The network has to be the name of a server from the Connections window 🔌 If you're already connected, it does nothing 🙃
• /disconnect <network> — Disconnects from a network. Same rule: the name has to be a server from the Connections window 🚪 This also stops any reconnect timers for that network ⏰
• /ignore <nick> — Ignores any nick that matches the one you give it, across all networks 🙈
• /ignores — Lists all active ignored nicks 📜
• /unignore <nick> — Unignores a nick 🫠

✨ NOTIFICATIONS ✨

If someone says your nick while no browsers are connected, you'll get a notification 🔔 It uses Growl (if you're running OS X) or libnotify (on Linux) 🐧

You can add extra patterns to highlight in the Preferences window 💜

If you're using Fluid.app (a SSB for OS X) or Chrome, you can also get notifications when the window is unfocused 🪄

✨ MOBILE INTERFACE ✨

Alice has an iPhone style sheet 📱 It may work in other mobile browsers too. Any help or bug reports would be sooo appreciated 🥹

✨ COPYRIGHT ✨

Copyright 2010 by Lee Aylward <leedo@cpan.org>

This program is free software 💖 You can redistribute it and/or modify it under the same terms as Perl itself 🧚

---

And that's the tea, bestie 🍵✨ This page came from perl v5.26.2, dated 2018-05-07, under the name App::Alice(3pm). Periodt! 💅🦋