Docs | Javadoc | Hangar | Modrinth | MIT License
ClockTime is a multi-platform Minecraft plugin and mod written in Java, designed to bring localized, client-side formatted in-game time displays to players. Built on clean architecture principles, the repository separates platform-agnostic domain logic from specific loader platform implementations.
The codebase is organized as a multi-project Gradle build under the modules/ directory:
- clock-time-common: Pure Java domain layer containing tick-to-time math, dimension resolvers, and core translation properties files. No platform-specific dependencies.
- clock-time-paper: Paper/Spigot adapter handling configuration, event handling, command registration, and Bukkit integrations.
- clock-time-fabric: Fabric loader adapter implementing events and environment integrations.
Detailed architectural analysis can be found in the Architecture Explanation.
To avoid redundant information, please refer directly to the canonical files and documentation pages:
- Code Style & Development Workflow: See CONTRIBUTING.md for guidelines on JDK versions, build/test commands (
./gradlew build), code formatting (Spotless), and pulling request workflows. - Local Documentation Setup: Instructions on running the documentation server using
uvandmkdocsare located in CONTRIBUTING.md. - Dependency Integration: Learn how to declare ClockTime as a Gradle or Maven dependency in the Dependency Configuration Guide.
- API Reference: Look up Javadocs and programmatical queries in the API reference.
- Release Guidelines: Version numbers bump, changelog rules, and release tags publishing are detailed in CONTRIBUTING.md.
- Licensing: This project is licensed under the MIT License; see LICENSE.