mkdocs.yml

site_name: Gran Turismo Modding Hub
site_description: Gran Turismo Modding Hub - The central source of information for GT Modding.
site_url: https://nenkai.github.io/gt-modding-hub/
repo_url: https://github.com/Nenkai/gt-modding-hub
repo_name: nenkai/gt-modding-hub

copyright: Copyright © 2023 Nenkai - If this website was useful, please make a mention! This page is not affiliated with Polyphony Digital or Sony Interactive Entertainment.

theme:
  name: material
  logo: images/logo.png
  favicon: images/favicon.png

  features:
    - navigation.tabs
    - navigation.sections
    - navigation.footer
    - navigation.top
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - toc.integrate
    - toc.follow
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.copy
    - content.action.edit
    - content.code.annotate
    - header.autohide
  language: en
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
      primary: blue
      accent: purple 
    - media: "(prefers-color-scheme: dark)"
      scheme: slate 
      toggle:
        icon: material/brightness-4
        name: Switch to light mode    
      primary: deep purple
      accent: blue

nav:
  - Main Page: index.md
  - Blog: blog

  - PS1 (GT1/GT2):
    - Index: ps1/index.md
    - GT1:
        - Tools / Resources: ps1/gt1/tools.md
    - GT2:
        - Tools / Resources: ps1/gt2/tools.md 

  - PS2 (GT3/GT4/TT):
    - Index: ps2/index.md
    - Models: ps2/models.md
    
    - GT3 / GTC:
        - Getting Started:
          - Volume & Making Edits: ps2/gt3/volume.md
        - Patches / Cheats: ps2/gt3/patches.md
        - Tools / Resources: ps2/gt3/tools.md
        - Car Model List: ps2/gt3/model_car_list.md
        
    - GT4 / GT4P / TT:
      - Getting Started:
        - Volume & Making Edits: ps2/gt4/volume.md
        - Folder/File Structure: ps2/gt4/file_structure.md
      - SpecDB (Car Specs): ps2/gt4/specdb.md
      - Textures: ps2/textures.md
      - Tools / Resources: ps2/gt4/tools.md
      - Patches / Cheats: ps2/gt4/patches.md

      - Miscellaneous: 
        - Loading Clock Colors/Errors: ps2/gt4/misc/loading_clock_colors.md
    
    - Other:
      - Executables (CORE.GT3/CORE.GT4): ps2/executables.md
      - Reverse-Engineering Notes: ps2/reverse_engineering_notes.md
      - Model Render Commands: ps2/model_render_commands.md
    
  - PS3 (GT5/GT6):
    - Getting Started: ps3/getting_started.md
    - Basics: 
      - Volume & Making Edits: ps3/basics/volume_system.md
      - Folder/File Structure: ps3/basics/file_structure.md
      - Easier Ways to Mod : ps3/basics/easier_ways_to_mod.md

    - Asset Editing:
      - Text Editing: ps3/text_editing.md
      - Textures/Image Editing: ps3/textures.md
      - Music Tracks / SFX: ps3/music_tracks.md
      - Car Sound Editing: ps3/car_sound_editing.md
      - SpecDB (Car Specs): ps3/specdb.md
      - Events: ps3/events.md
      - Adhoc: ps3/adhoc.md
      - Movies: ps3/movies.md
      - Models: ps3/models.md
      - Fonts: ps3/fonts.md
      - Text Data (GT5): ps3/textdata.md

    - Other:
        - Optimal Modding Setup: ps3/other/optimal_setup.md
        - Command Line Arguments: ps3/other/command_line_args.md
        - FSRoot: ps3/other/fsroot.md
        - Game Updates: ps3/other/updates.md
        - Custom Server: ps3/other/custom_server.md
        - RPCS3 Settings: ps3/other/rpcs3_setup.md
        - Resources / Tools: ps3/tools.md

  - PS4 (GTS/GT7):
    - Index: ps4/index.md
    - Resources / Tools: ps4/tools.md

  - General Concepts: 
      Index: concepts/index.md
      Volume: concepts/volume.md
      SpecDB: concepts/specdb.md

      Adhoc: 
        - Adhoc Explained: concepts/adhoc/adhoc.md
        - TinyWeb: concepts/adhoc/tinyweb.md

      Courses (Tracks):
        - Basics / Glossary: concepts/courses/basics.md

      Online:
        - Grim: concepts/online/grim.md
        - Vegas: concepts/online/vegas.md

  - Formats:
    - Basic Information: formats/abstract.md
    - Database Formats:
      - .dbt - Database Table: formats/database/dbt_database_table.md
      - .idi - Label Information: formats/database/idi_label_information.md
      - .sdb - String Storage/Database: formats/database/sdb_string_database.md
      
    - Textures:
      - .img - Tex1/TexSet: formats/texture/img_tex1_textureset.md
      - .img - TXS3/TextureSet3: formats/texture/img_txs3_textureset3.md

    - Audio:
      - .lib - BGM Library: formats/audio/bgml_bgm_library.md
      - .esgx - Engine SGX: formats/audio/esgx_engine_sgx.md
      - .sgd/sgb/sgh - SGX: formats/audio/sgd_sgh_sgx_data.md

    - Adhoc:
      - .adc - Adhoc Script: formats/adhoc/adch_adhoc_compiled.md
      - .gpb - GpbData: formats/adhoc/gpb_gpbdata.md

    - Models:
      - .pat / Pat0 / ColorPatch: formats/models/pat0_colorpatch.md
      - .mdl / MDL3 / ModelSet3: formats/models/mdl3_modelset3.md
      
    - Courses:
      - GT4 Course Data: formats/courses/gt4_coursedata.md

    - Fonts:
      - .vec - NVEC: formats/fonts/vec_nvec.md

    - Volume: 
      - PS2 GT4 Volume/RoFS: formats/volume/ps2_gt4_volume.md
      - PS3 Volume/PDIPFS: formats/volume/ps3_volume.md

    - Other Formats:
      - .rt2 - RText (Localization): formats/rt2_localization.md
      - CORE - PS2 Executables: formats/ps2_core.md
      
    - Compression:
      - Headers: formats/compression/compression_formats.md

  - Game Builds:
      - builds/game_builds.md

      - PS1:
        - Gran Turismo: builds/gt1.md
        - Gran Turismo 2: builds/gt2.md

      - PS2:
        - Gran Turismo 3: builds/gt3.md
        - Gran Turismo Concept: builds/gt3concept.md
        - Gran Turismo 4 Prologue: builds/gt4p.md
        - Gran Turismo 4: builds/gt4.md
        - Tourist Trophy: builds/tt.md

      - PS3:
        - Gran Turismo HD: builds/gthd.md
        - Gran Turismo 5 Prologue: builds/gt5p.md
        - Gran Turismo 5: builds/gt5.md
        - Gran Turismo 6: builds/gt6.md

      - PS4/PS5:
        - Gran Turismo SPORT: builds/gt7sp.md
        - Gran Turismo 7: builds/gt7.md

      - Other:
        - Gran Turismo PSP: builds/gtpsp.md

  - Mod Showcase:
      - Index: mod_showcase/index.md

  - Discord:
      - discord.md
      - Other: 
        - GT7 Shuffle Bot: discord/gt7_shuffle.md

  - Credits:
      - credits.md

markdown_extensions:
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - admonition
  - pymdownx.arithmatex:
      generic: true
  - footnotes
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.mark
  - pymdownx.keys
  - pymdownx.critic
  - pymdownx.tilde
  - pymdownx.tabbed:
      alternate_style: true 
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

plugins:
  - git-revision-date-localized:
      enable_creation_date: true
  - git-committers:
      repository: nenkai/gt-modding-hub
      branch: master
  - social:
      cards_color:
        fill: "#2F2F3E"
  - search:
      lang: en
  - glightbox
  - blog:
      draft: true
      blog_toc: true

extra:
  social:
    - icon: fontawesome/brands/discord 
      link: https://nenkai.github.io/gt-modding-hub/discord/

    - icon: fontawesome/brands/twitter 
      link: https://twitter.com/Nenkaai

    - icon: fontawesome/brands/github 
      link: https://github.com/Nenkai

    - icon: simple/kofi
      link: https://ko-fi.com/nenkai
      
extra_css:
  - stylesheets/extra.css