> For the complete documentation index, see [llms.txt](https://flipcard.superiormc.cn/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://flipcard.superiormc.cn/info/configuration-files.md).

# 🛠️Configuration files

The following paths are inside `plugins/FlipCard/`:

| Path                             | Purpose                                                       |
| -------------------------------- | ------------------------------------------------------------- |
| `config.yml`                     | Global settings and generated card/edge model mappings        |
| `ui/`                            | Menu definitions: settings, cards, prices and rewards         |
| `animations/<id>.yml`            | Independent custom frame animations, shared by both renderers |
| `arcmenu/presentations/<id>.yml` | ArcMenu presentation timelines and elements                   |
| `arcmenu/styles.yml`             | ArcMenu rarity styles and variables                           |
| `item/`                          | Saved custom items                                            |
| `language/`                      | Language files                                                |
| `texture/card/`                  | Card PNGs                                                     |
| `texture/edge/`                  | Existing rarity-edge PNGs                                     |
| `texture/animation/`             | Custom animation frame PNGs                                   |
| `texture/arcmenu/`               | Presentation PNGs and custom ArcMenu rarity frames            |
| `pack/`                          | Generated resource pack; apply it to clients after rebuilding |
| `generated-item-format.yml`      | Item-format output from `/flipcard generateitemformat`        |

Localized item-name JSON files may also be generated by the [Localized Item Name](https://flipcard.superiormc.cn/features/localized-item-name.md) feature.

## Renderer and animation scope

`flip-gui.gui-type` selects the default renderer: `INVENTORY` or `ARCMENU`. A menu can override it using `settings.gui-type`.

* [ArcMenu Mode](https://flipcard.superiormc.cn/flip-ui/arcmenu.md): layout, sizes, preview and rarity frames.
* [Custom Animation](https://flipcard.superiormc.cn/features/custom-animation.md): frame animations, including `animate: chest`, for either renderer.
* [ArcMenu Presentations](https://flipcard.superiormc.cn/features/arcmenu-presentations.md): ArcMenu-only motion, decoration, styles and pixel glow.

Legacy frame animations under `config.yml` → `animations` remain supported. New installations use independent animation files.

Existing files are not automatically overwritten by a plugin update. Merge new example settings when adopting new features. Use `/flipcard reload` for YAML changes; resource-dependent changes also require applying the regenerated pack to clients.

## Default config.yml

```yaml
# FlipCard by @rtz1020 & @PQguanfang
#
# READ THE WIKI: flipcard.superiormc.cn
#

config-files:
  language: en_US
  per-player-language: true
  force-parse-mini-message: true

debuild-item-method: 'LEGACY'

# Support value: DEFAULT or ITEMBRIDGE
hook-item-method: 'DEFAULT'

math:
  enabled: true
  enable-function: true
  scale: 2

number-display:
  format:
    enabled: true
    decimal: "#,##0.00##########"
    integer: "#,##0"
  strip-trailing-zeros:
    enabled: true

# Item Price
item-price:
  shulker-box-check: false
  # Support Value: Bukkit, ItemFormat.
  check-method: Bukkit
  item-format:
    ignore-key:
      - 'lore'
      - 'damage'
      - 'tool.damage-per-block'

reward:
  # Support Value: INSTANT, WAIT
  # If set to WAIT, we will give player rewards after this flip UI is closed. (give all flipped cad reward in once)
  # If set to INSTANT, we will give player rewards after he flip the card and claimed the reward.
  give-method: WAIT

# Support Value: UUID, Name.
data-save-mode: UUID

auto-copy-resourcepack:
  enabled: true
  # If you are using Oraxen, please change this to Oraxen.
  # Other plugins is OK, you just need put correct path in path option.
  plugin: "ItemsAdder"
  # If you are using Oraxen, please change this to "/pack/assets".
  path: "/contents/flipcard/resourcepack/"

database:
  enabled: false
  jdbc-url: "jdbc:mysql://localhost:3306/flipcard?useSSL=false&autoReconnect=true"
  properties:
    user: root
    password: 123456

flip-gui:
  # INVENTORY keeps the existing chest GUI. ARCMENU requires ArcMenu application API 3.4.3+.
  # Each ui/<name>.yml can override this with settings.gui-type (legacy: option.gui-type).
  gui-type: INVENTORY
  arcmenu:
    columns: 7
    rows: 4
    # card/reward scale use the cell base size; rarity-scale multiplies the visible card frame.
    card-scale: 1.0
    rarity-scale: 1.0
    reward-scale: 0.32
    canvas-width: 640
    canvas-height: 400
    screen-scale: 1.5
    tooltip-font-size: 1.1
    shuffle-ticks: 20
    # Empty keeps the existing animation. Use destiny to enable the presentation.
    presentation: ""
    style: AUTO
    rarity-display:
      # OUTLINE follows visible card bounds; TEXTURE uses the legacy edge item.
      # SPRITE uses a PNG frame from texture/arcmenu/; NONE hides the rarity frame.
      type: OUTLINE
      thickness: 1.2
      padding: 1.0
    preview:
      skip-enabled: true
    theme:
      background-enabled: true
      background: '#99182332'
      border: '#D6AB42'
      button:
        background: '#354861'
        hover: '#4D789C'
  anti-dupe-checker: false
  display-time: 10
  card:
    x_scale: 4.0
    y_scale: 3.8
    translation: -80
  edge:
    x_scale: 3.5
    y_scale: 3.5
    translation: -70
```
