> For the complete documentation index, see [llms.txt](https://hexose.gitbook.io/dx-modding-guide/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hexose.gitbook.io/dx-modding-guide/welcome-to-the-dx-modding-guide.md).

# Welcome to the DX Modding Guide!

its free!!\
first time using gitbook hopefully i'm doing this right

## Getting started

if you wanna see a homebrew mod in action you can check out [Example Mods](/dx-modding-guide/basic-tutorials/example-mods.md)!\
\
mods are stored in %appdata%/FNF\_FREE\_DOWNLOAD/Homebrew\
still havent renamed the project!! oops (its in roaming instead of local though so it shouldn't mess with your savedata)

## (not so) Frequently Asked Questions

### Q: Can I port songs directly from Psych Engine? (or anything else)

A: with a bit of fixing.. yeah! (kinda)\
the psych engine lua api and fnf's chart format is a lot different than fnffd's, so you'd have to start from scratch (recharting, remaking midsong events, converting spritesheets, etc)

### Q: How do I change how my mod looks in the Homebrew menu?

A: check out [Metadata](/dx-modding-guide/file-structure/metadata.md)!

### Q: How do I add an entire weeknd/more than 1 song?

A: custom weeknds and menus are unfinished right now (oops)

### Q: Why can't I use some built-in variables?

A: oopsies\
most likely the lua api never gets access to it! if theres anything important that i've missed then i'll add it\
\
for a quick fix you could probably use [loadGML](/dx-modding-guide/lua-api/working-with-gml.md)

### Q: Why'd this take so long?

A: started to get a little demotivated and went to work on other things, probably should've said something sooner.. oops


---

# 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, and the optional `goal` query parameter:

```
GET https://hexose.gitbook.io/dx-modding-guide/welcome-to-the-dx-modding-guide.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.