Skip to content

Dwarf-Community/Dwarf

Repository files navigation

Dwarf — Discord Web Application Rendering Framework

Dwarf is a framework for developers designed to make it easy to enhance Discord while staying out of your way.

The straightforward extension system allows you to create or download extensions that provide useful additional functionality, such as economy, music, basic RPG elements and more. Extensions can be submitted to DwEI, the Dwarf Extension Index, from where they are easily accessible to everybody. Dwarf and its extensions build the foundation for your app, so you can focus on writing the actual app without reinventing the wheel.

Dwarf was built on top of Django and discord.py to get your Discord web app from concept to reality as quickly as possible. It does a lot of the heavy lifting for you, such as database connectivity, caching, user authentication and bot sharding. Every Dwarf app consists of a Discord bot, a web frontend and an API. Dwarf uses Redis to allow instant communication between the frontend and the backend via a straightforward cache API layer.

Every part of Dwarf is extendable, meaning that every extension can add new data models, REST API URLs, web frontend views, elements to views of other extensions, bot commands, background tasks, message broker channels, or something completely new. Your imagination is the limit!

Getting Started

Want to spin up your own Dwarf instance to develop an app or extension? This wiki article guides you through the installation process.

Extensions are themselves very powerful. If you want to build an extension and maybe even submit it to DwEI, check out these handy instructions on how to start developing a new extension.

Let's forge some great apps that make Discord even more awesome!

Still have some questions? Need some help? Want to check out what others have built? Join us on Discord!