Getting Started - edgeof8/tIRC GitHub Wiki

Introduction

tIRC is a modern, asynchronous IRC client built with Python, designed to be both powerful and extensible. This guide will help you get started with tIRC, from installation to your first connection.

Note: tIRC requires Python 3.9 or higher.

Installation

You can install tIRC using pip:

# Clone the repository
git clone https://github.com/edgeof8/tIRC.git
cd tIRC

# Create and activate a virtual environment
python -m venv venv
# On Windows:
.\venv\Scripts\activate
# On Unix/macOS:
# source venv/bin/activate

# Install the package in development mode
pip install -e .

Configuration

tIRC looks for a configuration file at ~/.config/tirc/config.ini or you can specify a custom path using the --config flag.

Here's a basic configuration example:

[server]
address = irc.libera.chat
port = 6697
ssl = true
nick = YourNickname
username = YourUsername
realname = Your Real Name
channels = #python,#testing

[ui]
theme = default
message_history = 1000

[logging]
level = INFO
file = tirc.log

First Steps

Once you've installed and configured tIRC, you can start the client:

# Start tIRC
python -m tirc_core

Basic Commands

  • /connect - Connect to a server
  • /join #channel - Join a channel
  • /msg nickname - Start a private message
  • /help - Show help information

Tip: Press Tab for command and nickname completion.