copier.yml

# Copier settings (not prompted)

_subdirectory: template
_answers_file: .copier-answers.hexdoc-mod.yml
_skip_if_exists:
  - ".env"
  - "icon.png"
_exclude:
  # for copier-template-tester
  - ".ctt"
  - "ctt.toml"
  # Defaults: https://copier.readthedocs.io/en/latest/configuring/#exclude
  - "copier.yaml"
  - "copier.yml"
  - "~*"
  - "*.py[co]"
  - "__pycache__"
  - ".git"
  - ".DS_Store"
  - ".svn"

# hide values that are relatively easy to autogenerate

advanced:
  type: bool
  default: false
  help: Show advanced configuration questions?

# mod name and id

modid:
  type: str

mod_display_name:
  type: str
  default: "{{ modid|capitalize }}"

book_id:
  type: str
  default: "{{ modid }}:{{ modid }}book"
  help: Your Patchouli book id (eg. for Botania, this is botania:lexicon)

# hexdoc plugin

plugin_root:
  when: "{{ advanced }}"
  type: str
  default: doc

plugin_root_with_slash:
  when: false
  default: "{{ plugin_root|trim('/')~'/' if plugin_root }}"

plugin_name:
  when: "{{ advanced }}"
  type: str
  default: "hexdoc-{{ modid|replace('_', '-')|lower }}"

plugin_slug:
  when: "{{ advanced }}"
  type: str
  default: "{{ plugin_name|replace('-', '_') }}"
  help: "Directory name under {{ plugin_root_with_slash }}src/ to put plugin code in (eg. entering {{ plugin_name|replace('-', '_') }} will create {{ plugin_root_with_slash }}src/{{ plugin_name|replace('-', '_') }})"

plugin_pluggy_classname:
  when: "{{ advanced }}"
  type: str
  default: "{{ modid|capitalize }}Plugin"

plugin_ModPlugin_classname:
  when: "{{ advanced }}"
  type: str
  default: "{{ plugin_pluggy_classname|replace('Plugin', 'ModPlugin') }}"

# mod structure

gradle_mod_version_key:
  type: str
  default: modVersion
  help: Key name in gradle.properties where the mod version is stored

gradle_minecraft_version_key:
  type: str
  default: minecraftVersion
  help: Key name in gradle.properties where the Minecraft version is stored

multiloader:
  type: bool
  default: true
  help: Does your mod use a multiloader structure?

capitalize_platforms:
  type: bool
  default: false
  help: Are the platform directories capitalized (eg. Common/ vs common/)?

common_dir:
  when: false
  type: str
  default: "{{ 'C' if capitalize_platforms else 'c' }}ommon"

fabric_dir:
  when: false
  type: str
  default: "{{ 'F' if capitalize_platforms else 'f' }}abric"

forge_dir:
  when: false
  type: str
  default: "{{ 'F' if capitalize_platforms else 'f' }}orge"

# GitHub

github_repo:
  type: str
  default: "{{ modid|capitalize }}"

author:
  type: str
  help: GitHub author username.

default_branch:
  when: "{{ advanced }}"
  type: str
  default: main

base_book_url:
  when: "{{ advanced }}"
  type: str
  default: "https://{{ author|lower }}.github.io/{{ github_repo }}/"

# file inclusion

add_gitignore:
  type: bool
  default: true
  help: Generate .gitignore for Python and hexdoc?

add_vscode:
  type: bool
  default: true
  help: Generate VSCode settings?