Modding:Tenants

From Starbounder - Starbound Wiki
Jump to: navigation, search

Modifying or creating Tenants largely relies on two JSON file types, .npctype and .tenant.

Directory JSON Type Description
npcs\tenants .npctype Sets dialogue, quests, and equipment.
tenants .tenant Sets priority, colony tags, tenant type, and rent.
treasure .treasurepools tenantgifts.treasurepools, used by tenant files for rent/gifts.

Examples

generictenant.npctype

{
  "type" : "generictenant",
  "baseType" : "villager",
  
  "dropPools" : [],

  "scriptConfig" : {
    "behaviorConfig" : {
      "greetingChance" : 0
    },
    "questGenerator" : {
      "pools" : ["common", "tenant", "hats"],
      "enableParticipation" : true,

      "timeLimit" : 30,
      "nearbyQuestLimit" : 2,
      "nearbyQuestRange" : 50,
      "chance" : 0.02
    }
  }
}

villager_human.tenant

{
  "name": "villager_human",
  "priority": 2,
  "colonyTagCriteria": {
    "light": 1,
    "door": 1,
    "human": 6
  },

  "tenants": [
    {
      "spawn": "npc",
      "species": "human",
      "type": "generictenant",
      "overrides": {
      }
    }
  ],

  "rent": {
    "periodRange": [900.0, 1800.0],
    "pool": "villagerGift"
  }
}

NPCTYPE

Parameters

type:
baseType:
dropPools:
scriptConfig:
behaviorConfig:
questGenerator:
pools: Sets the array of quests a Tenant can offer. See questpools for possible options.
enableParticipation:
timeLimit:
nearbyQuestLimit:
nearbyQuestRange:
chance: