Skip to content
This repository has been archived by the owner on Jun 3, 2021. It is now read-only.

A block, container and entity logging tool for the fabric mod loader

License

Notifications You must be signed in to change notification settings

QuiltServerTools/DeltaLogger

Repository files navigation

DeltaLogger

build discord stable Modrinth downloads GitHub downloads

Block and chest/container inventory tracking tool for fabric that can be configured to use MySQL or SQLite with a fast and responsive web UI. Join the DeltaLogger discord

Archival

Support for DeltaLogger will be dropped in 1.17 and above. Please see the discord for the replacement

Setup

DeltaLogger supports two types of database: MySQL and SQLite Place the mod jar in the mods folder of your server directory and launch your fabric server once to make it generate a config/deltalogger.properties, or make a file called deltalogger.properties in the config folder of your server directory. Put the following as the file content:

# DeltaLogger configuration

# Whether you want to use an SQLite database. Put false for MySQL.
use_sqlite=true

# Port to use for the web app. Navigate to http://serverhostname:port to see web app
webapp_port=

# Server domain url or hostname. Used for giving links to the web app
webapp_host=

##! MYSQL ONLY BELOW. If you are using SQLite these are safe to ignore. !##

# Name of the MySQL database to use. If you do not have one, then do
# "CREATE DATABASE yourdbname" from a MySQL client first.
database=

# MySQL port
port=
# MySQL host/url
host=
# MySQL username
username=
# MySQL password
password=

# MySQL SSL configuration. You can leave this as false but the database
# connection will not be encrypted. If you are using MySQL across the open internet
# then you should strongly consider properly enabling SSL
useSSL=false
requireSSL=false

By default, SQLite is enabled. This means that your logs will be saved to a database found in world/deltalogger.sqlite. If you want to use MySQL, fill out the additional properties with the relevant information to access your database and set use_sqlite to false.

This mod also requires the fabric api mod, which you can find here.

In Game Commands

  • /dl inspect Whack a block or container to see recent interactions with the target.
  • /dl inspect <pos> Shows database records for the block position provided.
  • /dl search <filters> Builds a database query with the parameters specified
  • /dl rollback <radius> <time> [filters] Runs a rollback with the terms specified
  • /dl resetpass get a temporary password for the web interface

Rollback time arguments

You can use any one of the following to specify your times, but you can only use one

<years>y <days>d <hours>h <minutes>m <seconds>s

Support

Support can be obtained on the discord found here

Download

You can find precompiled builds of DeltaLogger on Curseforge or Modrinth

License

Licensed under AGPL with additional linking permission. See LICENSE file.

Issues

If you find a bug, please open an issue on the issues page. Please ask on the discord if you have a support issue which is not a bug

Known Issues

We are aware of these issues, so please do not open any issues regarding these as they will be ignored, whether these will be fixed is at our discretion, so please do not beg to have one of these fixed as it is unlikely that we will do so.

Dynmap Incompatibility

Issue: Deltalogger does not work with Dynmap 3.1-beta7

Workaround: Use 3.1-beta6 until the issue is resolved.

Bits and Chisels

Issue: Bits and Chisels is incompatible with Deltalogger

Workaround: Currently none

Issue resolving

Issues which are not valid will be closed as invalid. We will fix remaining issues once we decide the time is right. Generally, major issues will be fixed first.

Build

You will need a JDK installed. We suggest AdoptOpenJDK 8, which you can download from their website. From there, just download the code, open a terminal in the location of the code and run the following command:

Windows: gradlew.bat build

Linux/macOS ./gradlew build

The mod jars are then found in build/libs. For almost all uses, you want the jar without -dev or -sources on the end

Contribute

Feel free to fork and open a pull request with features you add. We do suggest asking on the discord about a feature before spending loads on time on it! Ping @yitzy if you want to have access to the development channel

Translations

Please see translations.md for information about contributing translations