/Alix

A Java IRC API

Primary LanguageJavaGNU General Public License v3.0GPL-3.0

Alix

A Java IRC API

Documentation on IRCv3 for future: http://ircv3.atheme.org/

Alix tries to be stable, but for now there isn't really any good versionning. Recommending using latest dev build.

How to maven:

	...
	<repositories>
		<repository>
			<id>ribesg-releases</id>
			<name>Ribesg's Release Repository</name>
			<url>http://repo.ribesg.fr/content/repositories/releases</url>
		</repository>
		<repository>
			<id>ribesg-snapshots</id>
			<name>Ribesg's Snapshot Repository</name>
			<url>http://repo.ribesg.fr/content/repositories/snapshots</url>
		</repository>
	</repositories>

	<dependencies>
		<dependency>
			<groupId>fr.ribesg.alix</groupId>
			<artifactId>alix</artifactId>
			<version>[0,) <!-- Means LATEST --></version>
		</dependency>
	</dependencies>
	...

Then just read the fr.ribesg.alix.api.Client class, and extend it !
There's an example client: fr.ribesg.alix.TestClient

FAQ

Hey something is not in the API, what do I do?

There are 2 solutions:

  1. Fork the repository on Github, do it yourself in a cool way and create a Pull Request! Also add some links to documentation/specifications about what you implemented.
  2. Create an Issue with tons of details about what you want, why you want it, links to RFCs or other documentations, etc. Then wait for somebody to implement it in the previously stated cool way!

In both cases, you can make a workaround using Client#onRawIrcMessage(Server, Message) while waiting for your feature to be merged/implemented in the project!