How song682/catframe-compat works
CatFrame Compat is a Minecraft mod that bridges CatFrame to selected mods and adds developer-facing model, localization, and UI tools. The main lifecycle configures compatibility, then client initialization conditionally registers rendering bridges and overlays; separate utilities cover model bounds, blockstate transforms, tags, physics, and language loading. The UI branch provides themed screens, animations, notifications, and a developing web-view API. Edges reflect only lifecycle and calls explicitly evidenced by excerpts or README; several README capabilities have unsampled implementations, so their internal wiring is left unspecified.
Main entry points: ClientProxy.java Client Setup · NotificationManager.java Notification Manager · CatFrameCompat.java Mod Entry · AnimationEngine.java Animation Engine
Components 34
Mod Lifecycle
- Mod Entry
src/main/java/decok/dfcdvadstf/catframe/CatFrameCompat.java - Compatibility Config
src/main/java/decok/dfcdvadstf/catframe/CompatConfig.java - Client Setup
src/main/java/decok/dfcdvadstf/catframe/compact/proxy/ClientProxy.java
Compatibility Bridges
- Mod Detection
src/main/java/decok/dfcdvadstf/catframe/compact/CompactBase.java - IME Support
src/main/java/decok/dfcdvadstf/catframe/compact/ime/IgIMECompact.java - CTM Bridges
src/main/java/decok/dfcdvadstf/catframe/compact/mcpatcher/ctm/CTMRenderExtension.java - Right Proper CTM
src/main/java/decok/dfcdvadstf/catframe/compact/mcpatcher/ctm/RPCTMRenderExtension.java - Natural Textures
src/main/java/decok/dfcdvadstf/catframe/compact/mcpatcher/natural/NaturalExtension.java - Right Proper Natural
src/main/java/decok/dfcdvadstf/catframe/compact/mcpatcher/natural/RPNaturalExtension.java - Pineapple Tags
src/main/java/decok/dfcdvadstf/catframe/compact/tags/PineTags.java - Item Physics
src/main/java/decok/dfcdvadstf/catframe/compact/physic/ItemPhysic.java - Physics Mixin
src/main/java/decok/dfcdvadstf/catframe/compact/mixin/late/MixinItemPhysics.java
Model And Language
- Model Bounds
src/main/java/decok/dfcdvadstf/catframe/model/extended/json/bounds/ModelBounds.java - Blockstate Transform
src/main/java/decok/dfcdvadstf/catframe/model/extended/json/transformation/BlockstateTransform.java - Language Scanner
src/main/java/decok/dfcdvadstf/catframe/language/LanguageScanner.java
Extended UI
- Extended Screen
src/main/java/decok/dfcdvadstf/catframe/ui/extended/ScreenExtended.java - Animation Engine
src/main/java/decok/dfcdvadstf/catframe/ui/extended/animation/engine/AnimationEngine.java - Animation Contract
src/main/java/decok/dfcdvadstf/catframe/ui/extended/animation/Animation.java - Animation Base
src/main/java/decok/dfcdvadstf/catframe/ui/extended/animation/AbstractAnimation.java - Screen Transition
src/main/java/decok/dfcdvadstf/catframe/ui/extended/animation/impliment/ScreenTransition.java - Easing Function
src/main/java/decok/dfcdvadstf/catframe/ui/extended/animation/impliment/EasingFunction.java - GL State
src/main/java/decok/dfcdvadstf/catframe/ui/extended/animation/engine/GlState.java - Theme Manager
src/main/java/decok/dfcdvadstf/catframe/ui/extended/theme/ThemeManager.java - Default Theme
src/main/java/decok/dfcdvadstf/catframe/ui/extended/theme/DefaultTheme.java - Theme Keys
src/main/java/decok/dfcdvadstf/catframe/ui/extended/theme/ThemeKeys.java - Theme Controls
src/main/java/decok/dfcdvadstf/catframe/ui/extended/theme/ThemeCommand.java - Theme Hotkey
src/main/java/decok/dfcdvadstf/catframe/ui/extended/theme/ThemeKeyHandler.java - JSON Theme Loader
src/main/java/decok/dfcdvadstf/catframe/ui/extended/theme/JsonThemeLoader.java - Notification Manager
src/main/java/decok/dfcdvadstf/catframe/ui/extended/components/notifications/NotificationManager.java - Notification Data
src/main/java/decok/dfcdvadstf/catframe/ui/extended/components/notifications/Notification.java - Notification Renderer
src/main/java/decok/dfcdvadstf/catframe/ui/extended/components/notifications/NotificationRenderer.java - Notification Parser
src/main/java/decok/dfcdvadstf/catframe/compact/notification/NotificationJsonParser.java - Notification Packets
src/main/java/decok/dfcdvadstf/catframe/compact/notification/network/NotificationPacketHandler.java
Other components
- Mod Loader
Connections 24
- Mod Loader → Mod Entry: loads mod
src/main/java/decok/dfcdvadstf/catframe/CatFrameCompat.java - Mod Entry → Compatibility Config: creates config
src/main/java/decok/dfcdvadstf/catframe/CatFrameCompat.java - Mod Entry → Client Setup: delegates lifecycle
src/main/java/decok/dfcdvadstf/catframe/CatFrameCompat.java - Client Setup → Mod Detection: checks installed mods
src/main/java/decok/dfcdvadstf/catframe/compact/proxy/ClientProxy.java - Client Setup → CTM Bridges: registers bridge
src/main/java/decok/dfcdvadstf/catframe/compact/proxy/ClientProxy.java - Client Setup → Right Proper CTM: registers bridge
src/main/java/decok/dfcdvadstf/catframe/compact/proxy/ClientProxy.java - Client Setup → Natural Textures: registers bridge
src/main/java/decok/dfcdvadstf/catframe/compact/proxy/ClientProxy.java - Client Setup → Right Proper Natural: registers bridge
src/main/java/decok/dfcdvadstf/catframe/compact/proxy/ClientProxy.java - Client Setup → Notification Manager: registers overlay
src/main/java/decok/dfcdvadstf/catframe/compact/proxy/ClientProxy.java - Item Physics → Physics Mixin: uses mixin
src/main/java/decok/dfcdvadstf/catframe/compact/physic/ItemPhysic.java - Client Setup → Theme Controls: registers command
src/main/java/decok/dfcdvadstf/catframe/compact/proxy/ClientProxy.java - Client Setup → Theme Hotkey: registers hotkey
src/main/java/decok/dfcdvadstf/catframe/compact/proxy/ClientProxy.java - Extended Screen → Animation Engine: ticks animations
src/main/java/decok/dfcdvadstf/catframe/ui/extended/ScreenExtended.java - Extended Screen → Theme Manager: resolves theme
src/main/java/decok/dfcdvadstf/catframe/ui/extended/ScreenExtended.java - Animation Engine → Animation Contract: ticks and reads
src/main/java/decok/dfcdvadstf/catframe/ui/extended/animation/engine/AnimationEngine.java - Animation Base → Easing Function: maps progress
src/main/java/decok/dfcdvadstf/catframe/ui/extended/animation/AbstractAnimation.java - Screen Transition → Animation Base: extends lifecycle
src/main/java/decok/dfcdvadstf/catframe/ui/extended/animation/impliment/ScreenTransition.java - Screen Transition → GL State: populates state
src/main/java/decok/dfcdvadstf/catframe/ui/extended/animation/impliment/ScreenTransition.java - Animation Engine → GL State: reads render state
src/main/java/decok/dfcdvadstf/catframe/ui/extended/animation/engine/AnimationEngine.java - Theme Manager → Default Theme: falls back
src/main/java/decok/dfcdvadstf/catframe/ui/extended/theme/ThemeManager.java - Notification Manager → Notification Renderer: renders active
src/main/java/decok/dfcdvadstf/catframe/ui/extended/components/notifications/NotificationManager.java - Notification Manager → Notification Data: queues notifications
src/main/java/decok/dfcdvadstf/catframe/ui/extended/components/notifications/NotificationManager.java - Notification Parser → Notification Data: parses definitions
src/main/java/decok/dfcdvadstf/catframe/compact/notification/NotificationJsonParser.java - Notification Packets → Notification Manager: dispatches packets
src/main/java/decok/dfcdvadstf/catframe/compact/notification/network/NotificationPacketHandler.java