Features
Research Tree
Category-based tech tree unlocked by killing mobs. Each animal requires a catalyst (fed with configurable resource items) and a fuel item for the final activation roll.
Passive Economy
Placed zoo animals generate revenue over time. Biome affinities, habitat blocks, and happiness affect income. Offline catch-up on reconnect.
Adventure Map
Explore cloned temporary dimensions via a 9x6 chunk grid. Teleport to chunks to find rare animals. Navigation with scrollable grid camera.
Mounts
Ride owned animals with ZQSD controls via PacketEvents STEER_VEHICLE interception. Fatigue gauge drains over time, recharges outside adventure dimensions.
Fusion & Breeding
Combine two animals of the same species (min level required) to create an egg. After incubation, the offspring inherits averaged parent levels with mutation chances.
Prestige
Reset a max-level animal to level 1 for a permanent +10% revenue bonus. Stacks per prestige count. Unlocks exclusive skins and particles.
Delivery Shop
Rotating NPC merchant with configurable schedule and weighted item pool. FOMO mechanics — inventory changes each rotation.
Expeditions
Send animals on timed idle missions. Returns with resources, XP, catalyst items, or rare bonus animals.
Animal Levels & XP
Each animal has its own level, XP curve, and max level. Gain XP via mount usage, expeditions, and zoo placement time.
Personalization
Rename animals, apply skin variants (ref-based EntityDefinitions), equip accessories (hat, collar, saddle).
Happiness System
Animals have 0-100 happiness affecting revenue. Boosted by matching biomes, habitat blocks, and feeding. Penalized by overcrowding.
Fully Configurable GUIs
All menus driven by a single
tycoon_configuration entry. Customize titles, items, slot positions, panel layouts, scroll/pagination buttons per GUI.Architecture
Entries
Definitions
Animal Definition: Species config (rarity, catalyst items, fuel, economy, fusion, mount stats, model variants).
Research Category: Tech tree folder with mob kill requirements and animal list.
Adventure Map: Dimension template, chunk grid, spawn zone, mount selector.
Delivery Shop: Rotating merchant schedule, weighted item pool, NPC definition.
Research Category: Tech tree folder with mob kill requirements and animal list.
Adventure Map: Dimension template, chunk grid, spawn zone, mount selector.
Delivery Shop: Rotating merchant schedule, weighted item pool, NPC definition.
Actions
Catalyst Feed: Donate items to build research power.
Catalyst Activate: Use fuel item to attempt animal research.
Category Unlock: Unlock category when mob kill threshold met.
Revenue Collect: Collect accumulated zoo income.
Animal XP: Grant experience to owned animals.
Fusion: Breed two animals into an egg with incubation.
Prestige: Reset max-level animal for permanent revenue bonus.
Expedition Start: Send animal on timed idle mission.
Customize Animal: Rename, apply skins, equip accessories.
Catalyst Activate: Use fuel item to attempt animal research.
Category Unlock: Unlock category when mob kill threshold met.
Revenue Collect: Collect accumulated zoo income.
Animal XP: Grant experience to owned animals.
Fusion: Breed two animals into an egg with incubation.
Prestige: Reset max-level animal for permanent revenue bonus.
Expedition Start: Send animal on timed idle mission.
Customize Animal: Rename, apply skins, equip accessories.
Facts
Tycoon Limit: Max owned animals per type.
Tycoon Visible: Adventure map visibility gating.
Mount Fatigue: Current mount stamina tracking.
Tycoon Visible: Adventure map visibility gating.
Mount Fatigue: Current mount stamina tracking.
GUI Configs
Research Tree GUI: Split-panel config (categories + animals).
Adventure Map GUI: Chunk grid, nav, mount selector.
Zoo GUI: Tabbed menu (bestiary, zoo, expeditions, mounts, prestige).
Delivery Shop GUI: Rotating shop inventory layout.
Adventure Map GUI: Chunk grid, nav, mount selector.
Zoo GUI: Tabbed menu (bestiary, zoo, expeditions, mounts, prestige).
Delivery Shop GUI: Rotating shop inventory layout.
Artifacts
Tycoon Zoo Artifact: Player profiles (animals, revenue, research, expeditions).
Quick Start
1. Configure Settings
Start with the configuration entry: animal_definition, research_category, adventure_map. This defines global settings for the extension.→ animal_definition → research_category
2. Trigger Actions
Use action entries to interact with the extension: catalyst_feed, catalyst_activate, category_unlock. Trigger them from commands, NPCs, events, or other entries.→ catalyst_feed → catalyst_activate
Commands
Admin
| Command | Description | Permission |
|---|---|---|
/tycoon give <player> <animalId> | Give an animal to a player | tycoon.admin.give |
/tycoon remove <player> <animalId> | Remove an animal | tycoon.admin.remove |
/tycoon setlevel <player> <animalId> <level> | Set animal level | tycoon.admin.setlevel |
/tycoon info [player] | Show player tycoon profile | tycoon.admin.info |
/tycoon reload | Force save all profiles | tycoon.admin.reload |
/tycoon spawnshop <shopId> | Force spawn delivery shop | tycoon.admin.spawnshop |
/tycoon resetfatigue [player] | Reset mount fatigue | tycoon.admin.resetfatigue |
/tycoon unlockcategory <player> <catId> | Unlock a research category | tycoon.admin.unlockcategory |
Player
| Command | Description | Permission |
|---|---|---|
/zoo | Open the main zoo menu (bestiary, research, placements) | tycoon.player.zoo |
/zoo visit <player> | Teleport to another player’s zoo | tycoon.player.visit |
/adventure | Open the adventure map GUI | tycoon.player.adventure |
/mounts | Open the mount selection menu | tycoon.player.mounts |
/collect | Manually collect accumulated revenue | tycoon.player.collect |
Placeholders
Prefix:%typewriter_tycoon_*%
Global Stats
| Placeholder | Description |
|---|---|
%typewriter_tycoon_total_animals% | Total owned animals |
%typewriter_tycoon_placed_animals% | Currently placed in zoo |
%typewriter_tycoon_unplaced_animals% | Owned but not placed |
%typewriter_tycoon_total_revenue% | Lifetime revenue (formatted) |
%typewriter_tycoon_total_revenue_raw% | Lifetime revenue (raw number) |
%typewriter_tycoon_categories_unlocked% | Unlocked research categories |
%typewriter_tycoon_categories_total% | Total research categories |
%typewriter_tycoon_categories_locked% | Locked research categories |
%typewriter_tycoon_milestones_count% | Collection milestones completed |
%typewriter_tycoon_prestige_bonuses_count% | Active prestige bonuses |
%typewriter_tycoon_expeditions_active% | Active expeditions |
%typewriter_tycoon_zoo_visitors% | Total zoo visitors |
%typewriter_tycoon_active_mount_id% | Currently selected mount ID |
%typewriter_tycoon_last_revenue_collect% | Last revenue collect timestamp |
Category-Specific
| Placeholder | Description |
|---|---|
%typewriter_tycoon_category_<id>_unlocked% | Whether category is unlocked |
%typewriter_tycoon_category_<id>_mobs_killed% | Mobs killed toward unlock |
%typewriter_tycoon_category_<id>_required_kills% | Required kills to unlock |
%typewriter_tycoon_category_<id>_progress_percent% | Unlock progress percentage |
%typewriter_tycoon_category_<id>_name% | Category display name |
Animal-Specific
| Placeholder | Description |
|---|---|
%typewriter_tycoon_animal_<id>_level% | Animal level |
%typewriter_tycoon_animal_<id>_owned% | Owns animal (true/false) |
%typewriter_tycoon_animal_<id>_prestige% | Prestige count |
%typewriter_tycoon_animal_<id>_xp% | Current XP |
%typewriter_tycoon_animal_<id>_rarity% | Rarity name |
%typewriter_tycoon_animal_<id>_rarity_color% | Rarity hex color |
%typewriter_tycoon_animal_<id>_placed% | Placed in zoo (true/false) |
%typewriter_tycoon_animal_<id>_custom_name% | Custom name |
%typewriter_tycoon_animal_<id>_is_mountable% | Mountable (true/false) |
%typewriter_tycoon_animal_<id>_mount_speed% | Mount speed multiplier |
%typewriter_tycoon_animal_<id>_fatigue_capacity% | Fatigue capacity (seconds) |
%typewriter_tycoon_animal_<id>_max_level% | Maximum level |
%typewriter_tycoon_animal_<id>_revenue_rate% | Base revenue rate |
%typewriter_tycoon_animal_<id>_fusion_level% | Minimum fusion level |
%typewriter_tycoon_animal_<id>_display_name% | Display name |
%typewriter_tycoon_animal_<id>_catalyst_progress% | Catalyst fill percentage |
%typewriter_tycoon_animal_<id>_catalyst_power% | Catalyst current power |
%typewriter_tycoon_animal_<id>_catalyst_items% | Donated item types count |
Placed Animal Info
| Placeholder | Description |
|---|---|
%typewriter_tycoon_placed_<id>_happiness% | Happiness level |
%typewriter_tycoon_placed_<id>_biome% | Current biome |
%typewriter_tycoon_placed_<id>_world% | World name |
%typewriter_tycoon_placed_<id>_coords% | Coordinates (x, y, z) |
%typewriter_tycoon_placed_<id>_chunk% | Chunk (x, z) |
Prestige & Expeditions
| Placeholder | Description |
|---|---|
%typewriter_tycoon_prestige_<id>% | Prestige bonus percentage |
%typewriter_tycoon_expedition_count% | Total expedition count |
%typewriter_tycoon_expedition_<n>_animal% | Animal ID in expedition slot N |
%typewriter_tycoon_expedition_<n>_remaining_seconds% | Seconds until return |
%typewriter_tycoon_expedition_<n>_remaining_minutes% | Minutes until return |
%typewriter_tycoon_expedition_<n>_duration_hours% | Total duration in hours |
%typewriter_tycoon_expedition_<n>_ready% | Ready to collect (true/false) |
Dependencies
| Extension | Required | Purpose |
|---|---|---|
| EntityExtension | Yes | Entity definitions for animal models |
| Typewriter-GUIExtension | Yes | GUI rendering (configurable menus) |
| TypeWriter-VehicleExtension | No | Mount system (optional, PacketEvents-based) |
| TypeWriter-RPGCOREExtension | No | Profession level gating for capture limits |
| TypeWriter-TemporaryDimensionExtension | No | Adventure dimension cloning |
| TypeWriter-ShopsExtension | No | Economy abstractions (Vault/Points/Placeholder) |