Skip to content
This repository has been archived by the owner on May 21, 2021. It is now read-only.
/ Thump Public archive

💬 A simple, highly configurable Minecraft chat multiplexer with built in IRC support

License

Notifications You must be signed in to change notification settings

WillowChat/Thump

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Thump

Introduction

Thump is a simple, highly configurable Minecraft chat multiplexer with built in IRC support.

It uses Warren and Kale, two IRCv3.2, unit tested IRC frameworks written in Kotlin.

See the Curse Forge page for current features.

Check the Issues for an idea of what needs doing before the next milestone is released.

Development builds are published at https://ci.carrot.codes/job/Willow/job/Thump/. Documentation is on the wiki.

It's mostly written in Kotlin. Sometimes the mixture of Forge, Java and Kotlin doesn't work well (for example, logging) - in these cases, it's written in Java.

Features

  • It's geared towards admins setting up simple server links, with sensible configuration defaults
  • If you don't like the defaults, there are configuration options for almost everything
  • You can "live reload" the mod without restarting your server - change your configuration and do /thump reload
  • Warren and Kale provide a great foundation for a stable IRC bridge

Support

If you use this library and you'd like to support my open-source work, please consider tipping through Patreon.

Building

This mod uses Forge's Gradle wrapper for pretty easy setup and building. There are better guides around the internet for using it, and I don't do anything particularly special.

The general idea:

  • Setup: ./gradlew clean [setupDevWorkspace/setupDecompWorkspace] [idea/eclipse]
  • Building: ./gradlew clean build

If you run in to odd Gradle issues, doing ./gradlew clean usually fixes it.

Code License

The source code of this project is licensed under the terms of the ISC license, listed in the LICENSE file. A concise summary of the ISC license is available at choosealicense.org.

About

💬 A simple, highly configurable Minecraft chat multiplexer with built in IRC support

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published