Skip to main content

Configuration

Guide to configuring HyperFactions for your server.

Configuration

HyperFactions is highly configurable. This guide explains the key configuration options for getting started.

For Server Owners

This guide covers common configuration scenarios. For a complete reference of all configuration options, see Configuration Reference.

Configuration Files

HyperFactions uses multiple configuration files:

mods/com.hyperfactions_HyperFactions/
├── config.json               ← Main configuration (covered in this guide)
└── config/                   ← Module configurations
    ├── announcements.json    ← Announcement settings
    ├── backup.json           ← Backup system settings
    ├── chat.json             ← Chat formatting
    ├── debug.json            ← Debug logging
    ├── economy.json          ← Economy/treasury settings
    ├── faction-permissions.json  ← Default territory permissions
    ├── gravestones.json      ← Gravestone integration settings
    └── worldmap.json         ← World map display settings

The main config.json covers faction limits, power, claims, combat, relations, and more. Module configs in the config/ subdirectory handle specialized features like economy, chat, map display, and backups.

Applying Changes

After making changes to configuration files, run /f admin reload to apply them without restarting the server.

Tip

See the Configuration Reference for complete documentation of all configuration files.

Essential Settings

These are the most important settings to configure for your server.

Faction Limits

OptionDefaultDescription
faction.maxMembers50Maximum members per faction
faction.maxNameLength24Maximum faction name length
faction.minNameLength3Minimum faction name length
faction.allowColorstrueAllow color codes in names

Power System

The power system is the core of HyperFactions. These settings affect how factions claim and defend territory:

OptionDefaultDescription
power.maxPlayerPower20.0Maximum power per player
power.startingPower10.0Power new players start with
power.powerPerClaim2.0Power required per claim
power.deathPenalty1.0Power lost on death
power.killReward0.0Power gained on kill
power.regenPerMinute0.1Power regenerated per minute
power.regenWhenOfflinefalseRegenerate while offline

Understanding Power

With defaults, players regenerate 6 power per hour (0.1 × 60). A 5-member faction at max power (100) can hold 50 claims (100 ÷ 2).

Territory Claims

OptionDefaultDescription
claims.maxClaims100Hard cap on faction claims
claims.onlyAdjacentfalseRequire connected claims
claims.decayEnabledtrueEnable inactive claim decay
claims.decayDaysInactive30Days before decay starts

Combat Settings

OptionDefaultDescription
combat.tagDurationSeconds15Combat tag duration
combat.allyDamagefalseAllow ally damage
combat.factionDamagefalseAllow faction damage
combat.taggedLogoutPenaltytruePenalize combat logout
combat.logoutPowerLoss1.0Power lost on combat logout

Spawn Protection

OptionDefaultDescription
combat.spawnProtection.enabledtrueEnable spawn protection
combat.spawnProtection.durationSeconds5Protection duration
combat.spawnProtection.breakOnAttacktrueRemove on attack
combat.spawnProtection.breakOnMovetrueRemove on movement

Diplomatic Relations

OptionDefaultDescription
relations.maxAllies10Max ally factions (-1 = unlimited)
relations.maxEnemies-1Max enemy factions (-1 = unlimited)

Server Type Configurations

PvP-Focused Server

High-stakes combat with meaningful consequences:

{
  "power": {
    "maxPlayerPower": 15,
    "startingPower": 10,
    "deathPenalty": 2.0,
    "regenPerMinute": 0.15,
    "powerPerClaim": 1.5
  },
  "combat": {
    "tagDurationSeconds": 20,
    "taggedLogoutPenalty": true,
    "logoutPowerLoss": 2.0
  },
  "relations": {
    "maxAllies": 3,
    "maxEnemies": -1
  }
}

Effects:

  • Lower max power = smaller empires
  • Higher death penalty = wars matter more
  • Faster regen = quicker recovery
  • Limited allies = more conflict

Casual/Building Server

Relaxed settings for creative communities:

{
  "power": {
    "maxPlayerPower": 50,
    "startingPower": 25,
    "deathPenalty": 0,
    "regenPerMinute": 0.05,
    "powerPerClaim": 5
  },
  "combat": {
    "tagDurationSeconds": 0,
    "factionDamage": false,
    "allyDamage": false
  },
  "relations": {
    "maxAllies": -1,
    "maxEnemies": 0
  }
}

Effects:

  • No combat penalties
  • Large territory for builders
  • No PvP consequences
  • Unlimited friends, no enemies

Roleplay Server

Balanced settings encouraging diplomacy:

{
  "power": {
    "maxPlayerPower": 30,
    "startingPower": 15,
    "deathPenalty": 0.5,
    "regenPerMinute": 0.1,
    "powerPerClaim": 3
  },
  "relations": {
    "maxAllies": 5,
    "maxEnemies": 5
  },
  "claims": {
    "onlyAdjacent": true,
    "decayDaysInactive": 14
  }
}

Effects:

  • Moderate power economy
  • Limited diplomacy encourages RP
  • Connected territories required
  • Faster decay removes abandoned areas

Teleportation Settings

Configure faction home teleportation:

OptionDefaultDescription
teleport.warmupSeconds5Warmup before teleport
teleport.cooldownSeconds300Cooldown between uses
teleport.cancelOnMovetrueCancel on movement
teleport.cancelOnDamagetrueCancel on damage

For the /f stuck command:

OptionDefaultDescription
stuck.warmupSeconds30Longer warmup (escape tool)
stuck.cooldownSeconds3005-minute cooldown

Automatic Features

Auto-Save

OptionDefaultDescription
autoSave.enabledtrueEnable auto-save
autoSave.intervalMinutes5Save interval

Update Checking

OptionDefaultDescription
updates.enabledtrueCheck for updates
updates.releaseChannel"stable""stable" or "prerelease"

Permission Behavior

When no permission manager (HyperPerms/LuckPerms) is installed:

OptionDefaultDescription
permissions.adminRequiresOptrueAdmins need OP
permissions.allowWithoutPermissionModfalseAllow commands without a permission mod

Without a Permission Manager

If you don't use HyperPerms or LuckPerms, set allowWithoutPermissionMod to true for basic commands to work, or grant OP to admins. This is not recommended for production servers.

World Filtering

Control which worlds allow faction claims:

{
  "claims": {
    "worldWhitelist": ["default", "dungeon_realm"],
    "worldBlacklist": []
  }
}

Rules:

  1. If worldWhitelist is not empty, only listed worlds allow claims
  2. If empty, worldBlacklist blocks specific worlds
  3. If both empty, all worlds allow claims

Message Customization

OptionDefaultDescription
messages.prefixTextHyperFactionsText shown in message prefix
messages.prefixColor#55FFFFColor of the prefix text
messages.prefixBracketColor#AAAAAAColor of the brackets around prefix
messages.primaryColor#00FFFFPrimary accent color

Economy Settings

If VaultUnlocked is installed, configure the faction treasury:

OptionDefaultDescription
economy.enabledtrueEnable treasury features
economy.startingBalance0.0Starting treasury balance
economy.currencySymbol$Currency symbol for display

See Economy for how the treasury system works.

World Map Settings

Configure the interactive territory map:

OptionDefaultDescription
gui.terrainMapEnabledtrueEnable terrain imagery on the map

Map display options are configured in config/worldmap.json:

OptionDefaultDescription
playerVisibility.enabledfalseEnable relation-based player filtering on the map
showFactionTagstrueShow faction tags on claimed chunks
refreshMode"incremental"Map refresh strategy (incremental, proximity, debounced, immediate, manual)

Next Steps

Now that you've configured HyperFactions:

  1. Set up permissions if using HyperPerms or LuckPerms
  2. Create zones for spawn and arenas
  3. Test your config by creating a faction
  4. See the Configuration Reference for all options