# Tabler

Tabler is a simple bot that lets you create readable, simple or complex tables in your server. It uses a range of easy to understand options to let you create awesome looking tables.

## Get started

To create a table, you can use the `t!table` command. It takes two main arguments over two lines:

- The first line, right after the command, is where you provide options, such as `--singleLine`.
- The second line, and any subsequent lines, are used for the rows, columns and content of the table.

Here's an example of a simple table you can create with one option:

![Example](https://i.imgur.com/Or4TqC2.png "An example of a table made with Tabler")

Let's break it down:

- The command `t!table` is used along with an option, `--col(1).width=20`, and 3 rows of content
- The option `--col(1).width=20` tells the bot to set the first column's content (being `Name`, `Frederick` and `Bob`) to have a width of 20 spaces across.
- The table's rows and content are being split by a `|`, which tells the bot to make a new column

Pretty easy, isn't it?

## In-depth

### Options

| Option           | Description                                                  | Alias(es) | Default Value                         |
| ---------------- | ------------------------------------------------------------ | --------- | ------------------------------------- |
| lineOnAllRows    | Whether to add line separating each row, or only the top row | lineall   | Default: false (line only on top row) |
| singleLine       | Whether to only use one line (good for horizontal tables)    | sinline   | false                                 |
| border           | The template to use for specifying which characters to use for the table's borders<br />**Valid options:** honeywell, norc, ramac, void |           | honeywell                             |
| col(index/"all") | Used to modify specific or all column settings. A list of column options can be seen below. |           | not applicable                        |

| Option           | Description                                                  | Default Value         |
| ---------------- | ------------------------------------------------------------ | --------------------- |
| col.width        | The width of the column in spaces, must be greater than 0,   | auto (content length) |
| col.paddingLeft  | How many spaces to insert before the content                 | 0                     |
| col.paddingRight | How many spaces to insert after the content                  | 0                     |
| col.wordWrap     | Whether to wrap the content to the next line at the nearest space, or at a special character | false                 |
| col.truncate     | How many characters to display before wrapping to the next line. Used by default instead of word wrapping. | 100                   |
| col.alignment    | Which direction to align content in a row towards<br />**Valid options:** left, center, right | left                  |

### Default border templates available

![Honeywell](https://i.imgur.com/LUhNkSx.png) ![Norc](https://i.imgur.com/IsnCIys.png)

![Ramac](https://i.imgur.com/I7X4hvJ.png) ![Void](https://i.imgur.com/fDDxBJ9.png)

## Planned Features

- Automatic parsing of GitHub-flavoured tables in chat (detecting and displaying them properly)
- Custom border templates and the ability to create your own, use them alongside the defaults, and share them with others
- An option for a custom prefix
- A command to manually convert a GitHub-flavoured table
- The ability to save tables per-user and share them across servers, or upload them to a service like Pastebin

All coming really soon 😊

## Need help?

Join the [support server](https://discord.gg/g26BXqX) to request help and suggest features or report bugs.

Tabler

A bot that helps make & display simple and complex tables

Votando por Tabler

¿Quieres apoyarnos?