✦ SimpleHomes ✦ 1.21.x

✦ SimpleHomes ✦
Professional Home Management System

⚡ Interactive GUI • Home Sharing • Economy Integration • Safe Teleportation

Overview

SimpleHomes is a feature-rich, professional home management plugin that transforms the traditional homes experience. With an intuitive GUI system, advanced sharing capabilities, and seamless economy integration, it provides everything your server needs for modern home management.

✨ Why Choose SimpleHomes?
• Modern interactive GUI interface
• Advanced home sharing system
• Individual player preferences
• Safe teleportation with validation
• Comprehensive economy support
• Professional bed spawn integration
• Extensive permission system

Core Features

Home Management

• Multiple homes with custom names
• Smart icons based on home names (farm, mine, base, etc.)
• Permission-based limits (1-100 homes or unlimited)
• Bed spawn integration - `/home` uses your bed location
• Safe location validation - Prevents unsafe teleportations
• World support - Cross-dimensional homes

️ Interactive GUI System

• Visual home browser with smart categorization
• One-click teleportation from GUI
• Home management interface with edit/delete/share options
• Public homes explorer to browse community homes
• Settings panel for personal preferences
• Pagination system for large home collections

Social Features

• Share homes with specific players
• Public homes system for community sharing
• Player notifications when homes are shared
• Access management - easily revoke permissions
• Home descriptions for public homes
• Visual player heads in sharing interface

Economy Integration

• Vault support for seamless economy integration
• Configurable costs for setting homes and teleporting
• Balance validation before transactions
• Automatic refunds on failed teleportations

⚡ Safe Teleportation

• Warmup timers to prevent combat abuse
• Cooldown periods between teleportations
• Movement cancellation during warmup
• Damage cancellation options
• Location safety validation - no lava or void teleports
• Permission-based bypasses for staff

⚙️ Commands & Permissions

Commands

/sethome [name]          - Set a home at your location
/home [name]             - Teleport to your bed or named home
/delhome <n>           - Delete a specific home
/homes                   - List all your homes (text)
/homesgui                - Open the interactive GUI
/sharehome <home> <player> - Share a home with another player
/unsharehome <home> <player> - Remove sharing access

Permission Nodes

simplehomes.*            - All permissions (admin)
simplehomes.sethome      - Set homes (default: true)
simplehomes.home         - Teleport to homes (default: true)
simplehomes.delhome      - Delete homes (default: true)
simplehomes.homes        - List homes (default: true)
simplehomes.gui          - Access GUI system (default: true)
simplehomes.share        - Share homes with others (default: true)
simplehomes.unshare      - Remove sharing access (default: true)

simplehomes.unlimited    - Unlimited homes (default: op)
simplehomes.instant      - No warmup time (default: op)
simplehomes.nocooldown   - No cooldown (default: op)

# Home Limits
simplehomes.homes.5      - Allow 5 homes
simplehomes.homes.10     - Allow 10 homes
simplehomes.homes.20     - Allow 20 homes
simplehomes.homes.50     - Allow 50 homes

# Warmup Times
simplehomes.warmup.0     - No warmup
simplehomes.warmup.1     - 1 second warmup
simplehomes.warmup.5     - 5 second warmup

# Cooldown Times
simplehomes.cooldown.10  - 10 second cooldown
simplehomes.cooldown.30  - 30 second cooldown
simplehomes.cooldown.60  - 60 second cooldown

Configuration

SimpleHomes offers extensive configuration options for every aspect of the plugin:

️ Database Support

• SQLite (default) - Perfect for small to medium servers
• MySQL - High-performance option for large networks
• Connection pooling with HikariCP for optimal performance

⚙️ Teleportation Settings

• Configurable warmup and cooldown times
• Movement threshold sensitivity
• Damage cancellation options
• Sound and particle effects
• Safe teleportation validation

Message Customization

• Full message customization with color codes
• Professional prefix with Unicode symbols
• Placeholder support for dynamic content
• Multi-language ready structure

# Database Configuration
database:
  type: 'sqlite'  # or 'mysql'
 
# Home System
homes:
  default-limit: 3
  max-name-length: 16
  allow-overwrite: true

# Teleportation
teleport:
  warmup-time: 3
  cooldown-time: 30
  cancel-on-damage: true
  sound-effects: true

# Economy (requires Vault)
economy:
  sethome-cost: 100.0
  teleport-cost: 50.0
 
# GUI System
gui:
  enabled: true
  auto-open-on-homes: false
  items-per-page: 28

Integration & Compatibility

Plugin Integrations

• PlaceholderAPI - Extensive placeholder support
• Vault - Economy integration
• Permission plugins - Full LuckPerms/GroupManager support

PlaceholderAPI Placeholders

%simplehomes_homes_count%        - Number of homes player has
%simplehomes_homes_max%          - Maximum homes allowed
%simplehomes_homes_remaining%    - Remaining home slots
%simplehomes_homes_list%         - Comma-separated list of homes
%simplehomes_has_home_<name>%    - Check if specific home exists
%simplehomes_sethome_cost%       - Cost to set a home
%simplehomes_teleport_cost%      - Cost to teleport
%simplehomes_balance%            - Player's current balance
%simplehomes_has_bed%            - Player has valid bed spawn
%simplehomes_bed_world%          - Bed spawn world name
%simplehomes_bed_location%       - Bed spawn coordinates

️ Server Compatibility

• Spigot 1.21+ (recommended)
• Java 17+ required

Installation

Quick Setup (2 minutes)

1. Download & Install

• Download SimpleHomes.jar from the resources section
• Place in your server's `/plugins/` folder
• Restart your server

2. Optional Dependencies

• Install Vault for economy features
• Install PlaceholderAPI for placeholder support
• Restart server after adding dependencies

3. Configuration

• Edit `/plugins/SimpleHomes/config.yml` to your preferences
• Set up permissions with your permission plugin
• Use `/simplehomes reload` to apply changes

That's it! Your players can now use `/homesgui` to get started.