Warning! This plugin is no longer maintained. It may work in recent Moodle versions but there is no support. For details of how you can become the new maintainer, see Plugins adoption programme.

This tool allows developers to quickly generate code skeleton for Moodle plugins. Relevant code is generated according to defined list of requested plugin features.

Usage

Plugin features and other properties are described in so called recipe files. Recipes use YAML syntax.

    name: Moodle demo plugin
    component: tool_demo
    release: "0.1.0"
    requires: "3.9"
    maturity: MATURITY_ALPHA
    copyright: 2021 David Mudrák 

    features:
      readme: true
      license: true
      settings: true

    privacy:
      haspersonaldata: false

For full list of supported options, see cli/example.yaml file.

To generate skeleton of the plugin described in ./myplugin.yaml:

    $ php cli/generate.php myplugin.yaml

Run generate.php --help for more options and features.

Documentation

See the page Plugin skeleton generator at moodle docs site.

Installing from Git

1. Go to the folder with your Moodle development installation:

   $ cd {your/moodle/dirroot}

2. Clone this repository to the correct location folder:

   $ git clone https://github.com/mudrd8mz/moodle-tool_pluginskel.git admin/tool/pluginskel

3. Complete the installation:

   $ sudo -u www-data php admin/cli/upgrade.php

or just log in to your Moodle development site as an admin.