https://github.com/pircbotx/pircbotx

Modern Java IRC Library
https://github.com/pircbotx/pircbotx

Last synced: 3 months ago
JSON representation

Modern Java IRC Library

• Host: GitHub
• URL: https://github.com/pircbotx/pircbotx
• Owner: pircbotx
• Created: 2015-04-23T02:51:55.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2024-01-02T14:34:53.000Z (about 1 year ago)
• Last Synced: 2024-08-04T00:11:18.313Z (6 months ago)
• Language: Java
• Homepage: http://pircbotx.github.io/pircbotx/latest/apidocs/
• Size: 11 MB
• Stars: 218
• Watchers: 23
• Forks: 71
• Open Issues: 25
• Metadata Files:
  • Readme: README.md
  • Authors: AUTHORS

Awesome Lists containing this project

• awesome-irc - PircBotX - Event based IRC Library with a straightforward API (updated fork of [PircBot](http://www.jibble.org/pircbot.php)). `Java` (Uncategorized / Uncategorized)

README

        
[![Java CI](https://github.com/pircbotx/pircbotx/actions/workflows/maven.yml/badge.svg?branch=pr_actions)](https://github.com/pircbotx/pircbotx/actions/workflows/maven.yml)

**PircBotX** is a powerful Java IRC Client library for bots and user clients. Version v2.3 (2022)

* Provides [63 IRC events](https://pircbotx.github.io/pircbotx/latest/apidocs/org/pircbotx/hooks/events/package-summary.html) in a multi-threaded listener system, including

  * Optimized Channel/User Model

  * Standard and reverse/passive DCC Chat and Filesharing powered by `java.nio`

  * CTCP VERSION, ACTION, PING, TIME, and FINGER

  * User modes op, voice, halfop, superops, and owner

  * Channel modes invite only, quiet, moderated, secret, limit, key

  * BANLIST, LIST (Channels), NAMES, QUIETLIST, WHO, and WHOIS

  * 001-005 server info, MOTD

  * Core IRC commands JOIN, QUIT, KICK, BAN, INVITE, AWAY, MODE, TOPIC

  * Nickserv integration with self register and other user's registration status

  * Auto join channels, auto WHO and MODE on channel join

* Connection features

  * [IRCv3 CAP negotiation](https://github.com/pircbotx/pircbotx/wiki/Documentation#cap-support) with native support for SASL, away-notify, and message tags

  * Robust connection handling with server list, attempt all DNS entries, auto retry, auto reconnect

  * Supports TLS IRC servers

  * Supports IPv6 IRC servers and DCC clients

  * Output message throttling, auto long line split

  * [WEBIRC authentication](https://github.com/pircbotx/pircbotx/wiki/Documentation#webirc-authentication)

  * Built in [Ident server](https://github.com/pircbotx/pircbotx/wiki/Documentation#ident-server)

  * MultiBotManager utility runs multiple bots on multiple servers

* Formatting utility for color, bold/underline/italics, and reverse

* Supports SLF4J MDC with context info, Marker on IO logs

* Java 8 to 17 Compatible

* High performance Parser

**Checkout the [Wiki](https://github.com/pircbotx/pircbotx/wiki/) for tutorials and documentation**

## PircBotX in 3 Steps

A brief getting started guide

* [Download PircBotX](https://github.com/pircbotx/pircbotx/wiki/Downloads)

* Create and execute the following class:

```java

import org.pircbotx.Configuration;

import org.pircbotx.PircBotX;

import org.pircbotx.hooks.ListenerAdapter;

import org.pircbotx.hooks.types.GenericMessageEvent;

public class MyListener extends ListenerAdapter {

    @Override

    public void onGenericMessage(GenericMessageEvent event) {

        //When someone says ?helloworld respond with "Hello World"

        if (event.getMessage().startsWith("?helloworld"))

            event.respond("Hello world!");

    }

    public static void main(String[] args) throws Exception {

        //Configure what we want our bot to do

        Configuration configuration = new Configuration.Builder()

                .setName("PircBotXUser") //Set the nick of the bot. CHANGE IN YOUR CODE

                .addServer("irc.freenode.net") //Join the freenode network

                .addAutoJoinChannel("#pircbotx") //Join the official #pircbotx channel

                .addListener(new MyListener()) //Add our listener that will be called on Events

                .buildConfiguration();

        //Create our bot with the configuration

        PircBotX bot = new PircBotX(configuration);

        //Connect to the server

        bot.startBot();

    }

}

```

* Join the #pircbotx channel on irc.freenode.net and send `?helloworld` . Your bot will respond with `Hello world!` Since its a GenericMessageEvent, it will also respond when private messaged. Congratulations, you just wrote your first bot!

PircBotX can do so much more! [Read the docs for more information](https://github.com/pircbotx/pircbotx/wiki/Documentation).

## Support

[Most answers can be found in the docs](https://github.com/pircbotx/pircbotx/wiki/Documentation), javadocs (https://pircbotx.github.io/pircbotx/latest/apidocs/) and [the wiki](https://github.com/pircbotx/pircbotx/wiki/).

[We also have a mailing list](https://groups.google.com/group/pircbotx).

## Status

PircBotX is stable with a majority of the modern IRC spec implemented. Feature requests and pull requests welcome.