create-cssharp-plugin v0.3.1

Create CounterStrike Sharp Plugin

Bootstrap your CounterStrike Sharp plugin project in no time at all!

create-cssharp-plugin offers a mighty fine project template to get you started quickly.

Features

• Generates a .sln file with your .csproj already referenced*
• Bootstraps a .cs entry file with Module(.*) fields populated based on input
• Comes with a complementary .gitignore out of the box!

* dotnet CLI must be installed

Planned and potential features

• git init
• Unit test template
• Opinionated project structure (directories for commands, hooks, etc.)
• GitHub actions release workflow (build plugin and generate GH release with plugin artifacts attached)

Prerequisites

You can get NodeJS by going to their website and selecting your OS, node version, and package manager.\ https://nodejs.org/en/download

The dotnet CLI should come with .NET SDK.\ Install .NET SDK\ Linux - Windows

Learn more: https://learn.microsoft.com/en-us/dotnet/core/tools/

Installation

Run using your favourite package manager:

Run on-demand via npm:

npx create-cssharp-plugin

OR install as a command globally:

npm install -g create-cssharp-plugin
create-cssharp-plugin

Run on-demand via yarn:

yarn exec create-cssharp-plugin

OR install as a command globally:

yarn global add create-cssharp-plugin
create-cssharp-plugin

Run on-demand via pnpm:

pnpm dlx create-cssharp-plugin

OR install as a command globally:

pnpm add -g create-cssharp-plugin
create-cssharp-plugin

Usage

Follow the prompts to generate your CounterStrike Sharp plugin!

Projects generated using create-cssharp-plugin have the following structure:

./projectName
├── projectName.sln
├── src
│   ├── pluginName.cs
│   └── pluginName.csproj
└── test

!NOTE create-cssharp-plugin will create a project directory relative to your current working directory.

Contributing

1. Clone this repository

git clone https://github.com/uFloppyDisk/create-cssharp-plugin.git
cd create-cssharp-plugin

2. Install dependancies

npm install

3. Open another shell and watch for changes

npm run dev

4. Run the CLI

npx .

When running the CLI this way, all plugin projects will be placed in the .playground directory to avoid mixing with the rest of your filesystem and this repo's files.