Create a Plugin Folder

(View Table of Contents)

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.

Tip
The conventions take a little getting used to at first, but you’ll find they save you time in the long run. You won’t be constantly writing code to tell the game where to find new files - it will just find them automatically as long as you put them in the right place.

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

Note
The folder name must be one word, all lowercase, containing only letters and numbers.

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.