85 lines
1.8 KiB
Markdown
85 lines
1.8 KiB
Markdown
# PIRC — Python IRC Client
|
||
|
||
**PIRC** (Python IRC Client) is a lightweight, modern IRC client built with Python and PySide6. It’s designed for simplicity, usability, and modularity, making it easy to connect to multiple IRC servers with a clean, polished GUI.
|
||
|
||
## Features
|
||
|
||
- **Clean GUI with sidebar**
|
||
- Displays users with icons
|
||
- Admins at the top of user list
|
||
- **Favorites system**
|
||
- Save favorite servers and channels for quick access
|
||
- **System messages with timestamps**
|
||
- Join/part messages, topics, and important server messages
|
||
- Handshake messages filtered out for clean chat
|
||
- **Multiple accounts & servers**
|
||
- Add unlimited servers and accounts directly from the app
|
||
- **Easy packaging**
|
||
- Ready for AUR packaging or local installation
|
||
|
||
## Installation
|
||
|
||
### Requirements
|
||
|
||
- Python 3.10+
|
||
- PySide6 (`pip install PySide6`)
|
||
|
||
### Run Locally
|
||
|
||
1. Clone the repository:
|
||
|
||
```bash
|
||
git clone https://git.optimihost.com/optimidev/pirc.git
|
||
cd PIRC
|
||
````
|
||
|
||
2. Install dependencies:
|
||
|
||
```bash
|
||
pip install PySide6
|
||
```
|
||
|
||
3. Run the client:
|
||
|
||
```bash
|
||
python pirc.py
|
||
```
|
||
|
||
### Optional: AUR Installation (Arch Linux)
|
||
|
||
If you’re using Arch Linux, you can build and install PIRC from the AUR:
|
||
|
||
```bash
|
||
git clone https://aur.archlinux.org/pirc.git
|
||
cd pirc
|
||
makepkg -si
|
||
```
|
||
|
||
---
|
||
|
||
## Usage
|
||
|
||
1. On first launch, set your **username** in the setup wizard.
|
||
2. Add favorite servers and channels or skip this step.
|
||
3. Click **Add Server (+)** to connect to new IRC servers.
|
||
4. Select channels and chat with other users.
|
||
5. Admins are displayed at the top of the user list.
|
||
6. Normal users appear below with a regular icon.
|
||
|
||
|
||
---
|
||
|
||
## License
|
||
|
||
This project is licensed under the **MIT License**. See [LICENSE](LICENSE) for details.
|
||
|
||
---
|
||
|
||
## Contributing
|
||
|
||
Contributions are welcome! Feel free to submit issues or pull requests on git.optimihost.com
|
||
|
||
---
|
||
|
||
```
|