Quick Start - edgeof8/tIRC GitHub Wiki

Get started with tIRC in a few easy steps.

Prerequisites

  • Python 3.8 or higher
  • pip (Python package installer)
  • windows-curses (on Windows)
  • pyfiglet (optional, for /ascii command)

Easy Setup: Follow these steps to get tIRC up and running quickly.

Installation

tIRC can be installed directly from PyPI:

pip install tirc

Alternatively, you can install the latest development version from GitHub:

pip install git+https://github.com/edgeof8/tIRC.git

Configuration

tIRC uses tirc_config.ini in its root directory. To get started, copy the example configuration file:

cp tirc_config.ini.example tirc_config.ini

Then, edit tirc_config.ini to customize your server settings and identity. A basic example:

[Server.YourServerName]
address = irc.libera.chat
port = 6697
ssl = true
nick = YourNick
channels = #yourchannel,#anotherchannel

[identity]
username = yourusername
realname = Your Real Name

For more detailed configuration options, refer to the Advanced Usage section.

Running tIRC

Once installed and configured, run tIRC from your terminal:

tirc

Command-line Overrides

You can override server settings directly from the command line:

tirc --connect irc.example.com --nick MyNick --channel #mychannel

Headless Mode

To run tIRC without a UI (e.g., for bots or automated testing), use the --headless flag:

tirc --headless --connect irc.libera.chat

Troubleshooting

If you encounter any issues, please refer to the Troubleshooting guide for common problems and solutions, or check the Debugging And Logging page.