> 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/lua-api/assets/sprites.md).

# Sprites

these are similar to psych engine lua sprites! (in a way)

### addSprite(name: String, path: String, frames: Int, originX: Float, originY: Float)

add a sprite for use in scripts\
path will start from the mod's folder

EXAMPLE:

```lua
function onCreatePost()
    addSprite("mybackground","assets/awesomebackground.png",1,0,0) -- sprite origin here is top left
    
    --[[
        COOL TIP BECAUSE I DONT FEEL LIKE MAKING AN ACTUAL EDITOR FOR THIS
        
        if you wanna make it easier to set origin points then place a red pixel in
        an art software of your choice and see what the x and y position is
        if you put that into originX and Y it should be centered around that point
        
        i use paint.net but anything should work as long as you can see the position
    ]]-
end
```

### getSprite(name: String)

gets a sprite you added

EXAMPLE:

```lua
function onCreatePost()
    -- sprite adding stuff goes here
    
    obj_backgroundp1.sprite_index = getSprite("mybackground")
end
```


---

# 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/lua-api/assets/sprites.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.