Command Line KRelay Plugin Generator

kgen

kgen is a Node.js based CLI (command line interface) written in JavaScript used for generating KRelay Plugin boilerplate projects.

I made this because I like to experiment with KRelay so I'm always making new projects, and it's the same steps every time (add Lib K Relay, add reference, implement IPlugin, etc) which takes a couple seconds. With this tool it now takes just milliseconds to do these steps.

How to install

1. Install Node.js (google nodejs to find the download)
2. Download the .rar in this post
3. Put the folder inside the rar anywhere on your computer
4. Open a command prompt and navigate to that folder
5. Type 'npm install -g'

How to use

1. Open a command prompt and navigate to the folder you normally put your krelay plugins in
2. Type 'kgen -n ProjectName -a "Killer Be Killed"'

The -n flag is the name of the project
The -a flag is the author of the plugin

You can also add a '--structured' flag which will generate a more structured project (e.g. has folders to organise things)
E.g. ' kgen -n MyLargeProject -a "Killer Be Killed" --structured'

An example of a command and its output:



...And the files it generates:


Everything in the second image is generated by this tool and can be opened by Visual Studio straight away. The C# project file will already have a reference to Lib K Relay as well.

The first time a project is opened it may take a little bit longer because Visual Studio generates the output folders, so don't panic if it looks like it froze while opening.

As usual, this is open source and on my GitHub. There is a much better documentation on there as well as some more examples of how to generate a plugin.
Just google 'github thomas-crane', go to my profile and look at the 'kgen' repository to find it

Virus Scans:
Virus Total. (0/56)
Jotti. (0/18)