# ctnstudio/chineseweapons architecture

> Architecture diagram of the GitHub repository ctnstudio/chineseweapons, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ctnstudio/chineseweapons
- Repository: https://github.com/ctnstudio/chineseweapons

## Overview

Chinese Weapons is a Forge mod adding historical weapons and armor, combat mechanics, and an in-game weapon-casting table. The main player workflow is to acquire mod items, use them in combat or place ingredients in the casting table, and collect crafted output; the table’s block entity owns recipe matching and progress. The README also documents KubeJS scriptability of weapon attributes and casting recipes. Some connections below are based on registration references or README documentation; unsampled feature internals are represented at subsystem level rather than inferred in detail.

Main entry points: [`src/main/java/net/mirrorloong/chineseweapons/recipes/WCTRecipe.java`](https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/recipes/WCTRecipe.java) (Casting Recipe), [`src/main/java/net/mirrorloong/chineseweapons/block/ArmorCastingTableBlockEntity.java`](https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/block/ArmorCastingTableBlockEntity.java) (Casting Table), [`src/main/java/net/mirrorloong/chineseweapons/ChineseweaponsMod.java`](https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/ChineseweaponsMod.java) (Mod Bootstrap), [`src/main/java/net/mirrorloong/chineseweapons/init/ChineseweaponsModItems.java`](https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/init/ChineseweaponsModItems.java) (Weapons & Armor)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_registration["Mod Registration"]
  node_mod["Mod Bootstrap"]
  node_blocks["Blocks"]
  node_items["Weapons &amp; Armor"]
end

subgraph group_casting["Weapon Casting"]
  node_table["Casting Table"]
  node_casting_menu["Casting Menu"]
  node_casting_screen["Casting Screen"]
  node_recipe["Casting Recipe<br/>[WCTRecipe.java]"]
  node_recipe_types["Recipe Registration"]
  node_serializer["Recipe Serializer<br/>[WCTRecipeSer.java]"]
  node_progress_packet["Progress Sync"]
end

subgraph group_combat["Combat Content"]
  node_weapon_families["Weapon Behavior"]
  node_special_weapon["Gu Duo Weapon<br/>[GuDuoItem.java]"]
  node_combat_events["Combat Events"]
  node_shield_item["Standing Shield"]
  node_shield_entity["Shield Entity"]
  node_shield_packet["Shield Action"]
  node_javelin["Javelin Projectile"]
end

subgraph group_client["Client Presentation"]
  node_dye["Armor Dye<br/>[DyeableItem.java]"]
  node_client_events["Client Setup"]
  node_glaive_animation["Glaive Animation"]
end

subgraph group_compat["Integrations"]
  node_script_settings["Script Settings"]
  node_kubejs["KubeJS Support"]
  node_emi["EMI Recipes"]
  node_jei["JEI Recipes"]
  node_patchouli["Patchouli Support"]
end

node_player(("Player"))

node_mod -->|"registers"| node_blocks
node_mod -->|"registers"| node_items
node_mod -->|"registers"| node_recipe_types
node_mod -->|"registers"| node_script_settings
node_player -.->|"uses"| node_items
node_player -.->|"uses"| node_table
node_blocks -.->|"provides block entity"| node_table
node_table -->|"matches"| node_recipe
node_table -->|"sends progress"| node_progress_packet
node_recipe_types -->|"defines type"| node_recipe
node_recipe -->|"uses serializer"| node_serializer
node_casting_menu -.->|"accesses inventory"| node_table
node_casting_screen -.->|"presents menu"| node_casting_menu
node_items -.->|"registers weapons"| node_weapon_families
node_combat_events -->|"references"| node_shield_entity
node_player -->|"requests action"| node_shield_packet
node_shield_item -.->|"creates entity"| node_shield_entity
node_client_events -->|"reads dye color"| node_dye
node_glaive_animation -.->|"animates glaive"| node_weapon_families
node_kubejs -.->|"exposes settings"| node_script_settings
node_kubejs -.->|"supports recipe changes"| node_recipe
node_emi -->|"displays recipes"| node_recipe
node_jei -->|"reads recipes"| node_recipe

click node_mod "https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/ChineseweaponsMod.java"
click node_blocks "https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/init/ChineseweaponsModBlocks.java"
click node_items "https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/init/ChineseweaponsModItems.java"
click node_table "https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/block/ArmorCastingTableBlockEntity.java"
click node_casting_menu "https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/gui/recipe/WeaponsCastingTableTypeGuiMenu.java"
click node_casting_screen "https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/gui/recipe/WeaponsCastingTableScreen.java"
click node_recipe "https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/recipes/WCTRecipe.java"
click node_recipe_types "https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/recipes/DeferredRecipe.java"
click node_serializer "https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/recipes/WCTRecipeSer.java"
click node_progress_packet "https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/network/ArmorCastingTableBlockProgressPacket.java"
click node_weapon_families "https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/item/StoneglaiveItem.java"
click node_special_weapon "https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/item/GuDuoItem.java"
click node_combat_events "https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/event/ChineseWeaponsCombatEvents.java"
click node_shield_item "https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/item/SongStandingShield.java"
click node_shield_entity "https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/entity/SongStandingShieldEntity.java"
click node_shield_packet "https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/network/ShieldActionPacket.java"
click node_javelin "https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/entity/SongJavelinProjectile.java"
click node_dye "https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/procedures/armor/DyeableItem.java"
click node_client_events "https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/client/ChineseWeaponsClientEvents.java"
click node_glaive_animation "https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/client/GlaiveSpinAnimationHandler.java"
click node_script_settings "https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/compat/WeaponScriptSettings.java"
click node_kubejs "https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/compat/kubejs/ChineseWeaponsKubeJSPlugin.java"
click node_emi "https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/compat/emi/ChineseWeaponsEmiPlugin.java"
click node_jei "https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/jei/WeaponsCastingTableRecipeJei.java"
click node_patchouli "https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/patchouli/PatchouliCompat.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_mod,node_blocks,node_items toneBlue
class node_table,node_casting_menu,node_casting_screen,node_recipe,node_recipe_types,node_serializer,node_progress_packet toneAmber
class node_weapon_families,node_special_weapon,node_combat_events,node_shield_item,node_shield_entity,node_shield_packet,node_javelin toneMint
class node_dye,node_client_events,node_glaive_animation toneRose
class node_script_settings,node_kubejs,node_emi,node_jei,node_patchouli,node_player toneIndigo
```

## Components

### Mod Registration

- [Mod Bootstrap](https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/ChineseweaponsMod.java): `src/main/java/net/mirrorloong/chineseweapons/ChineseweaponsMod.java`
- [Blocks](https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/init/ChineseweaponsModBlocks.java): `src/main/java/net/mirrorloong/chineseweapons/init/ChineseweaponsModBlocks.java`
- [Weapons & Armor](https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/init/ChineseweaponsModItems.java): `src/main/java/net/mirrorloong/chineseweapons/init/ChineseweaponsModItems.java`

### Weapon Casting

- [Casting Table](https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/block/ArmorCastingTableBlockEntity.java): `src/main/java/net/mirrorloong/chineseweapons/block/ArmorCastingTableBlockEntity.java`
- [Casting Menu](https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/gui/recipe/WeaponsCastingTableTypeGuiMenu.java): `src/main/java/net/mirrorloong/chineseweapons/gui/recipe/WeaponsCastingTableTypeGuiMenu.java`
- [Casting Screen](https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/gui/recipe/WeaponsCastingTableScreen.java): `src/main/java/net/mirrorloong/chineseweapons/gui/recipe/WeaponsCastingTableScreen.java`
- [Casting Recipe](https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/recipes/WCTRecipe.java): `src/main/java/net/mirrorloong/chineseweapons/recipes/WCTRecipe.java`
- [Recipe Registration](https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/recipes/DeferredRecipe.java): `src/main/java/net/mirrorloong/chineseweapons/recipes/DeferredRecipe.java`
- [Recipe Serializer](https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/recipes/WCTRecipeSer.java): `src/main/java/net/mirrorloong/chineseweapons/recipes/WCTRecipeSer.java`
- [Progress Sync](https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/network/ArmorCastingTableBlockProgressPacket.java): `src/main/java/net/mirrorloong/chineseweapons/network/ArmorCastingTableBlockProgressPacket.java`

### Combat Content

- [Weapon Behavior](https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/item/StoneglaiveItem.java): `src/main/java/net/mirrorloong/chineseweapons/item/StoneglaiveItem.java`
- [Gu Duo Weapon](https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/item/GuDuoItem.java): `src/main/java/net/mirrorloong/chineseweapons/item/GuDuoItem.java`
- [Combat Events](https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/event/ChineseWeaponsCombatEvents.java): `src/main/java/net/mirrorloong/chineseweapons/event/ChineseWeaponsCombatEvents.java`
- [Standing Shield](https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/item/SongStandingShield.java): `src/main/java/net/mirrorloong/chineseweapons/item/SongStandingShield.java`
- [Shield Entity](https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/entity/SongStandingShieldEntity.java): `src/main/java/net/mirrorloong/chineseweapons/entity/SongStandingShieldEntity.java`
- [Shield Action](https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/network/ShieldActionPacket.java): `src/main/java/net/mirrorloong/chineseweapons/network/ShieldActionPacket.java`
- [Javelin Projectile](https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/entity/SongJavelinProjectile.java): `src/main/java/net/mirrorloong/chineseweapons/entity/SongJavelinProjectile.java`

### Client Presentation

- [Armor Dye](https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/procedures/armor/DyeableItem.java): `src/main/java/net/mirrorloong/chineseweapons/procedures/armor/DyeableItem.java`
- [Client Setup](https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/client/ChineseWeaponsClientEvents.java): `src/main/java/net/mirrorloong/chineseweapons/client/ChineseWeaponsClientEvents.java`
- [Glaive Animation](https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/client/GlaiveSpinAnimationHandler.java): `src/main/java/net/mirrorloong/chineseweapons/client/GlaiveSpinAnimationHandler.java`

### Integrations

- [Script Settings](https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/compat/WeaponScriptSettings.java): `src/main/java/net/mirrorloong/chineseweapons/compat/WeaponScriptSettings.java`
- [KubeJS Support](https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/compat/kubejs/ChineseWeaponsKubeJSPlugin.java): `src/main/java/net/mirrorloong/chineseweapons/compat/kubejs/ChineseWeaponsKubeJSPlugin.java`
- [EMI Recipes](https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/compat/emi/ChineseWeaponsEmiPlugin.java): `src/main/java/net/mirrorloong/chineseweapons/compat/emi/ChineseWeaponsEmiPlugin.java`
- [JEI Recipes](https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/jei/WeaponsCastingTableRecipeJei.java): `src/main/java/net/mirrorloong/chineseweapons/jei/WeaponsCastingTableRecipeJei.java`
- [Patchouli Support](https://github.com/ctnstudio/chineseweapons/blob/main/src/main/java/net/mirrorloong/chineseweapons/patchouli/PatchouliCompat.java): `src/main/java/net/mirrorloong/chineseweapons/patchouli/PatchouliCompat.java`

### Other components

- **Player**

## Connections

- Mod Bootstrap → Blocks: registers (evidence: `src/main/java/net/mirrorloong/chineseweapons/ChineseweaponsMod.java`)
- Mod Bootstrap → Weapons & Armor: registers (evidence: `src/main/java/net/mirrorloong/chineseweapons/ChineseweaponsMod.java`)
- Mod Bootstrap → Recipe Registration: registers (evidence: `src/main/java/net/mirrorloong/chineseweapons/ChineseweaponsMod.java`)
- Mod Bootstrap → Script Settings: registers (evidence: `src/main/java/net/mirrorloong/chineseweapons/ChineseweaponsMod.java`)
- Player → Weapons & Armor: uses
- Player → Casting Table: uses
- Blocks → Casting Table: provides block entity
- Casting Table → Casting Recipe: matches (evidence: `src/main/java/net/mirrorloong/chineseweapons/block/ArmorCastingTableBlockEntity.java`)
- Casting Table → Progress Sync: sends progress (evidence: `src/main/java/net/mirrorloong/chineseweapons/block/ArmorCastingTableBlockEntity.java`)
- Recipe Registration → Casting Recipe: defines type (evidence: `src/main/java/net/mirrorloong/chineseweapons/recipes/WCTRecipe.java`)
- Casting Recipe → Recipe Serializer: uses serializer (evidence: `src/main/java/net/mirrorloong/chineseweapons/recipes/WCTRecipe.java`)
- Casting Menu → Casting Table: accesses inventory
- Casting Screen → Casting Menu: presents menu
- Weapons & Armor → Weapon Behavior: registers weapons (evidence: `src/main/java/net/mirrorloong/chineseweapons/init/ChineseweaponsModItems.java`)
- Combat Events → Shield Entity: references (evidence: `src/main/java/net/mirrorloong/chineseweapons/event/ChineseWeaponsCombatEvents.java`)
- Player → Shield Action: requests action
- Standing Shield → Shield Entity: creates entity
- Client Setup → Armor Dye: reads dye color (evidence: `src/main/java/net/mirrorloong/chineseweapons/client/ChineseWeaponsClientEvents.java`)
- Glaive Animation → Weapon Behavior: animates glaive
- KubeJS Support → Script Settings: exposes settings
- KubeJS Support → Casting Recipe: supports recipe changes (evidence: `README.md`)
- EMI Recipes → Casting Recipe: displays recipes
- JEI Recipes → Casting Recipe: reads recipes (evidence: `src/main/java/net/mirrorloong/chineseweapons/jei/WeaponsCastingTableRecipeJei.java`)
