Contains top-level build scripts and configurations for compiling all components of DMDirc
Shell
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.nb-gradle
client @ 9cfdb63
etc
gradle
installers @ 4f69e20
parser @ b951ed4
plugins @ faebdab
util @ 8db9931
.gitignore
.gitmodules
.nb-gradle-properties
AUTHORS
KEYS
LICENCE
README.md
build.gradle
checkoutAt.sh
circle.yml
gradle.properties
gradlew
gradlew.bat
settings.gradle

README.md

DMDirc

DMDirc is an IRC client written in Java. It's cross-platform, hugely configurable, and is easily extensible with a robust plugins system.

DMDirc Screenshot

Getting DMDirc

To download and run the latest stable version of DMDirc, download an installer or archive for your platform from the releases page.

If there's not a distribution for your platform, you can download the Jar file instead. You will need to manually install OpenJDK 8 or newer in this case.

Repositories

This repository doesn't actually contain the source for DMDirc. Instead it's split over four different components, each with their own repository:

  • client: contains the main guts of the client
  • parser: an interface for parsers and a full IRC parser
  • plugins: official plugins, including the main UI
  • util: general purpose utility classes not directly related to IRC

Each of the repositories can be worked on and built independently of all the others (and we've paid particular care to make sure the parser and util projects can be dropped in to other applications with the minimum of fuss). If you actually want to develop the client, though, it's a lot easier if they're all together — that's what this repository is for! Each of the components mentioned above is included as a submodule, and there are some handy top-level build scripts for bundling everything together.

Development

Prerequisites

To build and run the DMDirc client, you will need to have Java 8 or greater. DMDirc will work with either the Oracle JDK or Open JDK. All other dependencies are downloaded by the build scripts automatically.

Project set up

First off, clone this repository and init the submodules:

git clone https://github.com/DMDirc/Meta.git
cd Meta
git submodule update --init --remote

You can then use the provided gradle wrapper to start a build, or run all the tests in the project:

./gradlew jar
./gradlew test

Using an IDE

We strongly recommend using IntelliJ IDEA. To get started install IDEA 2016.1 or newer and follow these steps to import the project and enable annotation processing:

  1. Select Import project
  2. Select the build.gradle file in this directory
  3. Ensure Create separate module per source set is ticked
  4. Click OK; you should see a list of modules
  5. Click OK; the IDE itself should now load
  6. Open the main settings window (File -> Settings)
  7. Under Build, Execution and Deployment navigate to Compiler, then Annotation Processors (you can also use the search field)
  8. Tick the box to enable annotation processing
  9. Change the Store generated sources relative to option to content root

Running the client

Once you have executed ./gradlew jar, a copy of the client jar will be placed in client/dist and all of the plugins will be collected in plugins/dist. For development work, it is often easiest to symlink the plugins directory from your DMDirc profile to the dist directory in the source tree. This ensures the latest plugins are always used.

For convenience a skeleton profile is located in etc/profile in this repository, and includes a symlink to the correct plugins directory. To run the client using this profile, use the -d option:

java -jar DMDirc.jar -d path/to/etc/profile

Contributing

Contributing changes

We welcome pull requests on GitHub for all the DMDirc repositories. The tests for the module will run on CircleCI, and the pull request will be updated with the result.

Please bear in mind that these are just unit tests for the individual modules — they don't test how your change will affect DMDirc itself. It's good practice to run all of the tests in the project and compile and run an actual client to make sure everything actually still works!

You can see an overview of open pull requests across all of the DMDirc projects here.

Continuous Integration and Code Coverage

The current CI and coverage status for the major projects are shown below:

Project Status Coverage Codacy
Meta Circle CI (No code) (No code)
Client Circle CI Coverage Status Codacy Badge
Parser Circle CI Coverage Status Codacy Badge
Plugins Circle CI Coverage Status Codacy Badge
Util Circle CI Coverage Status Codacy Badge

Issues

We track issues in each of the separate projects listed above (for example, issues with the IRC parser are raised in the 'parser' repository; issues with the Swing UI are raised in the 'plugins' repository). If you are unsure where to raise an issue, feel free to raise it in Meta (this repository) and we'll relocate it accordingly.

You can see an overview of open issues across all of the DMDirc projects here.

Miscellaneous

Running Clover

Clover is disabled by default as it requires a license file we can't distribute. If you have a Clover license, or have access to DMDirc's license, place it in etc/clover/clover.license.

To enable clover, set the enableClover property to true value:

./gradlew -PenableClover=true cloverAggregateReports

This will place a HTML report in build/reports/clover/html.

Dependencies

All cross-repository dependencies are specified as artifacts, rather than project dependencies. That means if (say) the client is compiled on its own, it will pull snapshot versions of the parser and util modules from our maven repository.

The meta repository includes a gradle build script that finds these dependencies and replaces them with project links instead. This ensures that while developing the client your changes are reflected across modules properly.