/Dynmap2CraftIRC3

Connects dynmap web chat to CraftIRC

Primary LanguageJavaOtherNOASSERTION

Dynmap2CraftIRC3

Do you use both dynmap and CraftIRC together? If so you will have noticed that people chatting in the IRC channel will not see any messages that were sent from dynmap's webchat feature and vice versa. This annoyed me since it created many awkward looking one sided conversations, and just caused general confusion among my players. So I decided to fix it!

What does this do?

This plugin connects CraftIRC 3 to dynmap's webchat. More specifically, it creates a new tag and endpoint visible to CraftIRC 3. With this plugin loaded, you can specify communication paths in your CraftIRC 3 config.yml to point to the tag "dynmap" to allow for chat flow between dynmap's webchat and any IRC channels that CraftIRC may be connected to.

How do I use it?

Dependencies

First, you need CraftIRC of at least version 3.1 and dynmap at least version 0.29. It may work with lower versions of dynmap, but that hasn't been tested. It definitely won't work with CraftIRC 2.

Setup

The only configuration required is in CraftIRC's config.yml. If you have:

setting:
    ...
    auto-paths: true
    ...

Then skip this section, it should automatically connect your dynmap webchat with IRC chat. I Don't recommend this way, as auto-paths seems to always create double messages for me. If it's false, and you're manually specifying your communication paths (my preferred method), then you will need to set up some new paths for this to work:

paths:
    ...
  - source: 'yourirctag'
    target: 'dynmap'

  - source: 'dynmap'
    target: 'yourirctag'
    ...

Formatting and Attributes configuration

The dynmap webchat endpoint is configured as a "plain" source, using the event type "dynmap". So if you wanted to format how the messages appeared, you would add a section under formatting called "from-plain" with a "dynmap" option, like so:

formatting:
    from-game:
        ...
    from-irc:
        ...
    from-plain:
        dynmap: '%green%[%source%]%o% %sender%: %message%'

Also, in order for the chat events to actually be sent, you must add "dynmap: true" under the default-attributes section:

	default-attributes:
		...
		attributes:
			chat: true
			action: true
			join: true
			...
			dynmap: true

Using it with CraftIRCDeath

If you would like death messages to also appear in dynmap's webchat, see my other plugin CraftIRCDeath!

Screenshots

This is what it looks like when you're chatting across the webchat, the game, and an IRC channel:

Dynmap Webchat

Dynmap webchat screenshot

IRC channel

IRC chat screenshot