mkdocs.yml

site_name: BentoBox World
copyright: "© Copyright 2017-2026 tastybento and the BentoBoxWorld community (CC-BY 4.0)."
repo_url: https://github.com/BentoBoxWorld/BentoBox
repo_name: BentoBoxWorld/BentoBox
edit_uri: ""
nav:
    - Home: index.md
    - "What does BentoBox do?":
        - Island Management: BentoBox/About/IslandManagement.md
        - Game Modes: BentoBox/About/GameModes.md
        - Addons: BentoBox/About/Addons.md
        - Team Handling: BentoBox/About/Teams.md
        - Protection: BentoBox/About/Protections.md
        - Blueprints: BentoBox/About/BlueprintsSummary.md
        - Multilingual Support: BentoBox/About/Multilingual.md
        - Admin Tools: BentoBox/About/AdminTools.md
    - Glossary: Glossary.md
    - FAQ: FAQ.md
    - Privacy: BentoBox/Privacy.md
    - AI Policy: BentoBox/AI-Policy.md
    - Code of Conduct: BentoBox/CodeOfConduct.md
    - Contributing: BentoBox/Contributing.md
    - Game Modes:
        - Choosing a Game Mode: gamemodes/Comparison.md
        - AcidIsland: gamemodes/AcidIsland/index.md
        - AOneBlock:
            - Overview: gamemodes/AOneBlock/index.md
            - Customizing Phases: gamemodes/AOneBlock/Phases.md
        - BSkyBlock: gamemodes/BSkyBlock/index.md
        - Boxed: gamemodes/Boxed/index.md
        - CaveBlock: gamemodes/CaveBlock/index.md
        - ChunkBlock:
            - Overview: gamemodes/ChunkBlock/index.md
            - Claiming Chunks: gamemodes/ChunkBlock/Chunks.md
            - Phases: gamemodes/ChunkBlock/Phases.md
            - Commands: gamemodes/ChunkBlock/Commands.md
            - Permissions: gamemodes/ChunkBlock/Permissions.md
            - Placeholders: gamemodes/ChunkBlock/Placeholders.md
        - Poseidon: gamemodes/Poseidon/index.md
        - SkyGrid: gamemodes/SkyGrid/index.md
        - Stranger Realms: gamemodes/StrangerRealms/index.md
        - TradeWinds:
            - Overview: gamemodes/TradeWinds/index.md
            - The Sailor's Handbook: gamemodes/TradeWinds/Gameplay.md
            - Commands: gamemodes/TradeWinds/Commands.md
            - Permissions: gamemodes/TradeWinds/Permissions.md
            - Placeholders: gamemodes/TradeWinds/Placeholders.md
              
    - Addons:
        - Bank: addons/Bank/index.md
        - Biomes: addons/Biomes/index.md
        - Border: addons/Border/index.md
        - CauldronWitchery: addons/CauldronWitchery/index.md
        - Challenges: addons/Challenges/index.md
        - Chat: addons/Chat/index.md
        - CheckMeOut: addons/CheckMeOut/index.md
        - ControlPanel: addons/ControlPanel/index.md
        - DeathChest: addons/DeathChest/index.md
        - DimensionalTrees: addons/DimensionalTrees/index.md
        - ExtraMobs: addons/ExtraMobs/index.md
        - FarmersDance: addons/FarmersDance/index.md
        - Greenhouses: addons/Greenhouses/index.md
        - InvSwitcher: addons/InvSwitcher/index.md
        - IslandFly: addons/IslandFly/index.md
        - Level: addons/Level/index.md
        - Likes: addons/Likes/index.md
        - Limits: addons/Limits/index.md
        - MagicCobblestoneGenerator: addons/MagicCobblestoneGenerator/index.md
        - TopBlock: addons/TopBlock/index.md
        - TwerkingForTrees: addons/TwerkingForTrees/index.md
        - Upgrades: addons/Upgrades/index.md
        - Visit: addons/Visit/index.md
        - VoidPortals: addons/VoidPortals/index.md
        - Warps: addons/Warps/index.md
    - "Tutorials – Generic":
        - "Your First 30 Minutes": BentoBox/First-Steps.md
        - "How To Install": BentoBox/Install-Bentobox.md
        - "Set a BentoBox world as the server's default world": BentoBox/Set-a-BentoBox-world-as-the-server-default-world.md
        - "Database transition": BentoBox/Database-transition.md
        - "Customizable GUIs": Tutorials/generic/Customizable-GUI.md
        - "Bigger Create Island menu": Tutorials/generic/Bigger-Create-Island-Menu.md
    - "Tutorials – API":
        - "Create an Addon": Tutorials/api/Create-an-addon.md
        - "Config API": BentoBox/Config-API.md
        - "Database API": BentoBox/Database-API.md
        - "Metadata API": BentoBox/MetadataAPI.md
        - "Templated Panel API": Tutorials/api/Templated-Panel.md
        - "Blueprint File Format": BentoBox/Blueprint-Format.md
        - "Get Data From Addons": BentoBox/Request-Handler-API---How-plugins-can-get-data-from-addons.md
theme:
  name: material
  custom_dir: overrides
  palette:
    scheme: slate
    primary: deep orange
    accent: green
  icon:
    repo: fontawesome/brands/git-alt
extra_css:
  - stylesheets/icons-minecraft-0.5.css
  - stylesheets/bentobox-theme.css
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/BentoBoxWorld
      name: BentoBoxWorld on GitHub
    - icon: fontawesome/brands/jenkins
      link: https://ci.bentobox.world
      name: BentoBoxWorld on CodeMC CI
    - icon: fontawesome/brands/discord
      link: https://discord.bentobox.world
      name: BentoBoxWorld on Discord
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/channel/UCPaNnfxhr1-wCy0KBs9PLdQ
      name: BentoBoxWorld on YouTube
    - icon: fontawesome/solid/heart
      link: https://github.com/sponsors/tastybento
      name: Sponsor tastybento on GitHub Sponsors
    - icon: fontawesome/solid/pen
      link: https://github.com/BentoBoxWorld/docs
      name: Contribute to the documentation on GitHub
markdown_extensions:
  - attr_list
  - admonition
  - footnotes
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.keys
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist
  - pymdownx.tilde
  - toc:
      permalink: "#"
plugins:
  - search
  - git-revision-date-localized:
      type: datetime
  - minify:
      minify_html: true
  - macros