CityGuard

# CityGuard

CityGuard is a server-side economy, administration, lobby, and citybuild management mod for Minecraft.

It provides the systems needed to build and manage survival, economy, roleplay, and citybuild servers. CityGuard combines a Euro-based economy with jobs, markets, bounties, teams, protected territory, configurable lobby functions, and persistent server NPCs.

The Forge and NeoForge versions are designed to provide the same player-visible features. CityGuard uses vanilla menus, entities, and items wherever possible. No custom textures or additional client-side resource packs are required.

## Main Features

### Economy

- Server-side economy using the Euro currency
- Private balance sidebar for every player
- Administrative commands for managing player balances
- Persistent player economy data
- Configurable prices, limits, and balancing options

### Jobs

- Multiple jobs with separate levels and experience points
- Individual progress for every available job
- Configurable hourly money and experience limits
- Detailed job statistics for players and administrators

### Player Market

- Vanilla inventory-based market interface
- Supply-based market stock
- Dynamic prices based on supply and demand
- Buying and selling through an easy-to-use graphical menu
- Uses vanilla items as interface icons

### CMarket

- Separately unlockable market for individual players
- Infinite item stock
- Prices based on twice the regular market price
- Administrative commands for granting or removing access
- Vanilla inventory-based interface

### Bounties

- Player bounty system for PvP servers
- Rewards for defeating wanted players
- Administrative controls for managing active bounties
- Persistent bounty information

### Teams and Territory

- Team creation and management
- Team roles and permissions
- Chunk claiming
- Basic territory and interaction protection
- Commands for checking the owner and status of a chunk

### Lobby System

- Configurable lobby spawn point
- Optional lobby teleport when joining the server
- Separate first-join teleport option
- Optional lobby teleport after respawning
- Configurable lobby game mode
- Custom lobby message
- Configurable lobby protection radius
- Optional fall-damage protection inside the lobby area
- Cross-dimension lobby teleportation

### Server NPCs

- Persistent NPCs with unique IDs
- NPC names, professions, positions, and rotations
- Configurable glowing, silent, and invulnerable states
- Team assignment with colored NPC names
- Individual access rules for every NPC
- Access modes for everyone, whitelisted players, team members, or nobody
- Per-player allow and deny exceptions
- Automatic NPC restoration when a saved NPC is missing
- Duplicate NPC detection and cleanup
- Persistent NPC data across server restarts

NPCs can perform different actions when a player interacts with them:

- Teleport the player to the lobby
- Open the regular market
- Open the CMarket
- Display the server rules
- Send a configured message
- Execute a command as the player
- Execute a command through the server

### Server Administration

- Online-player overview
- Detailed player information
- Server uptime and performance information
- Server rules management
- Broadcast, action bar, and title messages
- Administrative controls for economy, jobs, markets, bounties, teams, lobby settings, and NPCs

## User Interface

CityGuard uses vanilla Minecraft interfaces wherever possible.

- Vanilla chest-style menus
- Vanilla items as menu icons
- No custom textures required
- No additional resource pack required
- No separate client-side user interface mod required

## Requirements

### Forge Edition

- Minecraft 1.20.1
- Forge 47.4.20 or newer
- Java 17

### NeoForge Edition

- Minecraft 1.21.1
- NeoForge 21.1.230 or newer
- Java 21

Always use the CityGuard file that matches your Minecraft version and mod loader.

## License

CityGuard is released under **All Rights Reserved**.

You may use CityGuard on private and public servers. You may also include the unmodified CityGuard `.jar` file in free modpacks, as long as the modpack itself is not sold.

You may share modified CityGuard configuration files, for example adjusted prices, limits, market settings, or server-specific balancing.

Voluntary donations for servers or modpacks using CityGuard are allowed, as long as the donation is not required to download the modpack or access CityGuard itself.

You are not allowed to sell CityGuard, sell modified versions of CityGuard, redistribute modified `.jar` files, redistribute the source code, publish modified source code, or claim CityGuard as your own work.

In short:

- Free server use is allowed.
- Free modpack use with the unmodified `.jar` is allowed.
- Sharing custom configuration files is allowed.
- Voluntary donations are allowed.
- Selling the mod or modified versions is not allowed.
- Modifying and redistributing the mod code or `.jar` is not allowed.

## Current Version

Current release: **0.3.0**

CityGuard is available for supported Forge and NeoForge versions. Feedback and detailed bug reports are welcome.