Introduction

Welcome to Wolfringo library usage guide. If you don't know what Wolfringo is - please check Home Page.

Please check navigation on the left ⬅ (or in menu ☰ on mobile devices) for more articles.

Requirements

Wolfringo library should work with any framework version supported by .NET Standard 2.0 or greater. However, it is guaranteed only with .NET Core 2.0 and up and .NET 5 and up - I did not test .NET Framework, Mono, Xamarin or Unity.

This documentation assumes you have decent knowledge of C# Language and asynchronous programing.

If using Wolfringo.Hosting

Wolfringo.Hosting is an optional addon package that enables support for .NET Generic Host/ASP.NET Core. If you're willing to use it, you should have basic understanding of these .NET scenarios.

Wolfringo.Hosting fully supports breaking changes introduced with ASP.NET Core 3.0 through multi-targeting. Wolfringo.Hosting only works with .NET Core.

Getting Started

Installation and creation of your first bot is explained in Getting Started section.

For more details on how to use Wolfringo, check Working with Wolfringo section.

To learn how to use Commands System for your bots' commands, check Commands System section.

Customizing Wolfringo

Wolfringo utilizes Dependency Injection to allow customization of the library behaviour - many parts of both client and commands system can be configured or even replaced without the need to rewrite everything.

Check Customizing guides for more info!

Questions?

To ask questions or share ideas, feel free to start a new GitHub Discussion.

Any bugs? Requesting a specific feature? Please create a new Issue on GitHub.

To contact me directly, you can PM me on Discord. You can also find me on WOLF - but I cannot guarantee quick replies there, so Discord is preferred.