> For the complete documentation index, see [llms.txt](https://docs.cozycrafters.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cozycrafters.net/plugin-docs/cozyguides/creating-guide-content.md).

# Creating Guide Content

### Guide Info

Paste/edit these near the top of the guide file:

```yml
id: welcome
name: "&b&lWelcome Guide"
description:
  - "&7Start here! A friendly intro to Cozy Crafters."
  - "&7Learn the basics before heading out."
category: getting-started
icon: OAK_SAPLING
permission: ""
```

What to change:

```yml
id: lowercase-unique-id
name: "&b&lGuide Name"
description:
  - "&7Short menu description."
category: getting-started
icon: BOOK
permission: ""
```

Leave `permission: ""` unless the guide should be permission-locked.

### Message Step

Use this when the guide should show normal text.

```yml
  - type: MESSAGE
    lines:
      - " "
      - "&b&m                                                  "
      - "              &b&lSection Title"
      - " "
      - "  &7Write the guide text here."
      - "  &7Add more lines if needed."
      - "&b&m                                                  "
      - " "
```

### Suggested Command Step

Use this when the player should click a button to put a command in chat.

```yml
  - type: COMMAND_SUGGEST
    message: "  &7Click below to put the command in chat:"
    command: "/guides"
    button:
      text: "  &e&l[open guides menu]"
      hover: "&7Click to suggest /guides in chat."
```

Change these fields:

```yml
message: "  &7Click below to put the command in chat:"
command: "/yourcommand"
button:
  text: "  &e&l[button text]"
  hover: "&7Hover text."
```

### Title Step

Use this for a big title on screen.

```yml
  - type: TITLE
    title: "&b&lMain Title"
    subtitle: "&7Subtitle text"
```

### Bossbar Step

Use this for a temporary bossbar message.

```yml
  - type: BOSSBAR
    text: "&bBossbar message"
    color: BLUE
    style: SOLID
    seconds: 8
```

### Actionbar Step

Use this for a small message above the hotbar.

```yml
  - type: ACTIONBAR
    message: "&aGuide complete!"
```

### Sound Fields

Sound is optional. Add it under a step only if needed.

```yml
    sound: ENTITY_EXPERIENCE_ORB_PICKUP
    volume: 0.7
    pitch: 1.15
```

Some steps may use this format instead:

```yml
    sound:
      name: BLOCK_NOTE_BLOCK_PLING
      volume: 0.7
      pitch: 1.35
```

### End Step

Every guide should end with this:

```yml
  - type: END
```

### Reload After Editing

```
/cozyguides reload
```

Then open the guide in game and click through it.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.cozycrafters.net/plugin-docs/cozyguides/creating-guide-content.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.