[System]
You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:
<schema>
{"$schema":"http://json-schema.org/draft-04/schema#","id":"https://cardgamesim.finoldigital.com/schema/cgs.json","title":"CGS Card Game Specification","type":"object","description":"Card Game Simulator (CGS) Card Game Specification","additionalProperties":false,"required":["name"],"properties":{"name":{"type":"string","description":"The name of the custom card game as it appears to the user. This name is required for the *Game:Id*."},"allCardsUrl":{"type":["null","string"],"description":"From allCardsUrl, CGS downloads the json that contains the Card data for the game. If CGS is able to successfully download this file, it will save it as AllCards.json.","format":"uri"},"allCardsUrlPageCount":{"type":"integer","description":"If allCardsUrlPageCount > 1, CGS will download <allCardsUrl> with <allCardsUrlPageIdentifier>+<page> for each page.","format":"int32","default":1},"allCardsUrlPageCountIdentifier":{"type":"string","description":"If allCardsUrlPageCountIdentifier is set, CGS will set the allCardsUrlPageCount to the response value of <allCardsUrlPageCountIdentifier> from <allCardsUrl>."},"allCardsUrlPageCountDivisor":{"type":"integer","description":"allCardsUrlPageCountDivisor can be set to the # of cards per page, ie: allCardsUrlPageCount = <allCardsUrlPageCountIdentifier pointing to total # of cards>/<allCardsUrlPageCountDivisor>.","format":"int32","default":1},"allCardsUrlPageCountStartIndex":{"type":"integer","description":"allCardsUrlPageCountStartIndex is used to identify the first page of allCardsUrlPageCount.","format":"int32","default":1},"allCardsUrlPageIdentifier":{"type":"string","description":"If allCardsUrlPageCount > 1, CGS will download <allCardsUrl> with <allCardsUrlPageIdentifier>+<page> for each page.","default":"?page="},"allCardsUrlPostBodyContent":{"type":"string","description":"If allCardsUrlPostBodyContent is set, CGS will make a POST to <allCardsUrl> with a JSON body that contains <allCardsUrlPostBodyContent>. If not set, CGS will just GET from <allCardsUrl>."},"allCardsUrlRequestHeader":{"type":"string","description":"allCardsUrlRequestHeader and allCardsUrlRequestHeader can be used together for secured APIs.","default":"X-Api-Key"},"allCardsUrlRequestHeaderValue":{"type":"string","description":"allCardsUrlRequestHeader and allCardsUrlRequestHeader can be used together for secured APIs."},"allCardsUrlWrapped":{"type":"boolean","description":"If allCardsUrl points to file(s) enclosed by extra characters, set allCardsUrlWrapped to true, and CGS will trim the first and last characters."},"allCardsUrlZipped":{"type":"boolean","description":"If allCardsUrl points to zipped file(s), set allCardsUrlZipped to true, and CGS will unzip the file(s)."},"allDecksUrl":{"type":["null","string"],"description":"From allDecksUrl, CGS downloads the json that contains the Deck data for the game. If CGS is able to successfully download this file, it will save it as AllDecks.json.","format":"uri"},"allDecksUrlDataIdentifier":{"type":"string","description":"If allDecksUrlDataIdentifier is set to a non-empty string, AllDecks.json will be parsed as a JSON object: {\"@allDecksUrlDataIdentifier\":{\"$ref\":\"AllDecks.json\"}}"},"allDecksUrlPostBodyContent":{"type":"string","description":"If allDecksUrlPostBodyContent is set, CGS will make a POST to <allDecksUrl> with a JSON body that contains <allDecksUrlPostBodyContent>. If not set, CGS will just GET from <allDecksUrl>."},"allDecksUrlTxtRoot":{"type":"string","description":"If allDecksUrlTxtRoot is set, CGS will parse deck urls as <allDecksUrlTxtRoot>+*DeckUrl:Txt*"},"allSetsUrl":{"type":["null","string"],"description":"From allSetsUrl, CGS downloads the json that contains the Set data for the game. If CGS is able to successfully download this json, it will save it as AllSets.json.","format":"uri"},"allSetsUrlWrapped":{"type":"boolean","description":"If allSetsUrl points to a file enclosed by extra characters, set allSetsUrlWrapped to true, and CGS will trim the first and last characters."},"allSetsUrlZipped":{"type":"boolean","description":"If allSetsUrl points to a zipped file, set allSetsUrlZipped to true, and CGS will unzip the file."},"autoUpdate":{"type":"integer","description":"autoUpdate indicates how many days to use cached files instead of re-downloading. autoUpdate=0 will re-download files at every opportunity. autoUpdate<0 will never attempt to download anything.","format":"int32","default":30},"autoUpdateUrl":{"type":["null","string"],"description":"autoUpdateUrl indicates the url from which users download *Game:Name*.json, and CGS will automatically re-download the custom game from this url every <autoUpdate> days. This url is used in the *Game:Id*. You should host *Game:Name*.json at this url, but if you do not, you can set autoUpdate to -1, and there should be no issues.","format":"uri"},"bannerImageFileType":{"type":"string","description":"bannerImageFileType is the file type extension for the image file that CGS downloads from bannerImageUrl.","default":"png"},"bannerImageUrl":{"type":["null","string"],"description":"If bannerImageUrl is a valid url, CGS will download the image at that url and save it as Banner.<bannerImageFileType>. CGS will attempt to display the Banner.<bannerImageFileType> as an identifier to the user. If it is unable to read Banner.<bannerImageFileType>, CGS will simply display the CGS logo.","format":"uri"},"cardBackFaceImageUrls":{"type":"array","description":"CGS will go through each CardBackFaceImageUrl and save the data from *CardBackFaceImageUrl:Url* to 'backs/*CardBackFaceImageUrl:Id*.<cardBackImageFileType>'","items":{"$ref":"#/definitions/CardBackFaceImageUrl"}},"cardBackImageFileType":{"type":"string","description":"cardBackImageFileType is the file type extension for the image file that CGS downloads from cardBackImageUrl.","default":"png"},"cardBackImageUrl":{"type":["null","string"],"description":"If cardBackImageUrl is a valid url, CGS will download the image at that url and save it as CardBack.<cardBackImageFileType>. CGS will display the CardBack.<cardBackImageFileType> when the user turns a card facedown or if CGS is unable to find the appropriate card image. If CGS is unable to get a custom card back, CGS will use the default CGS card back.","format":"uri"},"cardDataIdentifier":{"type":"string","description":"If cardDataIdentifier is set to a non-empty string, AllCards.json will be parsed as a JSON object: {\"@cardDataIdentifier\":{\"$ref\":\"AllCards.json\"}}"},"cardIdIdentifier":{"type":"string","description":"Every Card must have a unique id. When defining a Card in AllCards.json or AllSets.json, you can have the *Card:Id* mapped to the field defined by cardIdIdentifier. Most custom games will likely want to keep the default cardIdIdentifier.","default":"id"},"cardIdStop":{"type":"string","description":"Every Card must have a unique id. When defining a Card in AllCards.json or AllSets.json, you can have the *Card:Id* mapped to the field defined by cardIdIdentifier. Most custom games will likely want to keep the default cardIdIdentifier. If cardIdStop is set, any id that contains cardIdStop will be stopped at <cardIdStop>."},"cardImageFileType":{"type":"string","description":"cardImageFileType is the file type extension for the image files that CGS downloads for each individual Card.","default":"png"},"cardImageProperty":{"type":"string","description":"cardImageProperty is the *Card:Property* which points to the image for this Card. If <cardImageProperty> is empty, <cardImageUrl> will be used instead."},"cardImageUrl":{"type":"string","description":"cardImageUrl is a parameterized template url from which CGS downloads card image files if <cardImageProperty> is empty. Parameters: {cardId}=*Card:Id*, {cardName}=*Card:Name*, {cardSet}=*Card:SetCode*, {cardImageFileType}=<cardImageFileType>, {<property>}=*Card:<property>*. Example: https://www.cardgamesimulator.com/games/Standard/sets/{cardSet}/{cardId}.{cardImageFileType}","format":"uri-template"},"cardNameBackIdentifier":{"type":"string","description":"When defining a Card in AllCards.json or AllSets.json, you can have the *Card:Name* of the back face mapped to the field defined by cardNameBackIdentifier. Most custom games will likely want to keep the default cardNameBackIdentifier."},"cardNameIdentifier":{"type":"string","description":"When defining a Card in AllCards.json or AllSets.json, you can have the *Card:Name* mapped to the field defined by cardNameIdentifier. Most custom games will likely want to keep the default cardNameIdentifier.","default":"name"},"cardNameIsUnique":{"type":"boolean","description":"If cardNameIsUnique is true, different Cards are not allowed to have the same *Card:Name*. Cards with the same name will be treated as reprints, with the option to hide reprints available. If cardNameIsUnique is false, DeckFileType.Txt will require <deckFileTxtId> for every Card.","default":true},"cardPrimaryProperty":{"type":"string","description":"The cardPrimaryProperty is the *Card:Property* that is first selected and displayed in the Card Viewer, which appears whenever a user selects a card."},"cardProperties":{"type":"array","description":"cardProperties defines the name keys for *Card:Property*s. The values should be mapped in AllCards.json or AllSets.json.","items":{"$ref":"#/definitions/PropertyDef"}},"cardPropertyIdentifier":{"type":"string","description":"When defining a Card in AllCards.json or AllSets.json, you can integrate objectEnum and objectEnumList properties with enums by using cardPropertyIdentifier. Most custom games will likely want to keep the default cardPropertyIdentifier.","default":"id"},"cardRotationDefault":{"type":"integer","description":"Cards will be rotated <cardRotationDefault> degrees, unless you override with cardRotationIdentifier. Most custom games will likely want to keep the default cardRotationDefault.","format":"int32","default":0},"cardRotationIdentifier":{"type":"string","description":"When defining a Card in AllCards.json or AllSets.json, you can set <cardRotationIdentifier> to an int field that indicates the rotation of a card in degrees. If left blank or missing, cards will be rotated <cardRotationDefault> degrees."},"cardSetIdentifier":{"type":"string","description":"When defining a Card in AllCards.json, you can have the *Card:SetCode* mapped to the field defined by cardSetIdentifier. If the mapping is missing, CGS will use <setCodeDefault>. Most custom games will likely want to keep the default cardSetIdentifier.","default":"set"},"cardSetIsObject":{"type":"boolean","description":"If cardSetIsObject is set to true, <cardSetIdentifier> should point to an object (or list of objects) that follows the rules for AllSets.json."},"cardSetNameIdentifier":{"type":"string","description":"When defining a Card in AllCards.json, you can have the *Card:SetCode* mapped to the field defined by cardSetIdentifier. That Set's name can be defined by cardSetNameIdentifier.","default":"setname"},"cardSetsInList":{"type":"boolean","description":"If cardSetInList is set to true, Cards will be duplicated for each Set in <cardSetIdentifier>."},"cardSetsInListIsCsv":{"type":"boolean","description":"If cardSetsInListIsCsv is set to true, Cards will be duplicated for each Set found in the comma-separated list of <cardSetIdentifier>."},"cardSize":{"description":"cardSize indicates a card's width and height in inches.","default":"(x: 2.5, y: 3.5)","oneOf":[{"$ref":"#/definitions/Float2"}]},"cgsGamesLink":{"type":["null","string"],"description":"cgsGamesLink is a clickable url that will take the user directly to this game on the CGS Games website, which can be shared between users.","format":"uri"},"copyright":{"type":"string","description":"copyright indicates the legal owner of this Card Game. CGS will display this value in the bottom-left corner of the Main Menu."},"deckFileAltId":{"type":"string","description":"When saving or loading a deck with <deckFileType> NOT txt, deckFileAltId refers to the *Card:Property* used to uniquely identify each Card. For hsd, this is stored as a varint within the deck string.","default":"dbfId"},"deckFileTxtId":{"description":"When saving a deck as txt, different Cards may share the same name, and if they do, the *Card:<deckFileTxtId>* will be used to uniquely identify Cards.","default":"set","oneOf":[{"$ref":"#/definitions/DeckFileTxtId"}]},"deckFileType":{"description":"When saving a deck, the formatting for how it is saved and loaded is defined by the deckFileType. dec refers to the old MTGO deck file format. hsd refers to the Hearthstone deck string format. ydk refers to the YGOPRO deck file format. txt parses each line for the following: <Quantity> [*Card:Id*] *Card:Name* (*Card:SetCode*).","default":"txt","oneOf":[{"$ref":"#/definitions/DeckFileType"}]},"deckPlayCards":{"type":"array","description":"deckPlayCards indicates cards that should automatically be played when a player loads a deck in Play Mode.","items":{"$ref":"#/definitions/DeckPlayCard"}},"deckSharePreference":{"description":"For networked games, CGS will use deckSharePreference to: ask players if they want to share the same deck, force all players to share the same deck, or force an individual deck for each player.","default":"share","oneOf":[{"$ref":"#/definitions/SharePreference"}]},"deckUrls":{"type":"array","description":"CGS will go through each DeckUrl and save the data from *DeckUrl:Url* to 'decks/*DeckUrl:Name*.<deckFileType>'","items":{"$ref":"#/definitions/DeckUrl"}},"enums":{"type":"array","description":"The value is displayed to the user through the UI while the keys remain hidden. If the keys are entered as a hexadecimal integers (prefixed with 0x), multiple values can go through bitwise and/ors to have a single enumValue represent multiple values. The multiple values would be displayed together to the user, using | as the delimiter.","items":{"$ref":"#/definitions/EnumDef"}},"extras":{"type":"array","description":"Describes extra cards separate from the main deck: The hsd deckFileType treats all extra cards as Heroes, and the ydk deckFileType treats all extra cards as extra deck cards.","items":{"$ref":"#/definitions/ExtraDef"}},"gameBoardImageFileType":{"type":"string","description":"gameBoardImageFileType is the file type extension for the image files that CGS downloads for each game board.","default":"png"},"gameBoardCards":{"type":"array","items":{"$ref":"#/definitions/GameBoardCard"}},"gameBoardUrls":{"type":"array","description":"CGS will go through each GameBoardUrl and save the data from *GameBoardUrl:Url* to 'boards/*GameBoardUrl:Id*.<gameBoardImageFileType>'","items":{"$ref":"#/definitions/GameBoardUrl"}},"gameCardRotationDegrees":{"type":"integer","description":"gameCardRotationDegrees indicates how many degrees to rotate Cards in Play Mode.","format":"int32","default":90},"gameDefaultCardAction":{"description":"If possible, CGS will take the gameDefaultCardAction when a Card is double-clicked in Play Mode.","default":"flip","oneOf":[{"$ref":"#/definitions/CardAction"}]},"gamePlayDeckName":{"type":"string","description":"gamePlayDeckName is the name of the card stack shown when a player loads a deck. If <gamePlayDeckName> is empty, the *Deck:Name* is used."},"gamePlayDeckPositions":{"type":"array","description":"Each deck loaded during a game will be loaded to its corresponding position in gamePlayDeckPositions. The first deck loaded will go to the first position, second to second, etc.","items":{"$ref":"#/definitions/Float2"}},"gamePlayZones":{"type":"array","description":"gamePlayZones will appear in the Play Area in Play Mode.","items":{"$ref":"#/definitions/GamePlayZone"}},"gameStartDecks":{"type":"array","description":"gameStartDecks indicates decks that should automatically be loaded when a player starts playing in Play Mode.","items":{"$ref":"#/definitions/DeckUrl"}},"gameStartHandCount":{"type":"integer","description":"gameStartHandCount indicates how many cards are automatically dealt from a loaded deck to a player's hand.","format":"int32"},"gameStartPointsCount":{"type":"integer","description":"gameStartPointsCount indicates how many points are automatically assigned to each player.","format":"int32"},"playMatImageFileType":{"type":"string","description":"playMatImageFileType is the file type extension for the image file that CGS downloads from playMatImageUrl.","default":"png"},"playMatImageUrl":{"type":["null","string"],"description":"If playMatImageUrl is a valid url, CGS will download the image at that url and save it as PlayMat.<playMatImageFileType>. CGS will use the PlayMat.<playMatImageFileType> as the background image while in Play Mode. If CGS is unable to get this image, CGS will use the default table image.","format":"uri"},"playMatSize":{"description":"playMatSize indicates the width and height in inches of the play area in Play Mode.","default":"(x: 36, y: 36)","oneOf":[{"$ref":"#/definitions/Float2"}]},"playMatGridCellSize":{"description":"playMatGridCellSize indicates the width and height in inches of each cell in the play area in Play Mode.","default":"(x: 0.5, y: 0.5)","oneOf":[{"$ref":"#/definitions/Float2"}]},"rulesUrl":{"type":["null","string"],"description":"rulesUrl should link to this game's online rulebook.","format":"uri"},"setCardsIdentifier":{"type":"string","description":"When defining a Set in AllSets.json, you can also define Cards to include in that Set by indicating them with setCardsIdentifier. Most custom games will likely want to keep the default setCardsIdentifier.","default":"cards"},"setCardsUrlIdentifier":{"type":"string","description":"When defining a Set in AllSets.json, you can also define Cards to include in that Set by indicating them with SetCardsUrlIdentifier. Most custom games will likely want to keep the default SetCardsUrlIdentifier.","default":"cardsUrl"},"setCodeDefault":{"type":"string","description":"If a Card does not specify its Set, it will be included in the Set with *Set:Code* specified by setCodeDefault. This Set's name is specified by setNameDefault.","default":"_CGSDEFAULT_"},"setCodeIdentifier":{"type":"string","description":"When defining a Set in AllSets.json, you can have the *Set:Code* mapped to the field defined by setCodeIdentifier. Most custom games will likely want to keep the default setCodeIdentifier.","default":"code"},"setDataIdentifier":{"type":"string","description":"If setDataIdentifier is set to a non-empty string, AllSets.json will be parsed as a JSON object: {\"@setDataIdentifier\":{\"$ref\":\"AllSets.json\"}}"},"setNameDefault":{"type":"string","description":"If a Card does not specify its Set, it will be included in the Set with *Set:Code* specified by setCodeDefault. This Set's name is specified by setNameDefault.","default":"_CGSDEFAULT_"},"setNameIdentifier":{"type":"string","description":"When defining a Set in AllSets.json, you can have the *Set:Name* mapped to the field defined by setNameIdentifier. If the mapping is missing, CGS will use the *Set:Code*. Most custom games will likely want to keep the default setNameIdentifier.","default":"name"}},"definitions":{"CardBackFaceImageUrl":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"The id of the card back"},"url":{"type":"string","description":"The url from which to download the card back","format":"uri"}}},"PropertyDef":{"type":"object","additionalProperties":false,"required":["name","type"],"properties":{"name":{"type":"string","description":"The name of the property: This name can be referenced to lookup a Card's property"},"type":{"description":"The type of the property","default":"string","oneOf":[{"$ref":"#/definitions/PropertyType"}]},"display":{"type":"string","description":"The name of the property as it is displayed to the end user"},"displayEmpty":{"type":"string","description":"The value to display if the value is null or empty"},"displayEmptyFirst":{"type":"boolean","description":"List <displayEmpty> as the first option if this property is an enum?"},"delimiter":{"type":"string","description":"If this property is a stringList or stringEnumList, the value will be delimited by this delimiter"},"backName":{"type":"string","description":"If the Card is a back Face: This name can be referenced to lookup a Card's property"},"frontName":{"type":"string","description":"If the Card is a front Face: This name can be referenced to lookup a Card's property"},"properties":{"type":"array","items":{"$ref":"#/definitions/PropertyDef"}}}},"PropertyType":{"type":"string","description":"","x-enumNames":["String","EscapedString","Integer","Boolean","Object","StringEnum","StringList","StringEnumList","ObjectEnum","ObjectList","ObjectEnumList"],"enum":["string","escapedString","integer","boolean","object","stringEnum","stringList","stringEnumList","objectEnum","objectList","objectEnumList"]},"Float2":{"type":"object","additionalProperties":false,"properties":{"x":{"type":"number","format":"float"},"y":{"type":"number","format":"float"}}},"DeckFileTxtId":{"type":"string","description":"","x-enumNames":["Id","Set"],"enum":["id","set"]},"DeckFileType":{"type":"string","description":"","x-enumNames":["Dec","Hsd","Lor","Txt","Ydk"],"enum":["dec","hsd","lor","txt","ydk"]},"DeckPlayCard":{"type":"object","additionalProperties":false,"properties":{"cardQuery":{"type":"string","description":"CGS will automatically play the Card that matches cardQuery, when the player loads a Deck in Play Mode matching deckQuery"},"deckQuery":{"type":"string","description":"CGS will automatically play the Card that matches cardQuery, when the player loads a Deck in Play Mode matching deckQuery"},"position":{"description":"Indicates the played Card's position in inches","oneOf":[{"$ref":"#/definitions/Float2"}]},"rotation":{"type":"integer","description":"Indicates the played Card's rotation in degrees","format":"int32"}}},"SharePreference":{"type":"string","description":"","x-enumNames":["Ask","Share","Individual"],"enum":["ask","share","individual"]},"DeckUrl":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","description":"The name of the deck"},"txt":{"type":"string","description":"An optional path that can be used to override the url. See @cgs.json#/properties/allDecksUrlTxtRoot"},"url":{"type":"string","description":"The url from which to download the deck","format":"uri"},"isAvailable":{"type":"boolean","description":"Optionally set to false to ignore this deck url","default":"true"}}},"EnumDef":{"type":"object","additionalProperties":false,"properties":{"property":{"type":"string","description":"Refers to a *Property:Name* in <cardProperties>"},"values":{"type":"object","description":"Dictionary with string key-value pairs","additionalProperties":{"type":"string"}}}},"ExtraDef":{"type":"object","additionalProperties":false,"properties":{"group":{"type":"string","description":"A group of extra cards is displayed together with this label in Play Mode","default":"Extras"},"property":{"type":"string","description":"Refers to a *Property:Name* in <cardProperties>"},"value":{"type":"string","description":"If *Card:Properties[ExtraDef:Property]* equals *ExtraDef:Value*, then that card will be moved from the main deck to this extra deck"}}},"GameBoardCard":{"type":"object","additionalProperties":false,"properties":{"card":{"type":"string","description":"When a deck is loaded in Play Mode, any card with *Card:Id* = *Card* will cause *Boards* to be put into the play area."},"boards":{"type":"array","items":{"$ref":"#/definitions/GameBoard"}}}},"GameBoard":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"The id of the board"},"offsetMin":{"description":"Indicates the position (in inches) of the bottom-left corner","oneOf":[{"$ref":"#/definitions/Float2"}]},"size":{"description":"Indicates the board's width and height in inches","oneOf":[{"$ref":"#/definitions/Float2"}]}}},"GameBoardUrl":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"The id of the board"},"url":{"type":"string","description":"The url from which to download the board image","format":"uri"}}},"CardAction":{"type":"string","description":"","x-enumNames":["Move","Rotate","Tap","Flip","Discard"],"enum":["move","rotate","tap","flip","discard"]},"GamePlayZone":{"type":"object","additionalProperties":false,"properties":{"face":{"description":"When a Card enters the Game Play Zone, the Card will display this face","default":"any","oneOf":[{"$ref":"#/definitions/FacePreference"}]},"defaultCardAction":{"description":"If possible, CGS will take the defaultCardAction when a Card is double-clicked in the Game Play Zone. If null, defaults to <gameDefaulCardAction>","oneOf":[{"type":"null"},{"$ref":"#/definitions/CardAction"}]},"position":{"description":"Indicates the Game Play Zone's position in inches","oneOf":[{"$ref":"#/definitions/Float2"}]},"rotation":{"type":"integer","description":"Indicates the Game Play Zone's rotation in degrees","format":"int32"},"size":{"description":"Indicates the Game Play Zone's width and height in inches","oneOf":[{"$ref":"#/definitions/Float2"}]},"type":{"description":"The Game Play Zone type from area, horizontal, or vertical","default":"area","oneOf":[{"$ref":"#/definitions/GamePlayZoneType"}]}}},"FacePreference":{"type":"string","description":"","x-enumNames":["Any","Down","Up"],"enum":["any","down","up"]},"GamePlayZoneType":{"type":"string","description":"","x-enumNames":["Area","Horizontal","Vertical"],"enum":["area","horizontal","vertical"]}}}
</schema>

[User] Provide a JSON object that satisfies the schema "CGS Card Game Specification". Here are the required top‑level fields: name. Return only the valid JSON object.

CGS Card Game Specification

Card Game Simulator (CGS) Card Game Specification

The name of the custom card game as it appears to the user. This name is required for the *Game:Id*.

From allCardsUrl, CGS downloads the json that contains the Card data for the game. If CGS is able to successfully download this file, it will save it as AllCards.json.

If allCardsUrlPageCount > 1, CGS will download <allCardsUrl> with <allCardsUrlPageIdentifier>+<page> for each page.

If allCardsUrlPageCountIdentifier is set, CGS will set the allCardsUrlPageCount to the response value of <allCardsUrlPageCountIdentifier> from <allCardsUrl>.

allCardsUrlPageCountDivisor can be set to the # of cards per page, ie: allCardsUrlPageCount = <allCardsUrlPageCountIdentifier pointing to total # of cards>/<allCardsUrlPageCountDivisor>.

allCardsUrlPageCountStartIndex is used to identify the first page of allCardsUrlPageCount.

If allCardsUrlPostBodyContent is set, CGS will make a POST to <allCardsUrl> with a JSON body that contains <allCardsUrlPostBodyContent>. If not set, CGS will just GET from <allCardsUrl>.

allCardsUrlRequestHeader and allCardsUrlRequestHeader can be used together for secured APIs.

If allCardsUrl points to file(s) enclosed by extra characters, set allCardsUrlWrapped to true, and CGS will trim the first and last characters.

If allCardsUrl points to zipped file(s), set allCardsUrlZipped to true, and CGS will unzip the file(s).

From allDecksUrl, CGS downloads the json that contains the Deck data for the game. If CGS is able to successfully download this file, it will save it as AllDecks.json.

If allDecksUrlDataIdentifier is set to a non-empty string, AllDecks.json will be parsed as a JSON object: {"@allDecksUrlDataIdentifier":{"$ref":"AllDecks.json"}}

If allDecksUrlPostBodyContent is set, CGS will make a POST to <allDecksUrl> with a JSON body that contains <allDecksUrlPostBodyContent>. If not set, CGS will just GET from <allDecksUrl>.

If allDecksUrlTxtRoot is set, CGS will parse deck urls as <allDecksUrlTxtRoot>+*DeckUrl:Txt*

From allSetsUrl, CGS downloads the json that contains the Set data for the game. If CGS is able to successfully download this json, it will save it as AllSets.json.

If allSetsUrl points to a file enclosed by extra characters, set allSetsUrlWrapped to true, and CGS will trim the first and last characters.

If allSetsUrl points to a zipped file, set allSetsUrlZipped to true, and CGS will unzip the file.

autoUpdate indicates how many days to use cached files instead of re-downloading. autoUpdate=0 will re-download files at every opportunity. autoUpdate<0 will never attempt to download anything.

autoUpdateUrl indicates the url from which users download *Game:Name*.json, and CGS will automatically re-download the custom game from this url every <autoUpdate> days. This url is used in the *Game:Id*. You should host *Game:Name*.json at this url, but if you do not, you can set autoUpdate to -1, and there should be no issues.

bannerImageFileType is the file type extension for the image file that CGS downloads from bannerImageUrl.

If bannerImageUrl is a valid url, CGS will download the image at that url and save it as Banner.<bannerImageFileType>. CGS will attempt to display the Banner.<bannerImageFileType> as an identifier to the user. If it is unable to read Banner.<bannerImageFileType>, CGS will simply display the CGS logo.

CGS will go through each CardBackFaceImageUrl and save the data from *CardBackFaceImageUrl:Url* to 'backs/*CardBackFaceImageUrl:Id*.<cardBackImageFileType>'

cardBackImageFileType is the file type extension for the image file that CGS downloads from cardBackImageUrl.

If cardBackImageUrl is a valid url, CGS will download the image at that url and save it as CardBack.<cardBackImageFileType>. CGS will display the CardBack.<cardBackImageFileType> when the user turns a card facedown or if CGS is unable to find the appropriate card image. If CGS is unable to get a custom card back, CGS will use the default CGS card back.

If cardDataIdentifier is set to a non-empty string, AllCards.json will be parsed as a JSON object: {"@cardDataIdentifier":{"$ref":"AllCards.json"}}

Every Card must have a unique id. When defining a Card in AllCards.json or AllSets.json, you can have the *Card:Id* mapped to the field defined by cardIdIdentifier. Most custom games will likely want to keep the default cardIdIdentifier. If cardIdStop is set, any id that contains cardIdStop will be stopped at <cardIdStop>.

cardImageFileType is the file type extension for the image files that CGS downloads for each individual Card.

cardImageProperty is the *Card:Property* which points to the image for this Card. If <cardImageProperty> is empty, <cardImageUrl> will be used instead.

cardImageUrl is a parameterized template url from which CGS downloads card image files if <cardImageProperty> is empty. Parameters: {cardId}=*Card:Id*, {cardName}=*Card:Name*, {cardSet}=*Card:SetCode*, {cardImageFileType}=<cardImageFileType>, {<property>}=*Card:<property>*. Example: https://www.cardgamesimulator.com/games/Standard/sets/{cardSet}/{cardId}.{cardImageFileType}

When defining a Card in AllCards.json or AllSets.json, you can have the *Card:Name* of the back face mapped to the field defined by cardNameBackIdentifier. Most custom games will likely want to keep the default cardNameBackIdentifier.

When defining a Card in AllCards.json or AllSets.json, you can have the *Card:Name* mapped to the field defined by cardNameIdentifier. Most custom games will likely want to keep the default cardNameIdentifier.

If cardNameIsUnique is true, different Cards are not allowed to have the same *Card:Name*. Cards with the same name will be treated as reprints, with the option to hide reprints available. If cardNameIsUnique is false, DeckFileType.Txt will require <deckFileTxtId> for every Card.

The cardPrimaryProperty is the *Card:Property* that is first selected and displayed in the Card Viewer, which appears whenever a user selects a card.

cardProperties defines the name keys for *Card:Property*s. The values should be mapped in AllCards.json or AllSets.json.

When defining a Card in AllCards.json or AllSets.json, you can integrate objectEnum and objectEnumList properties with enums by using cardPropertyIdentifier. Most custom games will likely want to keep the default cardPropertyIdentifier.

Cards will be rotated <cardRotationDefault> degrees, unless you override with cardRotationIdentifier. Most custom games will likely want to keep the default cardRotationDefault.

When defining a Card in AllCards.json or AllSets.json, you can set <cardRotationIdentifier> to an int field that indicates the rotation of a card in degrees. If left blank or missing, cards will be rotated <cardRotationDefault> degrees.

When defining a Card in AllCards.json, you can have the *Card:SetCode* mapped to the field defined by cardSetIdentifier. If the mapping is missing, CGS will use <setCodeDefault>. Most custom games will likely want to keep the default cardSetIdentifier.

If cardSetIsObject is set to true, <cardSetIdentifier> should point to an object (or list of objects) that follows the rules for AllSets.json.

When defining a Card in AllCards.json, you can have the *Card:SetCode* mapped to the field defined by cardSetIdentifier. That Set's name can be defined by cardSetNameIdentifier.

If cardSetInList is set to true, Cards will be duplicated for each Set in <cardSetIdentifier>.

If cardSetsInListIsCsv is set to true, Cards will be duplicated for each Set found in the comma-separated list of <cardSetIdentifier>.

cardSize indicates a card's width and height in inches.

cgsGamesLink is a clickable url that will take the user directly to this game on the CGS Games website, which can be shared between users.

copyright indicates the legal owner of this Card Game. CGS will display this value in the bottom-left corner of the Main Menu.

When saving or loading a deck with <deckFileType> NOT txt, deckFileAltId refers to the *Card:Property* used to uniquely identify each Card. For hsd, this is stored as a varint within the deck string.

When saving a deck as txt, different Cards may share the same name, and if they do, the *Card:<deckFileTxtId>* will be used to uniquely identify Cards.

When saving a deck, the formatting for how it is saved and loaded is defined by the deckFileType. dec refers to the old MTGO deck file format. hsd refers to the Hearthstone deck string format. ydk refers to the YGOPRO deck file format. txt parses each line for the following: <Quantity> [*Card:Id*] *Card:Name* (*Card:SetCode*).

deckPlayCards indicates cards that should automatically be played when a player loads a deck in Play Mode.

For networked games, CGS will use deckSharePreference to: ask players if they want to share the same deck, force all players to share the same deck, or force an individual deck for each player.

CGS will go through each DeckUrl and save the data from *DeckUrl:Url* to 'decks/*DeckUrl:Name*.<deckFileType>'

The value is displayed to the user through the UI while the keys remain hidden. If the keys are entered as a hexadecimal integers (prefixed with 0x), multiple values can go through bitwise and/ors to have a single enumValue represent multiple values. The multiple values would be displayed together to the user, using | as the delimiter.

Describes extra cards separate from the main deck: The hsd deckFileType treats all extra cards as Heroes, and the ydk deckFileType treats all extra cards as extra deck cards.

gameBoardImageFileType is the file type extension for the image files that CGS downloads for each game board.

CGS will go through each GameBoardUrl and save the data from *GameBoardUrl:Url* to 'boards/*GameBoardUrl:Id*.<gameBoardImageFileType>'

gameCardRotationDegrees indicates how many degrees to rotate Cards in Play Mode.

If possible, CGS will take the gameDefaultCardAction when a Card is double-clicked in Play Mode.

gamePlayDeckName is the name of the card stack shown when a player loads a deck. If <gamePlayDeckName> is empty, the *Deck:Name* is used.

Each deck loaded during a game will be loaded to its corresponding position in gamePlayDeckPositions. The first deck loaded will go to the first position, second to second, etc.

gamePlayZones will appear in the Play Area in Play Mode.

gameStartDecks indicates decks that should automatically be loaded when a player starts playing in Play Mode.

gameStartHandCount indicates how many cards are automatically dealt from a loaded deck to a player's hand.

gameStartPointsCount indicates how many points are automatically assigned to each player.

playMatImageFileType is the file type extension for the image file that CGS downloads from playMatImageUrl.

If playMatImageUrl is a valid url, CGS will download the image at that url and save it as PlayMat.<playMatImageFileType>. CGS will use the PlayMat.<playMatImageFileType> as the background image while in Play Mode. If CGS is unable to get this image, CGS will use the default table image.

playMatSize indicates the width and height in inches of the play area in Play Mode.

playMatGridCellSize indicates the width and height in inches of each cell in the play area in Play Mode.

rulesUrl should link to this game's online rulebook.

When defining a Set in AllSets.json, you can also define Cards to include in that Set by indicating them with setCardsIdentifier. Most custom games will likely want to keep the default setCardsIdentifier.

When defining a Set in AllSets.json, you can also define Cards to include in that Set by indicating them with SetCardsUrlIdentifier. Most custom games will likely want to keep the default SetCardsUrlIdentifier.

If a Card does not specify its Set, it will be included in the Set with *Set:Code* specified by setCodeDefault. This Set's name is specified by setNameDefault.

When defining a Set in AllSets.json, you can have the *Set:Code* mapped to the field defined by setCodeIdentifier. Most custom games will likely want to keep the default setCodeIdentifier.

If setDataIdentifier is set to a non-empty string, AllSets.json will be parsed as a JSON object: {"@setDataIdentifier":{"$ref":"AllSets.json"}}

When defining a Set in AllSets.json, you can have the *Set:Name* mapped to the field defined by setNameIdentifier. If the mapping is missing, CGS will use the *Set:Code*. Most custom games will likely want to keep the default setNameIdentifier.

The id of the card back

The url from which to download the card back

The name of the property: This name can be referenced to lookup a Card's property

The type of the property

The name of the property as it is displayed to the end user

The value to display if the value is null or empty

List <displayEmpty> as the first option if this property is an enum?

If this property is a stringList or stringEnumList, the value will be delimited by this delimiter

If the Card is a back Face: This name can be referenced to lookup a Card's property

If the Card is a front Face: This name can be referenced to lookup a Card's property

String EscapedString Integer Boolean Object StringEnum StringList StringEnumList ObjectEnum ObjectList ObjectEnumList

string escapedString integer boolean object stringEnum stringList stringEnumList objectEnum objectList objectEnumList

CGS will automatically play the Card that matches cardQuery, when the player loads a Deck in Play Mode matching deckQuery

Indicates the played Card's position in inches

Indicates the played Card's rotation in degrees

The name of the deck

An optional path that can be used to override the url. See @cgs.json#/properties/allDecksUrlTxtRoot

The url from which to download the deck

Optionally set to false to ignore this deck url

Refers to a *Property:Name* in <cardProperties>

Dictionary with string key-value pairs

A group of extra cards is displayed together with this label in Play Mode

If *Card:Properties[ExtraDef:Property]* equals *ExtraDef:Value*, then that card will be moved from the main deck to this extra deck

When a deck is loaded in Play Mode, any card with *Card:Id* = *Card* will cause *Boards* to be put into the play area.

The id of the board

Indicates the position (in inches) of the bottom-left corner

Indicates the board's width and height in inches

The id of the board

The url from which to download the board image

When a Card enters the Game Play Zone, the Card will display this face

If possible, CGS will take the defaultCardAction when a Card is double-clicked in the Game Play Zone. If null, defaults to <gameDefaulCardAction>

Indicates the Game Play Zone's position in inches

Indicates the Game Play Zone's rotation in degrees

Indicates the Game Play Zone's width and height in inches

The Game Play Zone type from area, horizontal, or vertical

Provide a JSON object that satisfies the schema "CGS Card Game Specification". Here are the required top‑level fields: name. Return only the valid JSON object.


[System]
You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:
<schema>
{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"Context":{"title":"Context","description":"Represents contexts of projects.","type":"object","required":["name","version","url"],"properties":{"name":{"description":"The name of the project.","$ref":"#/$defs/NonEmptyString"},"version":{"description":"The version of the project.","$ref":"#/$defs/NonEmptyString"},"url":{"description":"The URL of the project.","$ref":"#/$defs/NonEmptyString"}},"additionalProperties":false},"Paths":{"title":"Paths","description":"Specifies locations of fragments and the changelog.","type":"object","properties":{"directory":{"description":"The directory containing fragments.","$ref":"#/$defs/NonEmptyString","default":"changes"},"output":{"description":"The file containing the changelog.","$ref":"#/$defs/NonEmptyString","default":"CHANGELOG.md"}},"additionalProperties":false},"NonEmptyString":{"type":"string","minLength":1},"Start":{"description":"Marks the location in the changelog to start writing entries after.","$ref":"#/$defs/NonEmptyString"},"Level":{"type":"integer","minimum":1},"Levels":{"title":"Levels","description":"Defines which heading levels to use.","type":"object","properties":{"entry":{"description":"The heading level of the entry title.","$ref":"#/$defs/Level","default":2},"section":{"description":"The heading level of individual sections.","$ref":"#/$defs/Level","default":3}},"additionalProperties":false},"Character":{"type":"string","minLength":1,"maxLength":1},"Indents":{"title":"Indents","description":"Specifies which characters to use for indenting.","type":"object","properties":{"heading":{"description":"The character to use for headings.","$ref":"#/$defs/Character","default":"#"},"bullet":{"description":"The character to use for indenting.","$ref":"#/$defs/Character","default":"-"}},"additionalProperties":false},"Formats":{"title":"Formats","description":"Defines formats to use for rendering entry titles and fragments.","type":"object","properties":{"title":{"description":"The format used for rendering entry titles.","$ref":"#/$defs/NonEmptyString","default":"{{version}} ({{date}})"},"fragment":{"description":"The format used for rendering fragments.","$ref":"#/$defs/NonEmptyString","default":"{{content}} (#{{id}})"}},"additionalProperties":false},"Wrap":{"type":"integer","minimum":1},"Order":{"description":"Defines which types to include, and in what order.","type":"array","items":{"description":"The type to include.","$ref":"#/$defs/NonEmptyString"}},"Types":{"title":"Types","description":"Maps types to their titles.","type":"object","patternProperties":{"^.+$":{"$ref":"#/$defs/NonEmptyString"}},"additionalProperties":false}},"title":"changelogging","description":"changelogging configuration file.","type":"object","required":["context"],"properties":{"context":{"$ref":"#/$defs/Context"},"paths":{"$ref":"#/$defs/Paths"},"start":{"$ref":"#/$defs/Start","default":"<!-- changelogging: start -->"},"levels":{"$ref":"#/$defs/Levels"},"indents":{"$ref":"#/$defs/Indents"},"formats":{"$ref":"#/$defs/Formats"},"wrap":{"$ref":"#/$defs/Wrap","default":100},"order":{"$ref":"#/$defs/Order","default":["security","feature","change","fix","deprecation","removal","internal"]},"types":{"$ref":"#/$defs/Types","default":{"security":"Security","feature":"Features","change":"Changes","fix":"Fixes","deprecation":"Deprecations","removal":"Removals","internal":"Internal"}}},"additionalProperties":false}
</schema>

[User] Provide a JSON object that satisfies the schema "changelogging". Here are the required top‑level fields: context. Return only the valid JSON object.

Context

Represents contexts of projects.

The name of the project.

The version of the project.

The URL of the project.

Paths

Specifies locations of fragments and the changelog.

The directory containing fragments.

The file containing the changelog.

Marks the location in the changelog to start writing entries after.

Levels

Defines which heading levels to use.

The heading level of the entry title.

The heading level of individual sections.

Indents

Specifies which characters to use for indenting.

The character to use for headings.

The character to use for indenting.

Formats

Defines formats to use for rendering entry titles and fragments.

The format used for rendering entry titles.

The format used for rendering fragments.

Defines which types to include, and in what order.

The type to include.

Types

Maps types to their titles.

changelogging

changelogging configuration file.

security feature change fix deprecation removal internal

Provide a JSON object that satisfies the schema "changelogging". Here are the required top‑level fields: context. Return only the valid JSON object.


[System]
You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:
<schema>
{"$schema":"http://json-schema.org/draft-07/schema#","title":"build-changelog","description":"Schema for changelog files.","type":"object","properties":{"added":{"$ref":"#/definitions/change_entry","description":"Changes where you add to the project."},"changed":{"$ref":"#/definitions/change_entry","description":"Changes where you changed functionality."},"removed":{"$ref":"#/definitions/change_entry","description":"Changes where you removed a feature or something else."},"fixed":{"$ref":"#/definitions/change_entry","description":"Changes where you fixed a bug."},"security":{"$ref":"#/definitions/change_entry","description":"Changes where you made an update for security reasons."},"deprecated":{"$ref":"#/definitions/change_entry","description":"Changes where you plan on removing something, but are waiting to do so."},"version":{"type":"string","description":"The current version of the project. If left off this will fallback to being `Unreleased`."},"release_date":{"type":"string","description":"The release date of the current version. If this is property is not defined this will fall back to `TBD`."},"notice":{"type":"string","description":"A notice for the current release."},"change":{"type":"string","enum":["major","minor","patch"],"description":"The type of change you are creating. Valid values are `major` | `minor` | `patch`"}},"definitions":{"simple_change_entry":{"type":"array","description":"This is a simple change entry.","items":{"type":"string","description":"Simple change entry."}},"breaking_change_entry":{"type":"object","description":"The main release object","properties":{"breaking":{"type":"array","description":"The change entry messages.","items":{"type":"string","description":"The change entry message."},"additionalProperties":false}}},"complex_change_entry":{"type":"array","items":{"type":"object","properties":{"message":{"description":"The change entry message.","type":"string"},"flag":{"description":"The flag to add a prefix to the changes.","type":"string"},"references":{"type":"array","description":"List of references to this current change.","items":{"type":"object","properties":{"type":{"description":"The type of reference, can be `pull_request`,`pr`, or `issue`","type":"string","enum":["pull_request","issue"]},"number":{"description":"The pull request or issue number","type":"number"}}}}}}},"change_entry":{"anyOf":[{"$ref":"#/definitions/simple_change_entry"},{"$ref":"#/definitions/complex_change_entry"},{"$ref":"#/definitions/breaking_change_entry"}]}}}
</schema>

[User] Provide a JSON object that satisfies the schema "build-changelog". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.

build-changelog

Schema for changelog files.

Changes where you add to the project.

Changes where you changed functionality.

Changes where you removed a feature or something else.

Changes where you fixed a bug.

Changes where you made an update for security reasons.

Changes where you plan on removing something, but are waiting to do so.

The current version of the project. If left off this will fallback to being `Unreleased`.

The release date of the current version. If this is property is not defined this will fall back to `TBD`.

A notice for the current release.

The type of change you are creating. Valid values are `major` | `minor` | `patch`

This is a simple change entry.

Simple change entry.

The main release object

The change entry messages.

The change entry message.

The change entry message.

The flag to add a prefix to the changes.

List of references to this current change.

The type of reference, can be `pull_request`,`pr`, or `issue`

The pull request or issue number

Provide a JSON object that satisfies the schema "build-changelog". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.


[System]
You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:
<schema>
{"$defs":{"AnalysisConfig":{"additionalProperties":false,"description":"Definition of `analysis` configuration.","properties":{"ignore":{"$ref":"#/$defs/Ignore","default":{"attributes":[],"linters":[]}}},"title":"AnalysisConfig","type":"object"},"Base":{"additionalProperties":false,"description":"Represents a base.","properties":{"name":{"title":"Name","type":"string"},"channel":{"title":"Channel","type":"string"},"architectures":{"default":["amd64"],"items":{"type":"string"},"title":"Architectures","type":"array"}},"required":["name","channel"],"title":"Base","type":"object"},"BasesCharm":{"additionalProperties":false,"description":"A charm using the deprecated ``bases`` keyword.\n\nThis type of charm only supports the following bases:\n    - Ubuntu 18.04\n    - Ubuntu 20.04\n    - Ubuntu 22.04\n    - CentOS 7\n    - Alma Linux 9","properties":{"name":{"description":"The name of the project on Charmhub.\n\nThis value will be used both in the URL of the charm on Charmhub and when\ndeploying the charm with juju.\n\nCharms should follow the\n`charm naming guidelines <https://juju.is/docs/sdk/naming>`_.","examples":["mysql","mysql-k8s"],"maxLength":40,"minLength":1,"pattern":"^([a-z0-9][a-z0-9-]?)*[a-z]+([a-z0-9-]?[a-z0-9])*$","title":"Project Name","type":"string"},"title":{"anyOf":[{"description":"A human-readable title.","examples":["Ubuntu Linux","Jupyter Lab Desktop","LXD","DigiKam","Apache Kafka","MySQL Router K8s charm"],"maxLength":40,"minLength":2,"title":"Title","type":"string"},{"type":"null"}],"default":null,"title":"Title"},"version":{"const":"unversioned","default":"unversioned","title":"Version","type":"string"},"summary":{"description":"A brief (one-line) summary of your charm.","maxLength":200,"title":"Summary","type":"string"},"description":{"description":"A multi-line summary of your charm.","title":"Description","type":"string"},"base":{"default":null,"title":"Base","type":"null"},"build-base":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Build-Base"},"platforms":{"default":null,"title":"Platforms","type":"null"},"contact":{"default":null,"title":"Contact","type":"null"},"issues":{"default":null,"title":"Issues","type":"null"},"source-code":{"default":null,"title":"Source-Code","type":"null"},"license":{"default":null,"title":"License","type":"null"},"adopt-info":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Adopt-Info"},"parts":{"additionalProperties":{"additionalProperties":true,"type":"object"},"default":{"charm":{"plugin":"charm","source":"."}},"description":"Configures the various mechanisms to obtain, process and prepare data from\ndifferent sources that end up being a part of the final charm.\n\nKeys are user-defined part names. The value of each key is a map where keys\nare part names.\n\nExample::\n\n    parts:\n      libs:\n        plugin: dump\n        source: /usr/local/lib/\n        organize:\n          \"libxxx.so*\": lib/\n        prime:\n          - lib/","title":"Parts","type":"object"},"package-repositories":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"default":null,"title":"Package-Repositories"},"type":{"const":"charm","title":"Type","type":"string"},"analysis":{"anyOf":[{"$ref":"#/$defs/AnalysisConfig"},{"type":"null"}],"default":null,"description":"How analysis done on the charm will behave.\n\nCurrently the only options are to ignore attributes or linters."},"charmhub":{"anyOf":[{"$ref":"#/$defs/Charmhub"},{"type":"null"}],"default":null,"deprecated":true,"description":"(DEPRECATED): Configuration for accessing charmhub."},"charm-libs":{"items":{"$ref":"#/$defs/CharmLib"},"title":"List of libraries to use for this charm","type":"array"},"actions":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"description":"Defines one or more actions.\n\nThis key is equivalent to the\n`actions.yaml file <https://juju.is/docs/sdk/actions-yaml>`_.","title":"Actions"},"assumes":{"anyOf":[{"items":{"anyOf":[{"type":"string"},{"additionalProperties":{"anyOf":[{"items":{},"type":"array"},{"additionalProperties":true,"type":"object"}]},"type":"object"}]},"type":"array"},{"type":"null"}],"default":null,"description":"Explicitly state features a Juju model must be able to provide for a\nsuccessful deployment of this charm. When a charm includes such\nrequirements, Juju performs a pre-deployment check and displays\nuser-friendly error messages if a feature requirement cannot be met by the\nmodel that the user is trying to deploy the charm to. If the assumes\nsection of the charm metadata is omitted, Juju will make a best-effort\nattempt to deploy the charm, and users must rely on the output of\n``juju status`` to figure out whether the deployment was successful.\n\nThe key consists of a list of features that can be given either directly\nor, depending on the complexity of the condition you want to enforce,\nnested under one or both of the boolean expressions any-of or all-of,\nas shown below. In order for a charm to be deployed, all entries in the\nassumes block must be satisfied.\n\nStructure::\n\n    assumes:\n      - <feature-1>\n      - any-of:\n        - <feature-2>\n        - <feature-3>\n      - all-of:\n        - <feature-4>\n        - <feature-5>\n\nJuju version requirements can be specified with a string such as\n``juju >= 3.5`` or ``juju < 4.0``. A full list of supported features\ncan be found in the\n`Juju documentation <https://juju.is/docs/juju/supported-features>`_.\n","title":"Assumes"},"charm-user":{"anyOf":[{"enum":["root","sudoer","non-root"],"type":"string"},{"type":"null"}],"default":null,"description":"Specifies that the charm code does not need to be run as root. Possible\nvalues are:\n\n- ``root``: the charm will run as root\n- ``sudoer``: the charm will run as a non-root user with access to root\n  privileges using ``sudo``.\n- ``non-root``: the charm will run as a non-root user without ``sudo``.\n\nOnly affects Kubernetes charms on Juju 3.6.0 or later. If not specified,\nJuju will use\n`its default behaviour <https://juju.is/docs/sdk/metadata-yaml#heading--charm-user>`_.\n","title":"Charm-User"},"containers":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"description":"Define a map of containers to be created adjacent to the charm (as a\nsidecar, in the same pod).\n\nThis is required for Kubernetes charms.\n\nThis key consists of a dictionary mapping container names to their\nspecifications. Each container can be specified in terms of ``resource``,\n``bases`` and ``mounts``, where one of either the ``resource`` or the\n``bases`` subkeys must be defined and ``mounts`` is optional.\n\n- ``resource`` is the name of an OCI image resource used to create the\n  container (that you will then define further in the resources block).\n- ``bases`` is a list of bases to be used for resolving a container image,\n  in descending order of preference. To use it, specify a base name (for\n  example, ``ubuntu`` or ``centos``), a ``channel`` and an\n  ``architecture``.\n- ``mounts`` is a list of mounted storage volumes for this container. To\n  use it, specify the name of the storage to mount from the charm\n  storage and, optionally, the location where to mount the storage.\n\nStructure::\n\n    containers:\n      <container name>:\n        resource: <resource name>\n        bases:\n          - name: <base name>\n            channel: <track[/risk][/branch]>\n            architectures:\n              - <architecture>\n        mounts:\n          - storage: <storage name>\n            location: <path>","examples":[{"super-app":{"mounts":[{"location":"/logs","storage":"logs"}],"resource":"super-app-image"}}],"title":"Containers"},"devices":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"description":"Devices the charm needs.\n\nStructure::\n\n    devices:\n      <device name>:\n        type: gpu | nvidia.com/gpu | amd.com/gpu\n        description: <Optional description>\n        countmin: <Optional minimum number requested>\n        countmax: <Optional maximum number requested>","examples":[{"amd-gpu":{"countmax":100,"countmin":1,"description":"Some sweet AMD GPU","type":"amd.com/gpu"},"nvidia-gpu":{"countmin":20,"description":"Some NVIDIA GPUs","type":"nvidia.com/gpu"}},{"gpus":{"countmax":40,"countmin":2,"description":"A bunch of GPUs","type":"gpu"}}],"title":"Devices"},"extra-bindings":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"description":"A key-only mapping representing extra bindings needed.","title":"Extra-Bindings"},"peers":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"description":"A map of peer relations.\n\nStructure::\n\n    peers:\n      <endpoint name>:\n        interface: <Required interface name>\n        limit: <Optional: maximum number of supported connections\n        optional: <Informational only - whether the relation is required.>\n        scope: <\"global\" or \"container\" - the relation scope.>\n\nFor more information, see\n`the Juju documentation <https://juju.is/docs/juju/relation>`_.","examples":[{"friend":{"interface":"life","limit":150,"optional":true,"scope":"container"}}],"title":"Peers"},"provides":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"description":"A map of interfaces this charm provides.\n\nStructure::\n\n    provides:\n      <endpoint name>:\n        interface: <Required interface name>\n        limit: <Optional: maximum number of supported connections\n        optional: <Informational only - whether the relation is required.>\n        scope: <\"global\" or \"container\" - the relation scope.>\n\nFor more information, see\n`the Juju documentation <https://juju.is/docs/juju/relation>`_.","examples":[{"self":{"interface":"identity"}}],"title":"Provides"},"requires":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"description":"A map of relations this charm requires.\n\nStructure::\n\n    requires:\n      <endpoint name>:\n        interface: <Required interface name>\n        limit: <Optional: maximum number of supported connections\n        optional: <Informational only - whether the relation is required.>\n        scope: <\"global\" or \"container\" - the relation scope.>\n\nFor more information, see\n`the Juju documentation <https://juju.is/docs/juju/relation>`_.","examples":[{"parent":{"interface":"birth","limit":2,"optional":false,"scope":"global"}}],"title":"Requires"},"resources":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"description":"A mapping of resources that accompany the charm.\n\nSee first: `Juju | Charm resource <https://juju.is/docs/juju/charm-resource>`_\n\nEach resource is made available when the charm is deployed. NOTE:\nKubernetes charms must declare an ``oci-image`` type resource for each\ncontainer declared in ``containers``.\n\nStructure::\n\n    # (Optional) Additional resources that accompany the charm\n    resources:\n      <resource name>:\n        # (Required) The type of the resource\n        type: file | oci-image\n\n        # (Optional) Description of the resource and its purpose\n        description: <description>\n\n        # (Required: when type:file) The filename of the resource as it\n        # should appear in the filesystem.\n        filename: <filename>","examples":[{"water":{"filename":"/dev/h2o","type":"file"}},{"super-app-image":{"description":"My app!","type":"oci-image"}}],"title":"Resources"},"storage":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"description":"Storage devices requested by the charm.\n\nStructure::\n\n    storage:\n      # Each key represents the name of the storage\n      <storage name>:\n\n        # (Required) Type of the requested storage\n        type: filesystem | block\n\n        # (Optional) Description of the storage requested\n        description: <description>\n\n        # (Optional) The mount location for filesystem stores. For\n        # multi-stores the location acts as the parent directory for each\n        # mounted store.\n        location: <location>\n\n        # Indicates if the storage should be made read-only (where\n        # possible). Defaults to false\n        read-only: true | false\n\n        # (Optional) The number of storage instances to be requested\n        multiple:\n          range: <n> | <n>-<m> | <n>- | <n>+\n\n        # (Optional) Minimum size of requested storage in forms G, GiB, GB.\n        # Size multipliers are M, G, T, P, E, Z or Y. With no multiplier\n        # supplied, M is implied.\n        minimum-size: <n> | <n><multiplier>\n\n        # (Optional) List of properties, only supported value is \"transient\"\n        properties:\n          - transient\n","examples":[{"jbod":{"description":"A block storage to use as swap space","properties":["transient"],"type":"block"}}],"title":"Storage"},"subordinate":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"Optional boolean to declare the charm subordinate.","examples":[true],"title":"Subordinate"},"terms":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"default":null,"description":"A list of terms to which the user agree by using the charm.\nThese terms are not enforced by the charm, Juju or Canonical.","examples":["Post cat pictures on Mastodon","Tag your cat pictures with #caturday"],"title":"Terms"},"links":{"anyOf":[{"$ref":"#/$defs/Links"},{"type":"null"}],"default":null,"description":"(Recommended) Links to various additional information used by Charmhub.","examples":[{"contact":"Please send your answer to Old Pink, care of the Funny Farm, Chalfont","documentation":"https://discourse.charmhub.io/t/traefik-k8s-docs-index/10778","issues":"https://github.com/canonical/traefik-k8s-operator/issues","source":"https://github.com/canonical/traefik-k8s-operator","website":"https://charmed-kubeflow.io/"}]},"config":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"description":"One or more configuration options for your charm.\n\nStructure::\n\n    config:\n      options:\n        # Each option name is the name by which the charm will query the option.\n        <option name>:\n          # (Required) The type of the option\n          type: string | int | float | boolean | secret\n          # (Optional) The default value of the option\n          default: <a reasonable default value of the same type as the option>\n          # (Optional): A string describing the option. Also appears on charmhub.io\n          description: <description string>","examples":[{"options":{"name":{"default":"Wiki","description":"The name or title of the Wiki","type":"string"},"skin":{"default":"vector","description":"Skin to use for the wiki","type":"string"}}}],"title":"Config"},"bases":{"items":{"$ref":"#/$defs/BasesConfiguration"},"minItems":1,"title":"Bases","type":"array"}},"required":["name","summary","description","type","bases"],"title":"BasesCharm","type":"object"},"BasesConfiguration":{"additionalProperties":false,"description":"Definition of build-on/run-on combinations.\n\nExample::\n\n    bases:\n      - build-on:\n          - name: ubuntu\n            channel: \"20.04\"\n            architectures: [amd64, arm64]\n        run-on:\n          - name: ubuntu\n            channel: \"20.04\"\n            architectures: [amd64, arm64]\n          - name: ubuntu\n            channel: \"22.04\"\n            architectures: [amd64, arm64]","properties":{"build-on":{"items":{"$ref":"#/$defs/Base"},"title":"Build-On","type":"array"},"run-on":{"items":{"$ref":"#/$defs/Base"},"title":"Run-On","type":"array"}},"required":["build-on","run-on"],"title":"BasesConfiguration","type":"object"},"CharmLib":{"additionalProperties":false,"description":"A Charm library dependency for this charm.","properties":{"lib":{"pattern":"[a-z][a-z0-9_-]+\\.[a-z][a-z0-9_]+","title":"Library Path (e.g. my-charm.my_library)","type":"string"},"version":{"pattern":"[0-9]+(\\.[0-9]+)?","title":"Version filter for the charm. Either an API version or a specific [api].[patch].","type":"string"}},"required":["lib","version"],"title":"CharmLib","type":"object"},"Charmhub":{"additionalProperties":false,"description":"Definition of Charmhub endpoint configuration.","properties":{"api-url":{"default":"https://api.charmhub.io","format":"uri","maxLength":2083,"minLength":1,"title":"Api-Url","type":"string"},"storage-url":{"default":"https://storage.snapcraftcontent.com","format":"uri","maxLength":2083,"minLength":1,"title":"Storage-Url","type":"string"},"registry-url":{"default":"https://registry.jujucharms.com","format":"uri","maxLength":2083,"minLength":1,"title":"Registry-Url","type":"string"}},"title":"Charmhub","type":"object"},"Ignore":{"additionalProperties":false,"description":"Definition of `analysis.ignore` configuration.","properties":{"attributes":{"default":[],"items":{"type":"string"},"title":"Attributes","type":"array"},"linters":{"default":[],"items":{"type":"string"},"title":"Linters","type":"array"}},"title":"Ignore","type":"object"},"Links":{"additionalProperties":false,"description":"Definition of `links` in metadata.","properties":{"contact":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"default":null,"title":"Contact"},"documentation":{"anyOf":[{"format":"uri","minLength":1,"type":"string"},{"type":"null"}],"default":null,"title":"Documentation"},"issues":{"anyOf":[{"format":"uri","minLength":1,"type":"string"},{"items":{"format":"uri","minLength":1,"type":"string"},"type":"array"},{"type":"null"}],"default":null,"title":"Issues"},"source":{"anyOf":[{"format":"uri","minLength":1,"type":"string"},{"items":{"format":"uri","minLength":1,"type":"string"},"type":"array"},{"type":"null"}],"default":null,"title":"Source"},"website":{"anyOf":[{"format":"uri","minLength":1,"type":"string"},{"items":{"format":"uri","minLength":1,"type":"string"},"type":"array"},{"type":"null"}],"default":null,"title":"Website"}},"title":"Links","type":"object"},"Platform":{"additionalProperties":false,"description":"Project platform definition.","properties":{"build-on":{"anyOf":[{"items":{"type":"string"},"minItems":1,"type":"array","uniqueItems":true},{"type":"null"}],"title":"Build-On"},"build-for":{"anyOf":[{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},{"type":"null"}],"default":null,"title":"Build-For"}},"required":["build-on"],"title":"Platform","type":"object"},"PlatformCharm":{"additionalProperties":false,"description":"Model for defining a charm using Platforms.","properties":{"name":{"description":"The name of the project on Charmhub.\n\nThis value will be used both in the URL of the charm on Charmhub and when\ndeploying the charm with juju.\n\nCharms should follow the\n`charm naming guidelines <https://juju.is/docs/sdk/naming>`_.","examples":["mysql","mysql-k8s"],"maxLength":40,"minLength":1,"pattern":"^([a-z0-9][a-z0-9-]?)*[a-z]+([a-z0-9-]?[a-z0-9])*$","title":"Project Name","type":"string"},"title":{"anyOf":[{"description":"A human-readable title.","examples":["Ubuntu Linux","Jupyter Lab Desktop","LXD","DigiKam","Apache Kafka","MySQL Router K8s charm"],"maxLength":40,"minLength":2,"title":"Title","type":"string"},{"type":"null"}],"default":null,"title":"Title"},"version":{"const":"unversioned","default":"unversioned","title":"Version","type":"string"},"summary":{"description":"A brief (one-line) summary of your charm.","maxLength":200,"title":"Summary","type":"string"},"description":{"description":"A multi-line summary of your charm.","title":"Description","type":"string"},"base":{"anyOf":[{"enum":["ubuntu@18.04","ubuntu@20.04","ubuntu@22.04","ubuntu@24.04","ubuntu@24.10","ubuntu@25.04","ubuntu@25.10","centos@7","almalinux@9"],"type":"string"},{"type":"null"}],"default":null,"title":"Base"},"build-base":{"anyOf":[{"enum":["ubuntu@18.04","ubuntu@20.04","ubuntu@22.04","ubuntu@24.04","ubuntu@24.10","ubuntu@25.04","ubuntu@25.10","centos@7","almalinux@9"],"type":"string"},{"const":"ubuntu@devel","type":"string"},{"type":"null"}],"default":null,"title":"Build-Base"},"platforms":{"additionalProperties":{"anyOf":[{"$ref":"#/$defs/Platform"},{"type":"null"}]},"title":"Platforms","type":"object"},"contact":{"default":null,"title":"Contact","type":"null"},"issues":{"default":null,"title":"Issues","type":"null"},"source-code":{"default":null,"title":"Source-Code","type":"null"},"license":{"default":null,"title":"License","type":"null"},"adopt-info":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Adopt-Info"},"parts":{"additionalProperties":{"additionalProperties":true,"type":"object"},"description":"Configures the various mechanisms to obtain, process and prepare data from\ndifferent sources that end up being a part of the final charm.\n\nKeys are user-defined part names. The value of each key is a map where keys\nare part names.\n\nExample::\n\n    parts:\n      libs:\n        plugin: dump\n        source: /usr/local/lib/\n        organize:\n          \"libxxx.so*\": lib/\n        prime:\n          - lib/","minProperties":1,"title":"Parts","type":"object"},"package-repositories":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"default":null,"title":"Package-Repositories"},"type":{"const":"charm","title":"Type","type":"string"},"analysis":{"anyOf":[{"$ref":"#/$defs/AnalysisConfig"},{"type":"null"}],"default":null,"description":"How analysis done on the charm will behave.\n\nCurrently the only options are to ignore attributes or linters."},"charmhub":{"anyOf":[{"$ref":"#/$defs/Charmhub"},{"type":"null"}],"default":null,"deprecated":true,"description":"(DEPRECATED): Configuration for accessing charmhub."},"charm-libs":{"items":{"$ref":"#/$defs/CharmLib"},"title":"List of libraries to use for this charm","type":"array"},"actions":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"description":"Defines one or more actions.\n\nThis key is equivalent to the\n`actions.yaml file <https://juju.is/docs/sdk/actions-yaml>`_.","title":"Actions"},"assumes":{"anyOf":[{"items":{"anyOf":[{"type":"string"},{"additionalProperties":{"anyOf":[{"items":{},"type":"array"},{"additionalProperties":true,"type":"object"}]},"type":"object"}]},"type":"array"},{"type":"null"}],"default":null,"description":"Explicitly state features a Juju model must be able to provide for a\nsuccessful deployment of this charm. When a charm includes such\nrequirements, Juju performs a pre-deployment check and displays\nuser-friendly error messages if a feature requirement cannot be met by the\nmodel that the user is trying to deploy the charm to. If the assumes\nsection of the charm metadata is omitted, Juju will make a best-effort\nattempt to deploy the charm, and users must rely on the output of\n``juju status`` to figure out whether the deployment was successful.\n\nThe key consists of a list of features that can be given either directly\nor, depending on the complexity of the condition you want to enforce,\nnested under one or both of the boolean expressions any-of or all-of,\nas shown below. In order for a charm to be deployed, all entries in the\nassumes block must be satisfied.\n\nStructure::\n\n    assumes:\n      - <feature-1>\n      - any-of:\n        - <feature-2>\n        - <feature-3>\n      - all-of:\n        - <feature-4>\n        - <feature-5>\n\nJuju version requirements can be specified with a string such as\n``juju >= 3.5`` or ``juju < 4.0``. A full list of supported features\ncan be found in the\n`Juju documentation <https://juju.is/docs/juju/supported-features>`_.\n","title":"Assumes"},"charm-user":{"anyOf":[{"enum":["root","sudoer","non-root"],"type":"string"},{"type":"null"}],"default":null,"description":"Specifies that the charm code does not need to be run as root. Possible\nvalues are:\n\n- ``root``: the charm will run as root\n- ``sudoer``: the charm will run as a non-root user with access to root\n  privileges using ``sudo``.\n- ``non-root``: the charm will run as a non-root user without ``sudo``.\n\nOnly affects Kubernetes charms on Juju 3.6.0 or later. If not specified,\nJuju will use\n`its default behaviour <https://juju.is/docs/sdk/metadata-yaml#heading--charm-user>`_.\n","title":"Charm-User"},"containers":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"description":"Define a map of containers to be created adjacent to the charm (as a\nsidecar, in the same pod).\n\nThis is required for Kubernetes charms.\n\nThis key consists of a dictionary mapping container names to their\nspecifications. Each container can be specified in terms of ``resource``,\n``bases`` and ``mounts``, where one of either the ``resource`` or the\n``bases`` subkeys must be defined and ``mounts`` is optional.\n\n- ``resource`` is the name of an OCI image resource used to create the\n  container (that you will then define further in the resources block).\n- ``bases`` is a list of bases to be used for resolving a container image,\n  in descending order of preference. To use it, specify a base name (for\n  example, ``ubuntu`` or ``centos``), a ``channel`` and an\n  ``architecture``.\n- ``mounts`` is a list of mounted storage volumes for this container. To\n  use it, specify the name of the storage to mount from the charm\n  storage and, optionally, the location where to mount the storage.\n\nStructure::\n\n    containers:\n      <container name>:\n        resource: <resource name>\n        bases:\n          - name: <base name>\n            channel: <track[/risk][/branch]>\n            architectures:\n              - <architecture>\n        mounts:\n          - storage: <storage name>\n            location: <path>","examples":[{"super-app":{"mounts":[{"location":"/logs","storage":"logs"}],"resource":"super-app-image"}}],"title":"Containers"},"devices":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"description":"Devices the charm needs.\n\nStructure::\n\n    devices:\n      <device name>:\n        type: gpu | nvidia.com/gpu | amd.com/gpu\n        description: <Optional description>\n        countmin: <Optional minimum number requested>\n        countmax: <Optional maximum number requested>","examples":[{"amd-gpu":{"countmax":100,"countmin":1,"description":"Some sweet AMD GPU","type":"amd.com/gpu"},"nvidia-gpu":{"countmin":20,"description":"Some NVIDIA GPUs","type":"nvidia.com/gpu"}},{"gpus":{"countmax":40,"countmin":2,"description":"A bunch of GPUs","type":"gpu"}}],"title":"Devices"},"extra-bindings":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"description":"A key-only mapping representing extra bindings needed.","title":"Extra-Bindings"},"peers":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"description":"A map of peer relations.\n\nStructure::\n\n    peers:\n      <endpoint name>:\n        interface: <Required interface name>\n        limit: <Optional: maximum number of supported connections\n        optional: <Informational only - whether the relation is required.>\n        scope: <\"global\" or \"container\" - the relation scope.>\n\nFor more information, see\n`the Juju documentation <https://juju.is/docs/juju/relation>`_.","examples":[{"friend":{"interface":"life","limit":150,"optional":true,"scope":"container"}}],"title":"Peers"},"provides":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"description":"A map of interfaces this charm provides.\n\nStructure::\n\n    provides:\n      <endpoint name>:\n        interface: <Required interface name>\n        limit: <Optional: maximum number of supported connections\n        optional: <Informational only - whether the relation is required.>\n        scope: <\"global\" or \"container\" - the relation scope.>\n\nFor more information, see\n`the Juju documentation <https://juju.is/docs/juju/relation>`_.","examples":[{"self":{"interface":"identity"}}],"title":"Provides"},"requires":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"description":"A map of relations this charm requires.\n\nStructure::\n\n    requires:\n      <endpoint name>:\n        interface: <Required interface name>\n        limit: <Optional: maximum number of supported connections\n        optional: <Informational only - whether the relation is required.>\n        scope: <\"global\" or \"container\" - the relation scope.>\n\nFor more information, see\n`the Juju documentation <https://juju.is/docs/juju/relation>`_.","examples":[{"parent":{"interface":"birth","limit":2,"optional":false,"scope":"global"}}],"title":"Requires"},"resources":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"description":"A mapping of resources that accompany the charm.\n\nSee first: `Juju | Charm resource <https://juju.is/docs/juju/charm-resource>`_\n\nEach resource is made available when the charm is deployed. NOTE:\nKubernetes charms must declare an ``oci-image`` type resource for each\ncontainer declared in ``containers``.\n\nStructure::\n\n    # (Optional) Additional resources that accompany the charm\n    resources:\n      <resource name>:\n        # (Required) The type of the resource\n        type: file | oci-image\n\n        # (Optional) Description of the resource and its purpose\n        description: <description>\n\n        # (Required: when type:file) The filename of the resource as it\n        # should appear in the filesystem.\n        filename: <filename>","examples":[{"water":{"filename":"/dev/h2o","type":"file"}},{"super-app-image":{"description":"My app!","type":"oci-image"}}],"title":"Resources"},"storage":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"description":"Storage devices requested by the charm.\n\nStructure::\n\n    storage:\n      # Each key represents the name of the storage\n      <storage name>:\n\n        # (Required) Type of the requested storage\n        type: filesystem | block\n\n        # (Optional) Description of the storage requested\n        description: <description>\n\n        # (Optional) The mount location for filesystem stores. For\n        # multi-stores the location acts as the parent directory for each\n        # mounted store.\n        location: <location>\n\n        # Indicates if the storage should be made read-only (where\n        # possible). Defaults to false\n        read-only: true | false\n\n        # (Optional) The number of storage instances to be requested\n        multiple:\n          range: <n> | <n>-<m> | <n>- | <n>+\n\n        # (Optional) Minimum size of requested storage in forms G, GiB, GB.\n        # Size multipliers are M, G, T, P, E, Z or Y. With no multiplier\n        # supplied, M is implied.\n        minimum-size: <n> | <n><multiplier>\n\n        # (Optional) List of properties, only supported value is \"transient\"\n        properties:\n          - transient\n","examples":[{"jbod":{"description":"A block storage to use as swap space","properties":["transient"],"type":"block"}}],"title":"Storage"},"subordinate":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"Optional boolean to declare the charm subordinate.","examples":[true],"title":"Subordinate"},"terms":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"default":null,"description":"A list of terms to which the user agree by using the charm.\nThese terms are not enforced by the charm, Juju or Canonical.","examples":["Post cat pictures on Mastodon","Tag your cat pictures with #caturday"],"title":"Terms"},"links":{"anyOf":[{"$ref":"#/$defs/Links"},{"type":"null"}],"default":null,"description":"(Recommended) Links to various additional information used by Charmhub.","examples":[{"contact":"Please send your answer to Old Pink, care of the Funny Farm, Chalfont","documentation":"https://discourse.charmhub.io/t/traefik-k8s-docs-index/10778","issues":"https://github.com/canonical/traefik-k8s-operator/issues","source":"https://github.com/canonical/traefik-k8s-operator","website":"https://charmed-kubeflow.io/"}]},"config":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"description":"One or more configuration options for your charm.\n\nStructure::\n\n    config:\n      options:\n        # Each option name is the name by which the charm will query the option.\n        <option name>:\n          # (Required) The type of the option\n          type: string | int | float | boolean | secret\n          # (Optional) The default value of the option\n          default: <a reasonable default value of the same type as the option>\n          # (Optional): A string describing the option. Also appears on charmhub.io\n          description: <description string>","examples":[{"options":{"name":{"default":"Wiki","description":"The name or title of the Wiki","type":"string"},"skin":{"default":"vector","description":"Skin to use for the wiki","type":"string"}}}],"title":"Config"}},"required":["name","summary","description","platforms","parts","type"],"title":"PlatformCharm","type":"object"}},"oneOf":[{"$ref":"#/$defs/PlatformCharm"},{"$ref":"#/$defs/BasesCharm"}]}
</schema>

[User] Provide a JSON object that satisfies the schema "charmcraft". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.

Definition of `analysis` configuration.

AnalysisConfig

Represents a base.

Name

Channel

Architectures

Base

A charm using the deprecated ``bases`` keyword.

This type of charm only supports the following bases:
    - Ubuntu 18.04
    - Ubuntu 20.04
    - Ubuntu 22.04
    - CentOS 7
    - Alma Linux 9

The name of the project on Charmhub.

This value will be used both in the URL of the charm on Charmhub and when
deploying the charm with juju.

Charms should follow the
`charm naming guidelines <https://juju.is/docs/sdk/naming>`_.

Project Name

A human-readable title.

Ubuntu Linux
Jupyter Lab Desktop
LXD
DigiKam
Apache Kafka
MySQL Router K8s charm

Title

Title

Version

A brief (one-line) summary of your charm.

Summary

A multi-line summary of your charm.

Description

Base

Build-Base

Platforms

Contact

Issues

Source-Code

License

Adopt-Info

Configures the various mechanisms to obtain, process and prepare data from
different sources that end up being a part of the final charm.

Keys are user-defined part names. The value of each key is a map where keys
are part names.

Example::

    parts:
      libs:
        plugin: dump
        source: /usr/local/lib/
        organize:
          "libxxx.so*": lib/
        prime:
          - lib/

Parts

Package-Repositories

Type

How analysis done on the charm will behave.

Currently the only options are to ignore attributes or linters.

(DEPRECATED): Configuration for accessing charmhub.

List of libraries to use for this charm

Defines one or more actions.

This key is equivalent to the
`actions.yaml file <https://juju.is/docs/sdk/actions-yaml>`_.

Actions

Explicitly state features a Juju model must be able to provide for a
successful deployment of this charm. When a charm includes such
requirements, Juju performs a pre-deployment check and displays
user-friendly error messages if a feature requirement cannot be met by the
model that the user is trying to deploy the charm to. If the assumes
section of the charm metadata is omitted, Juju will make a best-effort
attempt to deploy the charm, and users must rely on the output of
``juju status`` to figure out whether the deployment was successful.

The key consists of a list of features that can be given either directly
or, depending on the complexity of the condition you want to enforce,
nested under one or both of the boolean expressions any-of or all-of,
as shown below. In order for a charm to be deployed, all entries in the
assumes block must be satisfied.

Structure::

    assumes:
      - <feature-1>
      - any-of:
        - <feature-2>
        - <feature-3>
      - all-of:
        - <feature-4>
        - <feature-5>

Juju version requirements can be specified with a string such as
``juju >= 3.5`` or ``juju < 4.0``. A full list of supported features
can be found in the
`Juju documentation <https://juju.is/docs/juju/supported-features>`_.

Assumes

Specifies that the charm code does not need to be run as root. Possible
values are:

- ``root``: the charm will run as root
- ``sudoer``: the charm will run as a non-root user with access to root
  privileges using ``sudo``.
- ``non-root``: the charm will run as a non-root user without ``sudo``.

Only affects Kubernetes charms on Juju 3.6.0 or later. If not specified,
Juju will use
`its default behaviour <https://juju.is/docs/sdk/metadata-yaml#heading--charm-user>`_.

Charm-User

Define a map of containers to be created adjacent to the charm (as a
sidecar, in the same pod).

This is required for Kubernetes charms.

This key consists of a dictionary mapping container names to their
specifications. Each container can be specified in terms of ``resource``,
``bases`` and ``mounts``, where one of either the ``resource`` or the
``bases`` subkeys must be defined and ``mounts`` is optional.

- ``resource`` is the name of an OCI image resource used to create the
  container (that you will then define further in the resources block).
- ``bases`` is a list of bases to be used for resolving a container image,
  in descending order of preference. To use it, specify a base name (for
  example, ``ubuntu`` or ``centos``), a ``channel`` and an
  ``architecture``.
- ``mounts`` is a list of mounted storage volumes for this container. To
  use it, specify the name of the storage to mount from the charm
  storage and, optionally, the location where to mount the storage.

Structure::

    containers:
      <container name>:
        resource: <resource name>
        bases:
          - name: <base name>
            channel: <track[/risk][/branch]>
            architectures:
              - <architecture>
        mounts:
          - storage: <storage name>
            location: <path>

Containers

Devices the charm needs.

Structure::

    devices:
      <device name>:
        type: gpu | nvidia.com/gpu | amd.com/gpu
        description: <Optional description>
        countmin: <Optional minimum number requested>
        countmax: <Optional maximum number requested>

Some sweet AMD GPU

Some NVIDIA GPUs

A bunch of GPUs

Devices

A key-only mapping representing extra bindings needed.

Extra-Bindings

A map of peer relations.

Structure::

    peers:
      <endpoint name>:
        interface: <Required interface name>
        limit: <Optional: maximum number of supported connections
        optional: <Informational only - whether the relation is required.>
        scope: <"global" or "container" - the relation scope.>

For more information, see
`the Juju documentation <https://juju.is/docs/juju/relation>`_.

Peers

A map of interfaces this charm provides.

Structure::

    provides:
      <endpoint name>:
        interface: <Required interface name>
        limit: <Optional: maximum number of supported connections
        optional: <Informational only - whether the relation is required.>
        scope: <"global" or "container" - the relation scope.>

For more information, see
`the Juju documentation <https://juju.is/docs/juju/relation>`_.

Provides

A map of relations this charm requires.

Structure::

    requires:
      <endpoint name>:
        interface: <Required interface name>
        limit: <Optional: maximum number of supported connections
        optional: <Informational only - whether the relation is required.>
        scope: <"global" or "container" - the relation scope.>

For more information, see
`the Juju documentation <https://juju.is/docs/juju/relation>`_.

Requires

A mapping of resources that accompany the charm.

See first: `Juju | Charm resource <https://juju.is/docs/juju/charm-resource>`_

Each resource is made available when the charm is deployed. NOTE:
Kubernetes charms must declare an ``oci-image`` type resource for each
container declared in ``containers``.

Structure::

    # (Optional) Additional resources that accompany the charm
    resources:
      <resource name>:
        # (Required) The type of the resource
        type: file | oci-image

        # (Optional) Description of the resource and its purpose
        description: <description>

        # (Required: when type:file) The filename of the resource as it
        # should appear in the filesystem.
        filename: <filename>

My app!

Resources

Storage devices requested by the charm.

Structure::

    storage:
      # Each key represents the name of the storage
      <storage name>:

        # (Required) Type of the requested storage
        type: filesystem | block

        # (Optional) Description of the storage requested
        description: <description>

        # (Optional) The mount location for filesystem stores. For
        # multi-stores the location acts as the parent directory for each
        # mounted store.
        location: <location>

        # Indicates if the storage should be made read-only (where
        # possible). Defaults to false
        read-only: true | false

        # (Optional) The number of storage instances to be requested
        multiple:
          range: <n> | <n>-<m> | <n>- | <n>+

        # (Optional) Minimum size of requested storage in forms G, GiB, GB.
        # Size multipliers are M, G, T, P, E, Z or Y. With no multiplier
        # supplied, M is implied.
        minimum-size: <n> | <n><multiplier>

        # (Optional) List of properties, only supported value is "transient"
        properties:
          - transient

A block storage to use as swap space

Storage

Optional boolean to declare the charm subordinate.

Subordinate

A list of terms to which the user agree by using the charm.
These terms are not enforced by the charm, Juju or Canonical.

Post cat pictures on Mastodon
Tag your cat pictures with #caturday

Terms

(Recommended) Links to various additional information used by Charmhub.

Please send your answer to Old Pink, care of the Funny Farm, Chalfont

One or more configuration options for your charm.

Structure::

    config:
      options:
        # Each option name is the name by which the charm will query the option.
        <option name>:
          # (Required) The type of the option
          type: string | int | float | boolean | secret
          # (Optional) The default value of the option
          default: <a reasonable default value of the same type as the option>
          # (Optional): A string describing the option. Also appears on charmhub.io
          description: <description string>

The name or title of the Wiki

Skin to use for the wiki

Config

Bases

BasesCharm

Definition of build-on/run-on combinations.

Example::

    bases:
      - build-on:
          - name: ubuntu
            channel: "20.04"
            architectures: [amd64, arm64]
        run-on:
          - name: ubuntu
            channel: "20.04"
            architectures: [amd64, arm64]
          - name: ubuntu
            channel: "22.04"
            architectures: [amd64, arm64]

Build-On

Run-On

BasesConfiguration

A Charm library dependency for this charm.

Library Path (e.g. my-charm.my_library)

Version filter for the charm. Either an API version or a specific [api].[patch].

CharmLib

Definition of Charmhub endpoint configuration.

Api-Url

Storage-Url

Registry-Url

Charmhub

Definition of `analysis.ignore` configuration.

Attributes

Linters

Ignore

Definition of `links` in metadata.

Contact

Documentation

Issues

Source

Website

Links

Project platform definition.

Build-On

Build-For

Platform

Model for defining a charm using Platforms.

Project Name

A human-readable title.

Title

Title

Version

Summary

A multi-line summary of your charm.

Description

Base

Build-Base

Platforms

Contact

Issues

Source-Code

License

Adopt-Info

Parts

Package-Repositories

Type

List of libraries to use for this charm

Actions

Assumes

Charm-User

Containers

Some sweet AMD GPU

Some NVIDIA GPUs

A bunch of GPUs

Devices

Extra-Bindings

Peers

Provides

Requires

My app!

Resources

A block storage to use as swap space

Storage

Subordinate

Terms

The name or title of the Wiki

Skin to use for the wiki

Config

name summary description platforms parts type

PlatformCharm

Provide a JSON object that satisfies the schema "charmcraft". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.


[System]
You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:
<schema>
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/chart-lock.json","additionalProperties":false,"properties":{"generated":{"description":"Generated is the date the lock file was last generated.","type":"string","format":"date-time"},"digest":{"description":"Digest is a hash of the dependencies in Chart.yaml.","type":"string"},"dependencies":{"type":"array","description":"In Helm, one chart may depend on any number of other charts. These dependencies can be dynamically linked using the dependencies field in Chart.yaml or brought in to the charts/ directory and managed manually.\nThe charts required by the current chart are defined as a list in the dependencies field.","items":{"type":"object","additionalProperties":false,"required":["name","version","repository"],"properties":{"name":{"description":"The name of the chart","type":"string"},"version":{"description":"The version of the chart","type":"string"},"repository":{"description":"The repository URL or alias","type":"string","format":"uri"}}}}},"required":["generated","digest","dependencies"],"title":"Helm Chart.lock","type":"object"}
</schema>

[User] Provide a JSON object that satisfies the schema "Helm Chart.lock". Here are the required top‑level fields: generated, digest, dependencies. Return only the valid JSON object.

Generated is the date the lock file was last generated.

Digest is a hash of the dependencies in Chart.yaml.

In Helm, one chart may depend on any number of other charts. These dependencies can be dynamically linked using the dependencies field in Chart.yaml or brought in to the charts/ directory and managed manually.
The charts required by the current chart are defined as a list in the dependencies field.

The name of the chart

The version of the chart

The repository URL or alias

Helm Chart.lock

Provide a JSON object that satisfies the schema "Helm Chart.lock". Here are the required top‑level fields: generated, digest, dependencies. Return only the valid JSON object.