Provided under MIT license
Fork this repo when creating a new plugin for Essentials. For more information about plugins, refer to the Essentials Wiki Plugins article.
After forking this repository into your own GitHub space, you can create a new repository using this one as the template. Then you must install the necessary dependencies as indicated below.
The Essentials libraries are required. They referenced via nuget. You must have nuget.exe installed and in the PATH
environment variable to use the following command. Nuget.exe is available at nuget.org.
Nuget commands will run if the Nuget.exe is in the same folder your command prompt is attempting to run the Nuget commands in. Follow the following link to add the Nuget.exe to your Windows systems local variable environmental path. Directions on how to proceed are located on stackoverflow.com.
To install dependencies once nuget.exe is installed, run the following command from the root directory of your repository:
nuget install .\packages.config -OutputDirectory .\packages -excludeVersion
.
To verify that the packages installed correctly, open the plugin solution in your repo and make sure that all references are found, then try and build it.
If you need a different version of PepperDash Core, use the command nuget install .\packages.config -OutputDirectory .\packages -excludeVersion -Version {versionToGet}
. Omitting the -Version
option will pull the version indicated in the packages.config file.
See the Task List in Visual Studio for a guide on how to start using the templage. There is extensive inline documentation and examples as well.
For renaming instructions in particular, see the XML remarks
tags on class definitions