Heritage Flags - Flag Code Reference

This page is a reference for the flag codes used by the Heritage Flags mod. Use these codes in:

• Admin → Miscellaneous → Heritage Flags → Flag Mappings -- to map a place name to a specific flag
• Admin → Miscellaneous → Heritage Flags → Local Flags -- to point a flag code at your own hosted image
• Admin → People → Edit Person → Heritage Flag Override -- to set a specific flag for one person

Flags are served from flagcdn.com (free, no account needed). The CDN serves SVG files only. You can also download those SVG files for local hosting.

Image formats: When hosting images locally, you are not limited to SVG. Any format your browser supports will work -- SVG, PNG, JPG, WebP, or GIF. SVG is recommended for flags because it scales perfectly at any size, but a landscape photo as a JPG or a coat of arms as a PNG works just as well.

Local Hosting Options

Heritage Flags offers two ways to serve images from your own server, and they work together:

Option	Where to set it	How it works
Global local path	Mod Manager → Edit Options → $chf_local_path	Points all flags at a folder on your server. Files must be named {code}.svg (e.g. gb-eng.svg, us.svg). Best for hosting your entire flag collection locally.
Per-code local URL	Admin → Miscellaneous → Heritage Flags → Local Flags	Sets a full URL for one specific flag code. Any image format. Any location on your server. Takes priority over the global path. Best for overriding just a few specific flags -- e.g. an England flag with a border, or a Yorkshire landscape -- while everything else loads from the CDN.

The lookup order is: Local Flags table (per-code) → Global local path (folder) → CDN (flagcdn.com).

---

Standard ISO Codes (ISO 3166-1 alpha-2)

Two-letter lowercase codes for sovereign nations. These are the codes recognised by the Heritage Flags built-in mapping array and by flagcdn.com.

British Isles

Code	Flag	Country / Region
gb-eng		England
gb-sct		Scotland
gb-wls		Wales
gb-nir		Northern Ireland
gb		United Kingdom
ie		Ireland
im		Isle of Man
je		Jersey
gg		Guernsey

Western Europe

Code	Flag	Country / Region
fr		France
de		Germany
nl		Netherlands
be		Belgium
lu		Luxembourg
ch		Switzerland
at		Austria
li		Liechtenstein
mc		Monaco
ad		Andorra
gi		Gibraltar

Southern Europe

Code	Flag	Country / Region
it		Italy
es		Spain
pt		Portugal
gr		Greece
mt		Malta
va		Vatican City
sm		San Marino
cy		Cyprus
al		Albania
me		Montenegro
ba		Bosnia and Herzegovina
hr		Croatia
rs		Serbia
si		Slovenia
mk		North Macedonia
xk		Kosovo

Northern Europe

Code	Flag	Country / Region
se		Sweden
no		Norway
dk		Denmark
fi		Finland
is		Iceland
ee		Estonia
lv		Latvia
lt		Lithuania

Eastern Europe

Code	Flag	Country / Region
pl		Poland
cz		Czech Republic
sk		Slovakia
hu		Hungary
ro		Romania
bg		Bulgaria
ua		Ukraine
ru		Russia
by		Belarus
md		Moldova

North America

Code	Flag	Country / Region
us		United States
ca		Canada
mx		Mexico
pr		Puerto Rico
cu		Cuba
jm		Jamaica
ht		Haiti
do		Dominican Republic
tt		Trinidad and Tobago
bb		Barbados

Central & South America

Code	Flag	Country / Region
br		Brazil
ar		Argentina
cl		Chile
co		Colombia
pe		Peru
ve		Venezuela
ec		Ecuador
bo		Bolivia
py		Paraguay
uy		Uruguay
gt		Guatemala
hn		Honduras
sv		El Salvador
ni		Nicaragua
cr		Costa Rica
pa		Panama

Middle East

Code	Flag	Country / Region
tr		Turkey
il		Israel
ps		Palestine
jo		Jordan
lb		Lebanon
sy		Syria
iq		Iraq
ir		Iran
sa		Saudi Arabia
ae		United Arab Emirates
kw		Kuwait
qa		Qatar
bh		Bahrain
om		Oman
ye		Yemen

Africa

Code	Flag	Country / Region
eg		Egypt
dz		Algeria
ma		Morocco
tn		Tunisia
ly		Libya
za		South Africa
ng		Nigeria
ke		Kenya
et		Ethiopia
gh		Ghana
tz		Tanzania
ug		Uganda
sn		Senegal
cm		Cameroon
ci		Ivory Coast
ao		Angola
mz		Mozambique
mg		Madagascar
zw		Zimbabwe
zm		Zambia

Asia & Pacific

Code	Flag	Country / Region
in		India
cn		China
jp		Japan
kr		South Korea
kp		North Korea
pk		Pakistan
bd		Bangladesh
lk		Sri Lanka
np		Nepal
af		Afghanistan
mm		Myanmar
th		Thailand
vn		Vietnam
kh		Cambodia
la		Laos
my		Malaysia
sg		Singapore
id		Indonesia
ph		Philippines
au		Australia
nz		New Zealand
fj		Fiji
pg		Papua New Guinea

---

Extended Subdivision Codes

Some countries use extended codes for regions with their own flags. Heritage Flags uses these for the British Isles so England, Scotland, Wales, and Northern Ireland each show their own flag rather than the Union Jack.

flagcdn.com supports the four GB home nations and all 50 US states. Other regional subdivisions (Catalonia, Brittany, Orkney etc.) are not available on the CDN. To use those, host your own image and add the code to the Local Flags table in the Heritage Flags admin page.

Code	Flag	Region
gb-eng		England
gb-sct		Scotland
gb-wls		Wales
gb-nir		Northern Ireland
us-al		Alabama
us-ak		Alaska
us-az		Arizona
us-ar		Arkansas
us-ca		California
us-co		Colorado
us-ct		Connecticut
us-de		Delaware
us-fl		Florida
us-ga		Georgia
us-hi		Hawaii
us-id		Idaho
us-il		Illinois
us-in		Indiana
us-ia		Iowa
us-ks		Kansas
us-ky		Kentucky
us-la		Louisiana
us-me		Maine
us-md		Maryland
us-ma		Massachusetts
us-mi		Michigan
us-mn		Minnesota
us-ms		Mississippi
us-mo		Missouri
us-mt		Montana
us-ne		Nebraska
us-nv		Nevada
us-nh		New Hampshire
us-nj		New Jersey
us-nm		New Mexico
us-ny		New York
us-nc		North Carolina
us-nd		North Dakota
us-oh		Ohio
us-ok		Oklahoma
us-or		Oregon
us-pa		Pennsylvania
us-ri		Rhode Island
us-sc		South Carolina
us-sd		South Dakota
us-tn		Tennessee
us-tx		Texas
us-ut		Utah
us-vt		Vermont
us-va		Virginia
us-wa		Washington
us-wv		West Virginia
us-wi		Wisconsin
us-wy		Wyoming

---

Custom Codes for Local Hosting

When using Local Flags in the Heritage Flags admin page, you are not limited to ISO codes. You can use any code you like, as long as:

• The code is lowercase letters, numbers, and hyphens only (e.g. yorkshire, clan-campbell, new-orleans)
• The code is matched by either a custom mapping (Admin → Heritage Flags → Flag Mappings) or a personal override (Edit Person → Heritage Flag Override)
• Your image is hosted at a full URL your server can serve
• The URL includes the file extension -- any format is supported (SVG, PNG, JPG, WebP, GIF)

Custom codes let you go well beyond flags. Some ideas:

• Coats of arms -- clan-campbell, clan-mackenzie (PNG or SVG)
• County or regional landscapes -- yorkshire, cornwall (JPG or WebP photo)
• City or parish images -- new-orleans, edinburgh (JPG or WebP photo)
• Historical territory images -- new-france, dutch-republic (SVG or PNG illustration)

Because the mod checks most specific place name first, a custom mapping for yorkshire will win over the built-in england mapping for any person whose birthplace includes Yorkshire, England -- without affecting anyone else from England. You can build an entire tiered image hierarchy, one mapping at a time, mixing CDN flags and your own hosted images freely on the same site.

Example: For a person born in Biggar, Lanarkshire, Scotland:

• If biggar is in your custom mappings -- Biggar image wins
• Else if lanarkshire is in your custom mappings -- Lanarkshire image wins
• Else if scotland is in your custom mappings -- your custom Scotland image wins
• Else -- built-in mapping resolves scotland to gb-sct and the Scotland flag loads from the CDN

---

Where to Find More Codes

• flagcdn.com -- full list of supported codes, plus SVG downloads
• Wikipedia: ISO 3166-1 alpha-2 -- official standard reference
• Wikipedia: ISO 3166-2 -- subdivision codes (regions, states, provinces)

 

Knowledge Home    Admin | Misc