@c3d.gg/mwi-types 0.0.2 → 0.0.5

package/README.md

@@ -1,13 +1,13 @@
-# @c3d/mwi-types
+# @c3d.gg/mwi-types
 
 TypeScript type definitions, schemas, and constants for Milky Way Idle game data.
 
 ## Overview
 
-`@c3d/mwi-types` provides comprehensive TypeScript types for the Milky Way Idle game, including:
+`@c3d.gg/mwi-types` provides comprehensive TypeScript types for the Milky Way Idle game, including:
 
 - 🎯 **Complete type definitions** for all game entities
-- ✅ **Runtime validation** with both Zod and Typebox schemas  
+- ✅ **Runtime validation** with both Zod and Typebox schemas
 - 🔤 **HRID constants** for all entity identifiers
 - 🌍 **Type-safe translations** for supported locales
 - 📦 **Tree-shakeable exports** for optimal bundle size
@@ -15,13 +15,13 @@ TypeScript type definitions, schemas, and constants for Milky Way Idle game data
 ## Installation
 
 ```bash
-npm install @c3d/mwi-types
+npm install @c3d.gg/mwi-types
 # or
-yarn add @c3d/mwi-types
+yarn add @c3d.gg/mwi-types
 # or
-pnpm add @c3d/mwi-types
+pnpm add @c3d.gg/mwi-types
 # or
-bun add @c3d/mwi-types
+bun add @c3d.gg/mwi-types
 ```
 
 ## Usage
@@ -29,7 +29,7 @@ bun add @c3d/mwi-types
 ### Basic Types
 
 ```typescript
-import { Item, Skill, Action, Recipe } from '@c3d/mwi-types';
+import { Item, Skill, Action, Recipe } from '@c3d.gg/mwi-types'
 
 // Type-safe game entities
 const milk: Item = {
@@ -37,7 +37,7 @@ const milk: Item = {
   name: 'Milk',
   categoryHrid: '/item_categories/product',
   // ... other properties
-};
+}
 ```
 
 ### Import Paths
@@ -46,81 +46,85 @@ The package provides multiple entry points for better tree-shaking:
 
 ```typescript
 // Main entry - all types
-import { Item, Skill, getItem } from '@c3d/mwi-types';
+import { Item, Skill, getItem } from '@c3d.gg/mwi-types'
 
 // Game logic only
-import { ITEMS, SKILLS, getItemsByCategory } from '@c3d/mwi-types/game-logic';
+import { ITEMS, SKILLS, getItemsByCategory } from '@c3d.gg/mwi-types/game-logic'
 
 // Constants/HRIDs only
-import { ItemHrid, SkillHrid, ITEM_HRIDS } from '@c3d/mwi-types/constants';
+import { ItemHrid, SkillHrid, ITEM_HRIDS } from '@c3d.gg/mwi-types/constants'
 
 // Schemas only
-import { ItemSchema } from '@c3d/mwi-types/zod';
-import { ItemSchema as ItemTypeboxSchema } from '@c3d/mwi-types/typebox';
+import { ItemSchema } from '@c3d.gg/mwi-types/zod'
+import { ItemSchema as ItemTypeboxSchema } from '@c3d.gg/mwi-types/typebox'
 
 // Player data types
-import { PlayerData, Character } from '@c3d/mwi-types/player-data';
+import { PlayerData, Character } from '@c3d.gg/mwi-types/player-data'
 
 // Localization
-import { getTranslatedItem } from '@c3d/mwi-types/localization';
+import { getTranslatedItem } from '@c3d.gg/mwi-types/localization'
 ```
 
 ### Schema Validation
 
 ```typescript
 // Zod schemas
-import { ItemSchema, SkillSchema } from '@c3d/mwi-types/zod';
+import { ItemSchema, SkillSchema } from '@c3d.gg/mwi-types/zod'
 
-const validItem = ItemSchema.parse(unknownData);
-const isValid = SkillSchema.safeParse(data).success;
+const validItem = ItemSchema.parse(unknownData)
+const isValid = SkillSchema.safeParse(data).success
 
-// Typebox schemas  
-import { ItemSchema, SkillSchema } from '@c3d/mwi-types/typebox';
-import { Value } from '@sinclair/typebox/value';
+// Typebox schemas
+import { ItemSchema, SkillSchema } from '@c3d.gg/mwi-types/typebox'
+import { Value } from '@sinclair/typebox/value'
 
-const isValid = Value.Check(ItemSchema, data);
+const isValid = Value.Check(ItemSchema, data)
 ```
 
 ### HRID Constants
 
 ```typescript
-import { ITEM_HRIDS, SKILL_HRIDS, SkillHrid } from '@c3d/mwi-types/constants';
+import { ITEM_HRIDS, SKILL_HRIDS, SkillHrid } from '@c3d.gg/mwi-types/constants'
 
 // Use as enums
-const selectedSkill: SkillHrid = SKILL_HRIDS.ALCHEMY;
+const selectedSkill: SkillHrid = SKILL_HRIDS.ALCHEMY
 
 // Or iterate all values
-ITEM_HRIDS.forEach(hrid => {
-  console.log(`Processing item: ${hrid}`);
-});
+ITEM_HRIDS.forEach((hrid) => {
+  console.log(`Processing item: ${hrid}`)
+})
 ```
 
 ### Utility Functions
 
 ```typescript
-import { 
-  getItemByHrid, 
+import {
+  getItemByHrid,
   getSkillByHrid,
   filterItemsByCategory,
-  filterActionsBySkill 
-} from '@c3d/mwi-types';
+  filterActionsBySkill,
+} from '@c3d.gg/mwi-types'
 
-const milk = getItemByHrid('/items/milk');
-const cookingActions = filterActionsBySkill('/skills/cooking');
+const milk = getItemByHrid('/items/milk')
+const cookingActions = filterActionsBySkill('/skills/cooking')
 ```
 
 ### Type-Safe Translations
 
 ```typescript
-import { ItemTranslations, SkillTranslations } from '@c3d/mwi-types/localization/en';
+import {
+  ItemTranslations,
+  SkillTranslations,
+} from '@c3d.gg/mwi-types/localization/en'
 
-const milkName = ItemTranslations['/items/milk'].name;
-const alchemyDesc = SkillTranslations['/skills/alchemy'].description;
+const milkName = ItemTranslations['/items/milk'].name
+const alchemyDesc = SkillTranslations['/skills/alchemy'].description
 ```
 
 ## Available Types
 
 ### Core Game Logic
+
 - **Skills** - All game skills with experience and level requirements
 - **Items** - Resources, equipment, consumables with full property data
 - **Actions** - Skill-specific actions with requirements and outputs
@@ -129,12 +133,14 @@ const alchemyDesc = SkillTranslations['/skills/alchemy'].description;
 - **Abilities** - Combat abilities with damage calculations
 
 ### Combat System
+
 - **Combat Monsters** - NPCs with stats, abilities, and loot tables
 - **Combat Styles** - Attack styles and combat mechanics
 - **Damage Types** - Elemental and physical damage categories
 - **Buffs** - Status effects and stat modifiers
 
 ### Game Features
+
 - **House Rooms** - Player housing upgrades and bonuses
 - **Shops** - Shop categories and purchasable items
 - **Tasks** - Daily/random tasks and rewards
@@ -142,12 +148,14 @@ const alchemyDesc = SkillTranslations['/skills/alchemy'].description;
 - **Quests** - Quest chains and progression
 
 ### Social & UI
+
 - **Chat** - Icons, colors, and channel types
 - **Avatars** - Character customization options
 - **Guild Roles** - Permissions and hierarchy
 - **Leaderboards** - Ranking categories and scoring
 
 ### Player Data
+
 - **Character** - Full character state and progression
 - **Inventory** - Item storage and equipment loadouts
 - **Skills Progress** - Experience and level tracking
@@ -189,4 +197,4 @@ MIT © C3D
 
 ## Changelog
 
-See [CHANGELOG.md](./CHANGELOG.md) for version history and breaking changes.
+See [CHANGELOG.md](./CHANGELOG.md) for version history and breaking changes.