Conch Plugin Manager (WIP)

This is a CounterStrikeSharp plugin for CS2 that helps you install, update, and remove other plugins that are hosted on Github.

Supported Plugins

For the most part, if a plugin is packaged as a release (in zip format) on Github, you should be able to use Conch Plugin Manager to install it.

Notably, plugins that are only available in the repo itself as well as plugins that are packaged as .rar are unsupported, though I plan to add support for these in the future.

Other Considerations

• This is a work in progress. In the future I might make breaking changes. Also, since I'm still developing this, logging is pretty verbose.
• CPM queries Github once per package per update, and you will be rate limited if you reach Github's 60 query/hour limit. If you don't want to deal with this rate limit, there is a auth token option in the plugins config file.
• You cannot use CPM to manage plugins that were installed manually. If you want CPM to manage these plugins, you'll have to reinstall them using CPM.
• When files are installed to your server, any conflicting files will be overwritten. I plan on making installs safer in the future, but for now this is a (very unlikely) possibility

How to Use

Install

css_cpm_install <github_author>/<repository_name>

For example, to install newix's Soccerball ⚽ plugin, use !cpm_install newix1/cssharp-soccerball.

Once installed, CPM will attempt to load the plugin as well.

Update

When you install a plugin using CPM, it will automatically be updated on server restart or when the plugin is reloaded.

In addition, you can use command css_cpm_update_all to update all your plugins.

Remove

css_cpm_remove <github_author>/<repository_name> or css_cpm_remove <plugin_directory>

For example, to remove the Soccerball plugin, you can do either of the following:

!cpm_remove newix1/cssharp-soccerball or !cpm_remove Soccerball

This command only removes the plugin's directory in counterstrikesharp/plugins. It doesn't delete any configs or other files outside of this directory that were merged during installation.

List

css_cpm_list

This gives you a list of plugins managed by CPM including the tag name, download string, and folder name.

Default Config

{
    "ConfigVersion": 2,
    "GithubAuthToken": null,
    "UpdateOnMapChange": false,
    "UpdateOnServerStart": false,
    "UpdateOnReload": false
}

TODO:

• support rar
• support release contained in repo
• support releases that don't include folder
• support prereleases
• command to update individual plugin
• allow configure auto-update
• deal with conflicting files, especially on install
• track included files outside of plugin directory?