craftquest/buggy

Put bugs in your control panel and then learn how to use Xdebug via CraftQuest.

3.0.0-beta.1 2024-02-15 03:24 UTC

Requires

• craftcms/cms: ^5.0.0-beta.1

Requires (Dev)

• codeception/codeception: ^3.0
• craftcms/cms: ^5.0.0-beta.1
• vlucas/phpdotenv: ^3.0

MIT

• CraftQuest

• debugging
• cms
• Xdebug
• bugs
• Craft
• control panel
• craftcms
• craft-plugin
• buggy

README

Buggy lets you add a fun bug infestation to your Craft Control Panel.

Requirements

This plugin requires Craft CMS 4.0.0 or later.

Installation

To install the plugin, use the Craft Plugin Store or follow these instructions:

1. Open your terminal and go to your Craft project:

    cd /path/to/project
   

2. Then tell Composer to load the plugin:

    composer require craftquest/buggy
   

3. In the Control Panel, go to Settings → Plugins and click the “Install” button for Buggy.

Buggy Overview

Buggy has two modes:

1. Automatic Bug Spawning: Learn how to debug using Xdebug by solving bugs in the code. The number of bugs crawling on the screen is related to the number of bugs in the code.
2. Manual Bug Spawning: Generate and exterminate bugs using a simple interface. The bugs you generate will appear in the Control Panel.

Configuring Buggy

By default Buggy is turned on to Automatic Bug Spawning. If you turn off Automatic Bug Spawnig and haven't created any bug swarms manually, then you can get rid of the bugs.

The Automatic Bug Spawning will only work if the small code bugs shipped with Buggy remain unfixed. Manual Bug Spawning requires you to create bug using the interface.

Automatic Bug Spawning

Automatic Bug Spawning exists as a learning tool for the Debugging with Xdebug course from CraftQuest.io.

The bugs are spawned based on the number of software bugs the system detects. As each bugs is fxied, the nunber of bugs spawned is reduced until there are no more bugs.

At that point, you can enable Manual Bug Spawning, so you don't miss your crawling friends!

Manual Bug Spawning

To set up Manual Bug Spawning, copy the contents of example index.twig template in vendor/craftquest/example-templates to a template in your template directory.

Load that template in your web browser and you should see an interface for creating new bug swarms. Click the button "Create Swarm" and Buggy will automatically generate a new swarm of random size.

To get rid of the swarm, use the Spray Swarm button next to each swarm.

To get rid of the bugs on the screen you can just toggle off Manual Bug Spawning to remove the bugs completely.

Credits

• Andrew Welch at NyStudio107 for ideas and help
• AUZ Bug - the library this plugin uses to get the bugs on your screen.

Brought to you by Ryan Irelan