# nicklueth/tameable-guinea-pigs architecture

> Architecture diagram of the GitHub repository nicklueth/tameable-guinea-pigs, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/nicklueth/tameable-guinea-pigs
- Repository: https://github.com/nicklueth/tameable-guinea-pigs

## Overview

Tameable Guinea Pigs is a Fabric Minecraft mod. Players encounter forest-spawned guinea pigs, tame and care for them, breed them, and use their droppings; the mod also provides variant-aware models, animations, and sounds. The graph separates entity behavior, registration and spawning, items, and client presentation. Edges are limited to calls or references shown in excerpts/index or capabilities documented in the README; unsampled implementation details are not inferred.

Main entry points: [`src/main/java/net/nitwit/guinea_pigs/entity/custom/GuineaPigEntity.java`](https://github.com/nicklueth/tameable-guinea-pigs/blob/26.3/src/main/java/net/nitwit/guinea_pigs/entity/custom/GuineaPigEntity.java) (Taming and care), [`src/main/java/net/nitwit/guinea_pigs/entity/ModEntities.java`](https://github.com/nicklueth/tameable-guinea-pigs/blob/26.3/src/main/java/net/nitwit/guinea_pigs/entity/ModEntities.java) (Entity type), [`src/main/java/net/nitwit/guinea_pigs/GuineaPigs.java`](https://github.com/nicklueth/tameable-guinea-pigs/blob/26.3/src/main/java/net/nitwit/guinea_pigs/GuineaPigs.java) (Mod initializer), [`src/main/java/net/nitwit/guinea_pigs/item/ModItems.java`](https://github.com/nicklueth/tameable-guinea-pigs/blob/26.3/src/main/java/net/nitwit/guinea_pigs/item/ModItems.java) (Item registration)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_setup["Mod Registration"]
  node_initializer["Mod initializer<br/>[GuineaPigs.java]"]
  node_entity_type["Entity type<br/>[ModEntities.java]"]
  node_spawn_rules["Natural spawning"]
  node_world_gen["World generation setup"]
end

subgraph group_creatures["Guinea Pig Gameplay"]
  node_pig["Taming and care"]
  node_variants["Pig variants"]
end

subgraph group_items["Items and Sounds"]
  node_items_registry["Item registration<br/>[ModItems.java]"]
  node_droppings["Droppings item<br/>[DroppingsItem.java]"]
  node_sounds["Sound events<br/>[ModSounds.java]"]
end

subgraph group_client["Client Presentation"]
  node_client_init["Client registration"]
  node_renderer["Pig renderer"]
  node_model["Pig model"]
  node_animations["Animation definitions"]
  node_model_provider["Item model generation"]
end

node_player(("Minecraft player"))

node_initializer -->|"registers items"| node_items_registry
node_initializer -->|"registers entities"| node_entity_type
node_initializer -->|"sets up world"| node_world_gen
node_initializer -->|"registers sounds"| node_sounds
node_initializer -->|"registers attributes"| node_pig
node_world_gen -->|"invokes spawning"| node_spawn_rules
node_spawn_rules -->|"selects entity"| node_entity_type
node_entity_type -->|"constructs entity"| node_pig
node_player -->|"tames and cares"| node_pig
node_pig -->|"creates offspring"| node_entity_type
node_pig -->|"checks food items"| node_items_registry
node_pig -->|"plays sounds"| node_sounds
node_items_registry -->|"configures spawn egg"| node_entity_type
node_items_registry -->|"creates item"| node_droppings
node_client_init -->|"registers renderer for"| node_entity_type
node_client_init -->|"registers renderer"| node_renderer
node_renderer -->|"constructs model"| node_model
node_renderer -->|"extracts state"| node_pig
node_renderer -->|"selects texture"| node_variants
node_model -->|"bakes animations"| node_animations
node_model_provider -->|"generates item models"| node_items_registry

click node_initializer "https://github.com/nicklueth/tameable-guinea-pigs/blob/26.3/src/main/java/net/nitwit/guinea_pigs/GuineaPigs.java"
click node_entity_type "https://github.com/nicklueth/tameable-guinea-pigs/blob/26.3/src/main/java/net/nitwit/guinea_pigs/entity/ModEntities.java"
click node_spawn_rules "https://github.com/nicklueth/tameable-guinea-pigs/blob/26.3/src/main/java/net/nitwit/guinea_pigs/world/gen/ModEntitySpawns.java"
click node_world_gen "https://github.com/nicklueth/tameable-guinea-pigs/blob/26.3/src/main/java/net/nitwit/guinea_pigs/world/gen/ModWorldGeneration.java"
click node_pig "https://github.com/nicklueth/tameable-guinea-pigs/blob/26.3/src/main/java/net/nitwit/guinea_pigs/entity/custom/GuineaPigEntity.java"
click node_variants "https://github.com/nicklueth/tameable-guinea-pigs/blob/26.3/src/main/java/net/nitwit/guinea_pigs/entity/custom/GuineaPigVariant.java"
click node_items_registry "https://github.com/nicklueth/tameable-guinea-pigs/blob/26.3/src/main/java/net/nitwit/guinea_pigs/item/ModItems.java"
click node_droppings "https://github.com/nicklueth/tameable-guinea-pigs/blob/26.3/src/main/java/net/nitwit/guinea_pigs/item/custom/DroppingsItem.java"
click node_sounds "https://github.com/nicklueth/tameable-guinea-pigs/blob/26.3/src/main/java/net/nitwit/guinea_pigs/sound/ModSounds.java"
click node_client_init "https://github.com/nicklueth/tameable-guinea-pigs/blob/26.3/src/client/java/net/nitwit/guinea_pigs/GuineaPigsClient.java"
click node_renderer "https://github.com/nicklueth/tameable-guinea-pigs/blob/26.3/src/client/java/net/nitwit/guinea_pigs/entity/client/GuineaPigRenderer.java"
click node_model "https://github.com/nicklueth/tameable-guinea-pigs/blob/26.3/src/client/java/net/nitwit/guinea_pigs/entity/client/GuineaPigModel.java"
click node_animations "https://github.com/nicklueth/tameable-guinea-pigs/blob/26.3/src/client/java/net/nitwit/guinea_pigs/entity/client/GuineaPigAnimations.java"
click node_model_provider "https://github.com/nicklueth/tameable-guinea-pigs/blob/26.3/src/client/java/net/nitwit/guinea_pigs/datagen/ModModelProvider.java"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_initializer,node_entity_type,node_spawn_rules,node_world_gen toneBlue
class node_pig,node_variants toneAmber
class node_items_registry,node_droppings,node_sounds toneMint
class node_client_init,node_renderer,node_model,node_animations,node_model_provider toneRose
class node_player toneIndigo
```

## Components

### Mod Registration

- [Mod initializer](https://github.com/nicklueth/tameable-guinea-pigs/blob/26.3/src/main/java/net/nitwit/guinea_pigs/GuineaPigs.java): `src/main/java/net/nitwit/guinea_pigs/GuineaPigs.java`
- [Entity type](https://github.com/nicklueth/tameable-guinea-pigs/blob/26.3/src/main/java/net/nitwit/guinea_pigs/entity/ModEntities.java): `src/main/java/net/nitwit/guinea_pigs/entity/ModEntities.java`
- [Natural spawning](https://github.com/nicklueth/tameable-guinea-pigs/blob/26.3/src/main/java/net/nitwit/guinea_pigs/world/gen/ModEntitySpawns.java): `src/main/java/net/nitwit/guinea_pigs/world/gen/ModEntitySpawns.java`
- [World generation setup](https://github.com/nicklueth/tameable-guinea-pigs/blob/26.3/src/main/java/net/nitwit/guinea_pigs/world/gen/ModWorldGeneration.java): `src/main/java/net/nitwit/guinea_pigs/world/gen/ModWorldGeneration.java`

### Guinea Pig Gameplay

- [Taming and care](https://github.com/nicklueth/tameable-guinea-pigs/blob/26.3/src/main/java/net/nitwit/guinea_pigs/entity/custom/GuineaPigEntity.java): `src/main/java/net/nitwit/guinea_pigs/entity/custom/GuineaPigEntity.java`
- [Pig variants](https://github.com/nicklueth/tameable-guinea-pigs/blob/26.3/src/main/java/net/nitwit/guinea_pigs/entity/custom/GuineaPigVariant.java): `src/main/java/net/nitwit/guinea_pigs/entity/custom/GuineaPigVariant.java`

### Items and Sounds

- [Item registration](https://github.com/nicklueth/tameable-guinea-pigs/blob/26.3/src/main/java/net/nitwit/guinea_pigs/item/ModItems.java): `src/main/java/net/nitwit/guinea_pigs/item/ModItems.java`
- [Droppings item](https://github.com/nicklueth/tameable-guinea-pigs/blob/26.3/src/main/java/net/nitwit/guinea_pigs/item/custom/DroppingsItem.java): `src/main/java/net/nitwit/guinea_pigs/item/custom/DroppingsItem.java`
- [Sound events](https://github.com/nicklueth/tameable-guinea-pigs/blob/26.3/src/main/java/net/nitwit/guinea_pigs/sound/ModSounds.java): `src/main/java/net/nitwit/guinea_pigs/sound/ModSounds.java`

### Client Presentation

- [Client registration](https://github.com/nicklueth/tameable-guinea-pigs/blob/26.3/src/client/java/net/nitwit/guinea_pigs/GuineaPigsClient.java): `src/client/java/net/nitwit/guinea_pigs/GuineaPigsClient.java`
- [Pig renderer](https://github.com/nicklueth/tameable-guinea-pigs/blob/26.3/src/client/java/net/nitwit/guinea_pigs/entity/client/GuineaPigRenderer.java): `src/client/java/net/nitwit/guinea_pigs/entity/client/GuineaPigRenderer.java`
- [Pig model](https://github.com/nicklueth/tameable-guinea-pigs/blob/26.3/src/client/java/net/nitwit/guinea_pigs/entity/client/GuineaPigModel.java): `src/client/java/net/nitwit/guinea_pigs/entity/client/GuineaPigModel.java`
- [Animation definitions](https://github.com/nicklueth/tameable-guinea-pigs/blob/26.3/src/client/java/net/nitwit/guinea_pigs/entity/client/GuineaPigAnimations.java): `src/client/java/net/nitwit/guinea_pigs/entity/client/GuineaPigAnimations.java`
- [Item model generation](https://github.com/nicklueth/tameable-guinea-pigs/blob/26.3/src/client/java/net/nitwit/guinea_pigs/datagen/ModModelProvider.java): `src/client/java/net/nitwit/guinea_pigs/datagen/ModModelProvider.java`

### Other components

- **Minecraft player**

## Connections

- Mod initializer → Item registration: registers items (evidence: `src/main/java/net/nitwit/guinea_pigs/GuineaPigs.java`)
- Mod initializer → Entity type: registers entities (evidence: `src/main/java/net/nitwit/guinea_pigs/GuineaPigs.java`)
- Mod initializer → World generation setup: sets up world (evidence: `src/main/java/net/nitwit/guinea_pigs/GuineaPigs.java`)
- Mod initializer → Sound events: registers sounds (evidence: `src/main/java/net/nitwit/guinea_pigs/GuineaPigs.java`)
- Mod initializer → Taming and care: registers attributes (evidence: `src/main/java/net/nitwit/guinea_pigs/GuineaPigs.java`)
- World generation setup → Natural spawning: invokes spawning (evidence: `src/main/java/net/nitwit/guinea_pigs/world/gen/ModWorldGeneration.java`)
- Natural spawning → Entity type: selects entity (evidence: `src/main/java/net/nitwit/guinea_pigs/world/gen/ModEntitySpawns.java`)
- Entity type → Taming and care: constructs entity (evidence: `src/main/java/net/nitwit/guinea_pigs/entity/ModEntities.java`)
- Minecraft player → Taming and care: tames and cares (evidence: `README.md`)
- Taming and care → Entity type: creates offspring (evidence: `src/main/java/net/nitwit/guinea_pigs/entity/custom/GuineaPigEntity.java`)
- Taming and care → Item registration: checks food items (evidence: `src/main/java/net/nitwit/guinea_pigs/entity/custom/GuineaPigEntity.java`)
- Taming and care → Sound events: plays sounds (evidence: `src/main/java/net/nitwit/guinea_pigs/entity/custom/GuineaPigEntity.java`)
- Item registration → Entity type: configures spawn egg (evidence: `src/main/java/net/nitwit/guinea_pigs/item/ModItems.java`)
- Item registration → Droppings item: creates item (evidence: `src/main/java/net/nitwit/guinea_pigs/item/ModItems.java`)
- Client registration → Entity type: registers renderer for (evidence: `src/client/java/net/nitwit/guinea_pigs/GuineaPigsClient.java`)
- Client registration → Pig renderer: registers renderer (evidence: `src/client/java/net/nitwit/guinea_pigs/GuineaPigsClient.java`)
- Pig renderer → Pig model: constructs model (evidence: `src/client/java/net/nitwit/guinea_pigs/entity/client/GuineaPigRenderer.java`)
- Pig renderer → Taming and care: extracts state (evidence: `src/client/java/net/nitwit/guinea_pigs/entity/client/GuineaPigRenderer.java`)
- Pig renderer → Pig variants: selects texture (evidence: `src/client/java/net/nitwit/guinea_pigs/entity/client/GuineaPigRenderer.java`)
- Pig model → Animation definitions: bakes animations (evidence: `src/client/java/net/nitwit/guinea_pigs/entity/client/GuineaPigModel.java`)
- Item model generation → Item registration: generates item models (evidence: `src/client/java/net/nitwit/guinea_pigs/datagen/ModModelProvider.java`)
