Granz

Version, currently 2.0.01 version
  • 2.0.0latestJul 24, 2020

github.com/GeopJr/Granz-cr

A Discord bot/framework(?) for Crystal

11 stars
0 dependents
License: MIT

Installation

# Add this to your shard.yml
dependencies:
  Granz:
    github: GeopJr/Granz-cr
    version: ~> 2.0.0

Then run:

shards install

shard.yml

Crystal
no constraint declared
License
MIT
Author
GeopJr <geopjr@geopjr.xyz>

Dependencies

Runtime Dependencies

  • bot_list*github: z64/bot_list, branch: master
  • discordcr*github: meew0/discordcr, branch: master
  • magickwand-crystal*github: blocknotes/magickwand-crystal

README

<div align="center">
<br />
  <p>
    <img src="https://i.imgur.com/90xR5vB.png"/>
  </p>
  <p>
    <img src="https://i.imgur.com/kG2PYbz.jpg" alt="Granz_avatar"/>
  </p>
  <br />
  <p>
    <a href="https://discordbots.org/bot/443053627419000833"><img src="https://discordbots.org/api/widget/status/443053627419000833.svg" alt="Discord_Bots" /></a>
    <img src="https://travis-ci.org/GeopJr/Granz-cr.svg?branch=master"/>
    <a href="https://github.com/meew0/discordcr"><img src="https://img.shields.io/badge/discord-cr-pink.svg" alt="discordcr" /></a>
    <a href="https://github.com/GeopJr/Granz_bot/blob/master/LICENSE"><img src="https://img.shields.io/badge/LICENSE-MIT-000000.svg" alt="MIT" /></a>
    <img src="https://github.com/GeopJr/Granz-cr/workflows/Docs/badge.svg" alt="DOCS" />
  </p>
</div>

# Granz-cr

A Discord Bot & Framework written in Crystal using discordcr

# How to install

- `shards install`
- Open config.json.example, replace the info with yours and rename to config.json
- Everthing should now work
- `crystal src/Granz.cr` or compile

# config.json

```json
{
  // Your bot's ID
  "client_id": 100000000000000000,
  // Your ID
  "my_id": 100000000000000000,
  // Bot version
  "version": 2,
  // Prefix
  "prefix": "--",
  // Support guild url (leave empty if none)
  "support_guild": "7XQNZGq",
  // Your tag
  "my_tag": "『Geop』#4066"
}
```

# Env Vars

```
GRANZ_BUILD: Set to true to build commands.md
GRANZ_BOTLIST: Set to true to use bot_list.cr
TOPGG_TOKEN: Set to top.gg token if any
BOTSGG_TOKEN: Set to bots.gg token if any
BOTSONDISCORD_TOKEN: Set to bots.ondiscord.xyz token if any
GRANZ_TOKEN: Set to bot's token
```

# Framework

#### You can use Granz as a base for your bot!

- Register commands dynamically
- Generate a markdown of all the commands
- Dynamic help command
- More More More!

### Thanks to [z64](https://github.com/z64) for helping me with both crystal and discordcr

# Invite it

[CLICK HERE](https://discordapp.com/oauth2/authorize?client_id=443053627419000833&scope=bot&permissions=103894080&redirect_uri=https://granz.geopjr.xyz/thanks.html&response_type=code)

# License

The Bot is using MIT License

# Copyrights

Granz's avatar is copyrighted under [Mentaiko Itto©](https://twitter.com/ittorasii)

<div align="center">
  <br />
  <p>
    <img src="https://i.imgur.com/HEtVbUc.png" alt="info"/></a>
  </p>
  </div>