https://github.com/kalilistic/dalamud.drunkentoad
A set of common utilities to use in dalamud plugins.
https://github.com/kalilistic/dalamud.drunkentoad
dalamud dalamud-plugin
Last synced: 4 months ago
JSON representation
A set of common utilities to use in dalamud plugins.
- Host: GitHub
- URL: https://github.com/kalilistic/dalamud.drunkentoad
- Owner: kalilistic
- License: mit
- Created: 2020-09-26T23:56:30.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-01-04T20:41:02.000Z (4 months ago)
- Last Synced: 2025-01-04T21:28:15.407Z (4 months ago)
- Topics: dalamud, dalamud-plugin
- Language: C#
- Homepage:
- Size: 14.6 MB
- Stars: 7
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Dalamud.DrunkenToad
A set of utilities to use in developing dalamud plugins. Equal in prestige to its in-game namesake.
## Features
- Provides thread-safe sorted collection type.
- Provides IPCs consumer for integrating with other dalamud plugins.
- Provides custom models for working with common game data objects.
- Provides Dalamud context service that instantiates dalamud services and custom service wrappers.
- Provides custom service classes to handle common tasks like managing player lists.
- Provides wrapper classes for Dalamud services to provide helper methods for common tasks.
- Provides extension classes for adding object helper methods.
- Provides localized ImGui components backed using Dalamud.Loc.
- Provides utility classes for common tasks.
- Provides a set of common ImGui components.
## How to use
Add as a submodule to your plugin project.
## Examples
### Using static context
```csharp
if (!DalamudContext.Initialize(pluginInterface))
{
PluginLog.LogError("Failed to initialize properly.");
return;
}
```
### Using dependency injection
```csharp
var services = new ServiceCollection();
var toadServiceInitializer = new ToadServiceInitializer(pluginInterface);
toadServiceInitializer.AddDalamudServices(services);
toadServiceInitializer.AddToadServices(services);
var serviceProvider = services.BuildServiceProvider();
```