Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
CloudTheWolf committed Aug 5, 2023
2 parents c4d83e3 + d6b0cab commit f3b2bf6
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,20 @@ This uses the fillowing libraries:
* [CloudTheWolf.DSharpPlus.Scaffolding.Logging](https://github.com/CloudTheWolf/CloudTheWolf.DSharpPlus.Scaffolding.Logging) - This acts as your basic logger and handles logging for both the main application and plugins

* [CloudTheWolf.DSharpPlus.Scaffolding.Data](https://github.com/CloudTheWolf/CloudTheWolf.DSharpPlus.Scaffolding.Data) - This is the main connection between you and your Database. Currently it only supports MySql and Microsoft SQL Server.

# Help, my plugins don't work in Version 4.0
First of all, as with any update to the Scaffolding, please make sure your plugins are using the correct version of [CloudTheWolf.DSharpPlus.Scaffolding.Shared](https://github.com/CloudTheWolf/CloudTheWolf.DSharpPlus.Scaffolding.Shared)

Next, you will now need to put each individual plugin in it's own directory within the pluging folder.

Eg for a Plugin called Example you would now put it in `/Plugins/Example` instead of just adding it to `/Plugins`

## Why the change?
This change is a bit of a big one, and is sort of a double edge sword.

First of this means that if you have multiple plugins that share the same dependancies, putting them in seperate folders will basically double the space requirements.
You are free to put all your plugins in a single "Master" directory, however this also means the benifits of this change are lost.

Now, what are these benifits of this new design?
First if all, you can now easilly add/remove plugins to help diagnose issue with your bot.
This also means you can fully remove a plugin and all of its dependancies without the risk of removing a shared depandancy that another plugin may use.

0 comments on commit f3b2bf6

Please sign in to comment.