Manufacturers - massif-press/lancer-data GitHub Wiki

Overview

Any Core Bonus or licensed item must (with certain exceptions, see below) require a source field populated with a manufacturer ID. This may reference one of the Core Book main manufacturers, a manufacturer from another LCP (see LCP Dependencies), or a new manufacturer defined in your LCP data.

New manufacturers are stored under a file named manufacturers.json that contains a single array of manufacturer data objects.

Exceptions

Three types of item don't require a source field or associated manufacturer. They are:

See their respective item pages for further details.

Definition

manufacturers.json

[
  {
    "id": string,
    "name": string,
    "description": string,
    "quote": string,
    "light": string,
    "dark": string,
    "icon_svg": string,
    "icon_url": string
  },
  ...
]

Required Fields

id

Internal identifier. This ID has the same global uniqueness requirements as outlined in the Item ID Guidelines, and is also referenced in the source fields of all licensed equipment and Core Bonuses that are associated with the manufacturer. The manufacturer ID should be acronym/abbreviated form of the manufacturer name (eg. GMS for General Massive Systems). This is often used in Source fields for licensed equipment. When making your own LCPs, take care to choose a unique manufacturer ID for homebrew manufacturers.

name

The display name of the manufacturer

description

Flavor text for the Compendium Manufacturer page. HTML syntax is allowed.

quote

Additional flavor text for the Compendium Manufacturer page. HTML syntax is allowed.

light

A hex color code (#XXXXXX). The light color will be used for UI themes that use the 'light' base (such as GMS Default).

dark

A hex color code (#XXXXXX). The dark color will be used for UI themes that use the 'dark' base (such as MSMC Solarized).

Optional Fields

icon_svg

Raw inline SVG for use as the manufacturer logo. SVG data will be purified.

icon_url

If icon_svg is missing, COMP/CON will attempt to load SVG data at the icon url (also purified. This is to preserve backwards compatibility, icon_svg is strongly preferred.

If icon_svg and icon_url are missing, COMP/CON will use a generic manufacturer logo.

Example

from lancer-data/lib/manufacturers.json

{
  "id": "HA",
  "name": "HARRISON ARMORY",
  "logo": "ha",
  "light": "#6e4373",
  "dark": "#a15ea8",
  "quote": "<i>Superior by design.</i>",
  "description": "Harrison Armory enjoys a galaxy-wide reputation for the quality of its weapons and defensive systems. The corpro-state previously specialized in ordnance and other armaments, making it reliant on competitors’ frames as mounts for its deluxe equipment; however, since the overthrow of Union’s Second Committee, Harrison Armory has broadened its product line to include an extensive range of peerless frontline frames. On the wave of this new success, the Armory has transformed into a burgeoning, imperial corpro-state, a mighty galactic power that directly administers a large number of Core worlds, orbitals, and colonial prospects – this is the Purview; all lands under the Armory’s command.<br><br>By necessity of Harrison Armory’s imperial aims, its frames tend to be sturdy. More than that, Armory mechs are built to ensure overwhelming performance, embodying dominance and power in their brutal, geometric aesthetics. This fulfillment of this desire requires tremendous power, skill, and material strength.<br><br>Harrison Armory licenses are perfect for pilots looking to field durable frontline mechs equipped with the most advanced weapons technology available."
}
⚠️ **GitHub.com Fallback** ⚠️