Chris Smith 08f54bad9f Fix getStyledText() scrubbing underline and stop chars. | 7 роки тому | |
---|---|---|
api | 7 роки тому | |
etc | 9 роки тому | |
gradle | 7 роки тому | |
src | 7 роки тому | |
.gitignore | 7 роки тому | |
AUTHORS | 10 роки тому | |
LICENCE | 9 роки тому | |
README.md | 8 роки тому | |
UpdateCopyright.sh | 10 роки тому | |
build-installer.xml | 10 роки тому | |
build.gradle | 7 роки тому | |
circle.yml | 9 роки тому | |
gradle.properties | 9 роки тому | |
gradlew | 7 роки тому | |
gradlew.bat | 7 роки тому | |
settings.gradle | 7 роки тому |
DMDirc is an IRC client written in Java. It’s cross-platform, hugely configurable, and is easily extensible with a robust plugins system.
This repository contains the ‘core’ of the client. If you’re interested in developing DMDirc or building it from scratch, you’d be much better off cloning the meta repository, which contains the core, plugins, IRC library, etc. Detailed setup instructions are available there as well.
Text shown in windows (channels, servers, etc) is generated automatically from
certain types of events passed on the DMDirc event bus. Any event that subclasses
DisplayableEvent
can potentially be formatted.
DisplayableEvents are listened for by each window’s BackBuffer
instance. A format is then applied to the event to transform it into one or more strings. Formats
are specified in a YAML file included in the DMDirc jar,
and can be overridden by the user by putting a format.yml
file in their DMDirc config directory.
A couple of typical formatting entries looks like this:
ChannelMessageEvent:
format: "<{{client.modePrefixedNickname}}> {{message}}"
ChannelModeNoticeEvent:
format: "-{{client.modePrefixedNickname}}:{{prefix}}{{channel.name}}- {{message}}"
colour: 5
The {{..}}
templates retrieve properties from the event itself. {{client.modePrefixedNickname}}
is the equivalent of calling getClient().getModePrefixedNickname().toString()
on the event object.
DMDirc has a user interface for displaying details of errors to users. It also supports uploading of errors to the DMDirc sentry instance if the user allows it (or manually clicks on send).
Errors should be logged using a Slf4j logger, and
marked with one markers defined in LogUtils
.
These markers allow developers to specify whether an error is an “Application”
error (which will get reported and should ultimately be fixed), or a “User”
error (which is due to a problem with the user’s config, environment, etc),
and also whether the error is fatal or not.
A typical class that reports errors will look something like the following:
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import static com.dmdirc.util.LogUtils.APP_ERROR;
public class MyClass {
private static final Logger LOG = LoggerFactory.getLogger(MyClass.class);
public void doSomething() {
try {
// Do something
} catch (SomeException ex) {
LOG.error(APP_ERROR, "Couldn't do something!", ex);
}
}
}