Apartment Core
On this page
When an ApartmentCore apartment's region sits inside a nation's claimed territory, the tax its owner pays can be forwarded into that nation's treasury.
This works exactly like FactoryCore tax routing, but is configured completely independently β you can enable one without the other, and give them different shares and caps.
# NationCore β config.yml
integration:
apartment-tax:
enabled: true# ApartmentCore β its own config
integration:
nation-tax:
enabled: trueBoth sides must be on.
integration:
apartment-tax:
enabled: true
share-percent: 100.0
max-per-payment: 0.0
log: true| Key | Default | Meaning |
|---|---|---|
enabled |
true |
Master switch for accepting routed apartment taxes |
share-percent |
100.0 |
Percentage banked into the owning nation's treasury (0β100, clamped) |
max-per-payment |
0.0 |
Maximum a single payment may add. 0 disables the cap |
log |
true |
Log every routed payment to the console |
The same gate chain as factory tax:
- The integration is enabled.
- The amount is positive, finite and not NaN.
- The location is valid and its world is loaded.
- The land belongs to a nation.
Then:
amount = gross Γ (share-percent / 100)
amount = min(amount, max-per-payment) # when capped
amount = floor(amount Γ 100) / 100Deposited as TAX_INCOME with the description Apartment tax (<label>). The
method returns the banked amount and never throws.
The two blocks share no state:
| Factory | Apartment | |
|---|---|---|
| Enable switch | integration.factory-tax.enabled |
integration.apartment-tax.enabled |
| Share | integration.factory-tax.share-percent |
integration.apartment-tax.share-percent |
| Cap | integration.factory-tax.max-per-payment |
integration.apartment-tax.max-per-payment |
| Logging | integration.factory-tax.log |
integration.apartment-tax.log |
ApartmentCore also participates in the land-use permit system, asking NationCore before it registers a new apartment region on claimed ground.