Skip to content

FrozedClubDevelopment/FrozedNpcGenerator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

60 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Frozed NPC Generator

NPC Generator plugin for Players as seen on DiosesMC.

https://builtbybit.com/resources/frozednpcgenerator-player-owned-npcs.103602/

Features

Core Features

  • Player-owned NPCs: Players can spawn and manage their own NPCs
  • Region Protection: Integrates with WorldGuard and ProtectionStones to prevent unauthorized NPC placement
  • Packet-based NPCs: Uses PacketEvents for lightweight NPC handling
  • Multiple Database Support: Choose between FlatFile, MongoDB, or MySQL for data persistence
  • Fully Configurable: All messages, menus, and items are customizable

NPC Management

Players can customize their NPCs with the following features:

  • Poses: Standing, Sitting, Crouching, Swimming or Sleeping
  • Custom Messages: Create multiple messages that display when interacting with the NPC
  • Custom Skin: Apply player skins to NPCs
  • Custom Name: Set a display name for the NPC
  • Hand Animation: Toggle hand movement (on interaction or automatic with 1~3 second intervals)
  • Chunk Loading: Force-load chunks around the NPC (configurable radius in config file)

Commands

  • /npcgenerator give <player> <amount> - Give NPC generator items to a player (Permission: npcgenerator.admin)
  • /npcgenerator reload - Reload the plugin configuration (Permission: npcgenerator.admin)

Aliases: /npcgen

Permissions

  • npcgenerator.admin - Access to admin commands (default: op)
  • npcgenerator.use - Allows players to use NPC generator items (default: true)

Usage

Creating an NPC

  1. Obtain an NPC Generator item using /npcgenerator give <player> <amount>
  2. Right-click on a block to spawn an NPC (must be in a region you own)
  3. Shift + Right-click the NPC to open the editor menu

NPC Editor Menu

The editor menu provides the following options:

  • Change Pose: Left-click for the next pose, right-click for the previous pose
  • Edit Messages: Open the messages menu to add/remove interaction messages
  • Change Skin: Enter a player name to use their skin
  • Change Name: Set a custom display name
  • Toggle Hand Movement: Enable/disable hand animation and switch between interaction-based or automatic
  • Toggle Chunk Loading: Keep chunks loaded around the NPC
  • Toggle Shop: Enable/disable shop mode for this NPC (requires permission)
  • Edit Shop: Manage shop items, prices, and stock (when shop is enabled)
  • Remove NPC: Permanently delete the NPC

Shop Features

When shop mode is enabled:

  • For NPC Owners:

    • Add items by clicking empty slots with an item in your cursor
    • After placing an item, you will be prompted in chat to enter its price and quantity/stock
    • Remove items by shift-clicking them
    • Shop size based on your permissions (9-54 slots)
  • For Buyers:

    • Right-click the NPC to browse the shop
    • View prices and available stock
    • Left-click to purchase items (requires Vault + economy plugin)
    • Out-of-stock items are clearly marked

Dependencies

Required

  • PacketEvents (2.12.0) - For packet handling
  • Paper/Spigot (1.21.11+) - Server software
  • WorldGuard (7.0.9+) or ProtectionStones (2.10.1+) - For region protection detection

Optional (Database)

The plugin supports three database types (choose one):

  • FlatFile (Default) - No setup required, stores data in JSON files
  • MongoDB - For better performance with large datasets
  • MySQL - Traditional SQL database support

Technical Details

  • Asynchronous Database Operations: All database operations run asynchronously to prevent server lag
  • Flexible Storage: Choose between FlatFile (JSON), MongoDB, or MySQL based on your needs
  • NMS Packet-based NPCs: NPCs are created and managed using Packet Events, ensuring minimal performance impact
  • Chunk Loading: NPCs can force-load chunks around them to stay active
  • Ownership Validation: Players can only edit NPCs they own (admins can edit any NPC)
  • Menu API Integration: Uses custom Menu API for GUI interactions

PlaceholderAPI Support

The plugin fully supports PlaceholderAPI for dynamic content in NPC names and messages.

Plugin Placeholders

This plugin provides the following PlaceholderAPI placeholders:

  • %frozed-npc-generator_npcs% - Total number of NPCs the player owns (self-parsed placeholder)
  • %frozed-npc-generator_max% - Maximum NPCs the player can have (-1 shows as ∞)
  • %frozed-npc-generator_remaining% - Remaining NPC slots available

Support

For issues, feature requests, or contributions, please visit the project repository or contact the developers at https://frozed.club

Authors

  • Elb1to

License

Copyright © 2026 Frozed Club. All rights reserved.

About

NPC Generator plugin for Players as seen on DiosesMC!

Topics

Resources

License

Stars

Watchers

Forks

Contributors

Languages