https://github.com/nirokay/nimwit

An open-source, general-purpose discord bot written in Nim.
https://github.com/nirokay/nimwit

discord-bot discordbot nim-lang nimble

Last synced: about 1 month ago
JSON representation

An open-source, general-purpose discord bot written in Nim.

• Host: GitHub
• URL: https://github.com/nirokay/nimwit
• Owner: nirokay
• License: gpl-3.0
• Created: 2022-12-26T06:57:21.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-03-30T21:39:36.000Z (10 months ago)
• Last Synced: 2024-03-30T22:28:29.296Z (10 months ago)
• Topics: discord-bot, discordbot, nim-lang, nimble
• Language: Nim
• Homepage:
• Size: 12.9 MB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Nimwit discord bot

## About

Nimwit is yet another general-purpose discord bot written in Nim. Most features are taken from my prior discord bot development ventures and also come from my friend group. If you have a feature request, feel free to open a GitHub issue! :)

You can of-course [invite the bot](https://discord.com/api/oauth2/authorize?client_id=1056828609265926145&permissions=277092625472&scope=bot) to your server (should be online pretty much 24/7).

## Features

You can read up on all features in the [markdown wiki](docs/Wiki.md). It contains information about commands and their usages and information about some bot features, such as [economy](docs/wiki/Economy.md).

## Compiling and Hosting

Compiling to an executable is very easy. Simply run `make build` or `nimble build -d:ssl` in your terminal. This will compile all nim source code into a single executable.

You will still need the `public` and `private` directories next to your executable though, as configuration and your token is stored inside there.

## Changes

See [here](docs/Changes.md) for a changelog and roadmap for this project.

## File structure

See [here](docs/FileStructure.md) for information about the porjects file structure.

## Dependancies and Credits

System Dependancies:

- [nim](https://nim-lang.org/) (required to compile)

Nimble Dependancies:

* [dimscord](https://nimble.directory/pkg/dimscord) (Discord API library)

* [pixie](https://nimble.directory/pkg/pixie) (2D graphics library)

Optional:

- [GNU Make](https://www.gnu.org/software/make/) (Makefile build tool, see [Compiling and Hosting](#Compiling-and-Hosting))