> For the complete documentation index, see [llms.txt](https://devmosaic.gitbook.io/devmosaic/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://devmosaic.gitbook.io/devmosaic/resources/devmosaic-connect-ui/icons.md).

# Icons

Dm-connectui includes a preloaded library of 50 custom vector icons optimized for button rows.

***

### Configuring Icons

To set an icon on a button, assign its key to the `icon` field of the action in `config.lua`:

```lua
Config.Actions = {
    { title = 'enter', type = 'submit', action = 'enter_server', icon = 'play', primary = true },
    { title = 'discord', type = 'url', url = 'https://discord.gg/...', icon = 'discord' },
}
```

***

### Icon Library

| Key Name     | fallback Aliases                  | Graphic Representation                                |
| ------------ | --------------------------------- | ----------------------------------------------------- |
| `play`       | `enter`, `connect`                | Double chevron right arrow (`>>`)                     |
| `bag`        | `tebex`, `store`, `shop`          | Clean outline shopping bag                            |
| `discord`    | —                                 | Official Discord game controller mask                 |
| `doc`        | `rules`, `docs`, `readme`         | Monospaced document sheet with text lines             |
| `globe`      | `web`, `website`, `site`          | Grid globe with equator line                          |
| `key`        | `whitelist`, `register`           | Key with teeth outline                                |
| `info`       | `about`, `help`                   | Circle surrounding info dot and letter line           |
| `user`       | `profile`, `character`, `players` | User head & shoulder silhouette                       |
| `gear`       | `settings`, `config`              | Detailed mechanical gear cog                          |
| `map`        | `location`, `gps`                 | Tri-folded map blueprint lines                        |
| `heart`      | `donate`, `vip`                   | Clean love heart vector                               |
| `shield`     | `admin`, `staff`                  | Shield blueprint crest                                |
| `car`        | `vehicle`, `garage`               | Front-facing vehicle grill and wheels                 |
| `gun`        | `weapon`, `armory`                | Tactical handgun silhouette                           |
| `briefcase`  | `jobs`, `work`                    | Handle-carrying briefcase outline                     |
| `money`      | `bank`, `economy`                 | Banknote bill with center coin circle                 |
| `chat`       | `forum`, `support`                | Monospaced chat bubble with text pointer              |
| `bell`       | `updates`, `news`                 | Notification alarm bell with ringer                   |
| `book`       | `lore`, `guide`                   | Open handbook blueprint lines                         |
| `star`       | `favourite`, `features`           | Five-point vector star                                |
| `trophy`     | `leaderboard`, `stats`            | Championship trophy cup with dual handles             |
| `gift`       | `rewards`, `claims`               | Ribbon-wrapped gift present box                       |
| `home`       | `housing`, `properties`           | High-roof house profile with door                     |
| `lock`       | `security`                        | Locked shackle padlock                                |
| `unlock`     | `access`                          | Open shackle padlock                                  |
| `plug`       | `status`, `connection`            | Power plug prongs and wire                            |
| `server`     | `host`                            | Stacked rack server drawers with LED indicator lights |
| `wrench`     | `dev`, `changelog`                | Open-ended mechanic wrench                            |
| `search`     | `find`                            | Magnifying glass lens and handle                      |
| `hammer`     | `rules`, `legal`                  | Gavel mallet                                          |
| `crown`      | `owner`, `premium`                | Royal crown peaks and base line                       |
| `code`       | `api`                             | Programming bracket tag tags (`</>`)                  |
| `download`   | `files`, `install`                | Downward arrow and floor plate line                   |
| `tv`         | `stream`, `media`                 | Desktop computer monitor screen and stand             |
| `camera`     | `gallery`, `photos`               | Camera lens and flash block                           |
| `microphone` | `voice`, `teamspeak`              | Stand-alone vocal studio microphone                   |
| `headphones` | `radio`, `audio`                  | Over-ear headphones band and cups                     |
| `folder`     | `assets`                          | File folder directory tab                             |
| `trash`      | `clear`                           | Wastebasket recycling bin with lid handle             |
| `refresh`    | `restart`                         | Circular reload arrow                                 |
| `compass`    | `hud`                             | Circular compass navigation needle                    |
| `phone`      | `mobile`, `call`                  | Smartphone outline with home button                   |
| `envelope`   | `mail`, `contact`                 | Folded letter mail envelope                           |
| `clock`      | `schedule`, `time`                | Clock face with hour and minute hands                 |
| `eye`        | `rules`, `observe`                | Eyelid and pupil vector                               |
| `unlink`     | `leave`, `exit`                   | Left vertical line with right exit arrow              |
| `link`       | `connect`, `bind`                 | Intertwined chain link loops                          |
| `sparkles`   | `new`, `special`                  | Retro sparkle diamond star bursts                     |
| `gamepad`    | `minigames`, `arcade`             | Retro gaming console D-Pad and buttons                |
| `share`      | `invite`                          | Connected nodes network sharing forks                 |
