AresMUSH
A New Breed of MUSH Server

Create a Plugin Folder

Plugins use a convention-based structure. That means the game engine is going to look for things in certain places and with certain naming conventions. If you don’t have things in the right place, it won’t work - even if your code is otherwise correct.

Your plugin must live in a folder under aresmush/plugins/<your plugin name>.

We can use the create plugin script to create our plugin directory structure:

bin/script create_plugin,cortex

This will create the following folder structure:

aresmush/plugins/cortex
    cortex.rb
    help
    locales
        locale_en.yml
    commands

You may notice that some plugins also have other directories for organizational purposes, but these are the basic ones.

This article is part of the Creating a Plugin tutorial.