Reference
Housing markets
- Content type
housing- Files
data/housing.json,data/housing/- Shape
- A list of records, each with its own
id - Patch target
housing:<id>, for examplehousing:core.housing.hun- In the base game
- 30 records
- Guide
- Housing
Fields#
Indented fields belong to the field above them. [] marks the items of a list. A field that is not required may be left out; the default is used.
| Field | Type | Required | Default | Notes |
|---|---|---|---|---|
id | id | Yes | Namespaced id, e.g. "core.player.rory-calder" | |
nations | list, up to 120 items | [] | ||
default | true or false | false | ||
starter | text, up to 40 characters | Yes | Pattern: ^[a-z0-9][a-z0-9-]*$ | |
terms | list, 1 to 8 items | Yes | ||
terms[].months | whole number, 1 to 60 | Yes | ||
terms[].rentFactor | number, 0.1 to 5 | Yes | The home's rent times this for an agreement of this length | |
depositMonths | number, 0 to 12 | Yes | The deposit, in months of rent | |
noticeDays | whole number, 0 to 180 | Yes | How long before an agreement ends you are asked what next | |
breakFeeMonths | number, 0 to 24 | Yes | Leaving early costs this many months' rent, or the months left if fewer | |
rollingFactor | number, 0.1 to 5 | Yes | The rent times this once an agreement has run out and rolls on month by month | |
evictAfterMissed | whole number, 1 to 24 | Yes | Months of rent missed in a row before the agreement is ended | |
rentTiming | one of the options | Yes | arrears: a month is paid for after it is lived (the first payment is the month after you move in, and leaving pays the month you are in). advance: the month you move in is paid at once Options: arrears, advance. | |
livingCostsBase | number, 1 to 100,000 | Yes | The weekly living cost (career rules, economy.livingCosts) these rents and bills were written for: a pack that changes livingCosts changes them in step | |
buyCosts | number, 0 to 1 | Yes | Fees on a purchase, as a share of the price | |
sellCosts | number, 0 to 1 | Yes | Fees on a sale, as a share of the value | |
letFactor | number, 0 to 2 | Yes | A home you rent out brings its rent times this a month | |
emptyBillsFactor | number, 0 to 2 | Yes | A home you own that stands empty costs its bills times this | |
priceGrowth | number, -0.5 to 0.5 | Yes | House prices change by this a year on average (0.03 = +3%) | |
priceSwing | number, 0 to 0.5 | Yes | How far a year can differ from the average, either way | |
mortgage | object | |||
mortgage.minDeposit | number, 0 to 1 | Yes | The least you put down, as a share of the price | |
mortgage.rate | number, 0 to 100 | Yes | Per cent a year | |
mortgage.terms | list, 1 to 8 items | Yes | Terms on offer, in years | |
mortgage.incomeMultiple | number, 0 to 20 | Yes | The most it lends, as a multiple of a year's earnings | |
arrivalCosts | object | |||
arrivalCosts.country | number, 0 to 10,000,000 | 0 | A move inside the country | |
arrivalCosts.region | number, 0 to 10,000,000 | 0 | A move from a neighbouring country of the same region | |
arrivalCosts.abroad | number, 0 to 10,000,000 | 0 | A move from further away | |
homes | list, 1 to 40 items | Yes | ||
homes[].id | text, up to 40 characters | Yes | Pattern: ^[a-z0-9][a-z0-9-]*$ | |
homes[].name | text, up to 60 characters | Yes | ||
homes[].description | text, up to 240 characters | |||
homes[].size | whole number, 1 to 9 | Yes | ||
homes[].rent | whole number, 0 to 1,000,000 | A month; left out: not for rent | ||
homes[].price | whole number, 0 to 1,000,000,000 | Left out: not for sale | ||
homes[].bills | whole number, 0 to 1,000,000 | An owner's running costs a month | ||
homes[].ownerEffects | list, up to 8 items | [] | ||
homes[].ownerEffects[].hook | one of the options | Yes | Options: training, practice, coachCall, confidenceFloor, moraleFloor, recovery, fatigueRecovery, injuryRecovery, injuryChance, followers, image, mediaSoften, travelCost, travelFatigue, weeklyCosts, revealFit, scouting, sponsorOffers, offerVolume, offerValue, negotiation, commission, burnout, travelLoad, kitCare. | |
homes[].ownerEffects[].value | number, -100 to 100 | Yes | Strength, as a staff effect at skill 20 | |
homes[].ownerEffects[].area | one of the options | training only: which area (all darts areas when omitted). Options: scoring, doubles, bull, fitness, mental. |
Example#
A record from the base game’s data/housing.json, shortened.
{
"id": "core.housing.hun",
"nations": [
"HUN"
],
"starter": "house-share",
"terms": [
{
"months": 6,
"rentFactor": 1.06
},
{
"months": 12,
"rentFactor": 1
}
],
"depositMonths": 1,
"noticeDays": 28,
"breakFeeMonths": 2,
"rollingFactor": 1.1,
"evictAfterMissed": 2,
"rentTiming": "arrears",
"livingCostsBase": 120,
"buyCosts": 0.025,
"sellCosts": 0.025,
"letFactor": 0.85,
"emptyBillsFactor": 0.6,
"priceGrowth": 0.035,
"priceSwing": 0.05,
"mortgage": {
"minDeposit": 0.1,
"rate": 7.0,
"terms": [
15,
20
],
"incomeMultiple": 4
},
"arrivalCosts": {
"country": 350,
"region": 1600,
"abroad": 6000
},
"homes": [
{
"id": "house-share",
"name": "A room in a shared flat",
"description": "A room in a courtyard block, a shared kitchen and a board in the stairwell.",
"size": 1,
"rent": 300
},
{
"id": "apartment",
"name": "A one-bedroom flat in the inner district",
"description": "Your own front door, a balcony and a wall that will take a board.",
"size": 2,
"rent": 460,
"price": 86500,
"bills": 115
},
{
"id": "terrace",
"name": "A family house on the edge of town",
"description": "Two bedrooms and a summer kitchen you can turn over to the darts.",
"size": 3,
"rent": 620,
"price": 124500,
"bills": 155,
"ownerEffects": [
{
"hook": "practice",
"value": 0.03
}
]
},
/* … 1 more */
]
}In your pack the record’s id starts with your pack’s id instead of core, unless you mean to replace this one.