ChatNinja (IRC chatbot)

[tokumei]

A work-in-progress modular chatbot API. I plan to have a command system as well as an event handler for IRC messages such as PM, join, part, etc which one can develop plugins around. My personal bot will most likely have a custom conversation bot and some useful calculator functions. The code may be viewed at http://github.com/NonemuNinja/ChatNinja or you can see my fork (with some more recent commits) at http://github.com/AGausmann/ChatNinja

[tokumei]

Here's a sneak peek of the user interface:

[redacted - obsolete]

I dunno if I will follow through with the UI. If I do, it will be 100% optional. There will also be a CLI to execute commands from.

[tokumei]

Latest update: I've purged the code of all UI elements so I can focus on more important things such as events, commands, and plugins surrounding them.

[Nickster258]

This looks quite nice.

[tokumei]

Update: The bot has a beta event scheduler now, but it still will do nothing if you try to run it

[tokumei]

Update: AFAIK the bot is able to connect to IRC servers and auto-join channels upon connection. It still has no front-end interface; you must modify the properties file in order to change the settings.

It now outputs private messages and some other commands sent by the server to the console. However, I'm still working on the command, event, and plugin subsystems. The biggest task right now is segregating the API from the implementation.

[PabloDons]

soo uh, what lang?

[tokumei]

All changes so far have been pushed to the upstream tree. Currently, it will auto-connect, auto-join, and throw all events that have been created at appropriate times. I'm currently working on the command system, then plugins will come after.

It now has an API which is independent of the official implementation. This allows for other implementations of the API, and also provides a standard library for plugin development.

soo uh, what lang?

Java (you should see it in github repository stats)

[tokumei]

I just added JavaDoc to the main repository, which will make it easier to contribute and develop plugins for the bot API. I plan on placing the generated docs at http://docs.nonemu.info/chatninja/. It should be automatically built once I have TeamCity up and running.

[tokumei]

The command system is progressing well!!!!!!

It features a generated help page, a beta permissions system, and pre-packaged utility/administration commands.

The debut:



I'll work on finalizing permissions and adding more utilities. Next, I will work on plugins. After that, it's a long series of bug tests and optimizations.

[tokumei]

Big update: The command system is now considered complete. It comes packaged with essential commands and the ability for the end user to create his own. Now he needs a stable way to do so - let's start developing the plugin system!

(NOTE: Any and all parts of the bot API and implementation are subject to change. Many architectural changes were made in this update and many more will probably come with the development of the plugin system. Develop at your own caution!)

[tokumei]

Okay, I've made a plugin loader that loads from the plugins/ directory. Instead of having a plugin.yml like Bukkit plugins, it uses a single entry in the JAR's manifest for the plugin class. Everything else is configured in code, including its name and the commands that it creates. Plugins are also allowed to load other plugins, which I may abstract into a dependency system.

[slugdude]

This looks seriously cool, more complete than any other bot I've seen.

Also +1 for Ubuntu

<3 Ubuntu.

[jxu]

well that's because most bots don't have UIs, that would be a client then?

[tokumei]

Not necessarily... That user interface was more of a graphical command line. Also, please note:

I've purged the code of all UI elements

---

complete

It is far from complete. I've had to fully redesign its backend since that screenshot was taken.

---

A mini-update: The Bukkit API has been monumental in helping me develop the plugin system. It shares a very similar architecture to Bukkit plugins; however, they are loaded in a slightly different way. I plan on finalizing the plugin API over the next couple of days, then extensive bot testing will begin.

[Chibill]

So bukkit is a good learning source for plugin systems!

[tokumei]

It does have a great example of class loading from jars outside of the classpath.

[slugdude]

complete

It is far from complete. I've had to fully redesign its backend since that screenshot was taken.

I didn't mean complete in terms of progress, I meant complete as in more features - a more complete feature palette.

[tokumei]

It's been a loooong time since I've had a post-worthy update, but here it is: Plugin loading is working!
I've been sidetracked by a lot of other small details and problems that have arisen, but I've finally gotten the bot to load and run plugins from JAR files. This is a big milestone for the bot, but a lot of testing is left to make sure there are no issues with the code.

I've also started working on the official ORE integration plugin. It will allow players logged in to ORE servers to execute bot commands and will provide commands that may be useful for ORE members.

[fluffy406]

It's been a loooong time since I've had a post-worthy update, but here it is: Plugin loading is working!
I've been sidetracked by a lot of other small details and problems that have arisen, but I've finally gotten the bot to load and run plugins from JAR files. This is a big milestone for the bot, but a lot of testing is left to make sure there are no issues with the code.

I've also started working on the official ORE integration plugin. It will allow players logged in to ORE servers to execute bot commands and will provide commands that may be useful for ORE members.

when it gonna be finished

[tokumei]

I just released 1.0pre on the github page (http://github.com/NonemuNinja/ChatNinja/releases ). The code can be run and properly configured to connect to any IRC server, but there is no documentation as of yet.

A release date will be set once most of the bugs have been fixed. Full docs will definitely come with the 1.0 release, if not earlier.

[jxu]

release

like anyone is going to use an irc client not made 5+ years ago

[tokumei]

My goal is simply to make it adaptable to fit the needs of others, like every other branded project of mine. I really don't care if nobody else will use it; it's just what I choose to do because it's good practice.

[tokumei]

I am now in the process of migrating everything to Maven, so it can be built by my new CI server and deployed at my Maven repository.