Skip to content

Latest commit

 

History

History
185 lines (149 loc) · 4.15 KB

trophies.md

File metadata and controls

185 lines (149 loc) · 4.15 KB

Trophies

Trophies are awarded to players based on actions taken during a game, such as playing certain types of cards.

Trophy object format

A trophy object consists of several components. Below is some example JSON showing how they are structured:

{
    // Internal ID string for trophy
    "id": "trophy_example",

    // Display name for trophy
    "name": {
        "en-US": "Kinky"
    },

    // Description displayed next to trophy
    "desc": {
        "en-US": "20% or more cards played feature unusual fetishes."
    },

    // Requirements for getting trophy
    "requirements": [
        {
            "type": "card_proportion",
            "flags": ["xf"],
            "winning": false,
            "percent": 20
        }
    ]
}

Trophy requirements

Requirements define the conditions that must be met in order for a player to earn a specific trophy. If multiple requirements are listed, all must be met.

Any

Type name: any

Requires that one or more of the specified requirements be met.

{
    "type": "any",
    "requirements": [
        { 
            /* ... */
        },
        { 
            /* ... */
        }
    ]
}

All

Type name: all

Requires that all of the specified requirements be met.

{
    "type": "all",
    "requirements": [
        { 
            /* ... */
        },
        { 
            /* ... */
        }
    ]
}

Cards Played

Type name: cards_played

Requires that all of the listed cards have been played.

{
    "type": "cards_played",
    "cards": ["w_example1", "w_example2"],
    "single_play": false, // Do they need to be in the same play?
    "winning": false, // Require that played cards have won round(s)
}

Card Proportion

Type name: card_proportion

Requires a certain percentage of played cards to match at least one of the specified content flag strings.

{
    "type": "card_proportion",

    // Flag filters. Contents must include at least one of the array items.
    "flags": ["s", "v"], // Cards with either sexual content or violence

    "winning": false, // Specifies whether cards must have won a round

    "maximum": false, // (optional) Filter by maximum proportion instead of minimum

    // Minimum percentage of cards to be met
    "percent": 20
}

Win Proportion

Type name: win_proportion

Requires that the user win a certain proportion of the rounds in a game.

{
    "type": "win_proportion",
    "percent": 50,
    "inclusive": true, // (optional) Inclusive comparison (e.g. at 50%, or above 50%?)
    "maximum": // (optional) Filter by maximum proportion instead of minimum
}

Card contents

Standard content flags are defined below for use by all packs. Additional flags not on this list may also be used (e.g. for implementing a special trophy type).

Flag Description
a General abuse flag.
an Animals.
as Antisemitism or Nazism.
bd BDSM.
bg Blood/Gore.
ce Celebrities.
ch Children.
cn Cannibalism.
_cr (Postfix) Cruelty or unfair treatment.
d Death.
ds Disabilities.
db Abortion/dead baby jokes.
dg Degrading remarks or behavior.
di Disease/Sickness/Medical conditions.
dr Drugs/Drug usage.
fc Fictional characters.
fe Feces.
g Generally regarded as disgusting, but not necessarily harmful.
gg Unusually and extremely disgusting. May cause harm, disease, sickness, or mental trauma.
gn Genitalia.
gnf Female genitalia.
gnm Male genitalia.
hp Homophobia/Transphobia.
i Injury.
ic Incest.
in Insects.
l Obscene/impolite language.
lgbt Relating to the LGBT community.
ma Misandry.
mg Misogyny.
mu Murder.
ncs Nonconsensual sexual acts.
nh Non-heterosexual sexual acts.
nu Nudity.
pd Pedophilia.
ra Racism.
re Religion or religious people.
s General sexual content flag.
sh Self-harm.
su Suicide.
t Terrorism/Terroristic threats.
to Torture.
v General violence flag.
w Generally regarded as weird or unsettling.
ww Creepy, horror-inducing, or terrifying.
x Pornography.
xf Unusual or extreme fetishes (e.g. genital torture, scat, vomit).