=== AIML Hangman ===
Contributors: aiml-games
Tags: games, education, hangman, ai, machine learning, word games, learning, quiz
Requires at least: 5.8
Tested up to: 6.6
Stable tag: 1.0.0
Requires PHP: 7.4
License: GPL v2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html

An educational Hangman game focused on AI and machine learning concepts, part of the AIML Games Framework.

== Description ==

AIML Hangman is an educational word-guessing game that teaches players about artificial intelligence and machine learning terminology. Players guess letters to reveal hidden words related to AI concepts, making learning fun and interactive.

### Key Features

* **Educational Focus**: Learn AI/ML terminology through gameplay
* **Framework Integration**: Seamlessly integrates with the AIML Games Framework
* **Flexible Gameplay**: Timed and relaxed modes for different learning styles
* **Progressive Difficulty**: Words of varying complexity
* **Comprehensive Scoring**: Points for correct letters, word completion, and speed
* **Leaderboard System**: Compete with other players
* **Analytics Tracking**: Detailed performance metrics
* **Mobile Responsive**: Works on all devices
* **Accessibility Compliant**: WCAG 2.1 accessible design

### Game Mechanics

* Guess letters to reveal AI/ML related words
* Visual hangman drawing with SVG graphics
* Hints system for educational support
* Multiple words per game session
* Score calculation based on accuracy and speed
* Support for both anonymous and registered users

### Integration Features

* Uses framework's word management system
* Shares leaderboard and analytics with other games
* Consistent admin interface across all games
* Centralized user management and progress tracking

== Installation ==

### Automatic Installation

1. In your WordPress admin, go to **Plugins > Add New**
2. Search for "AIML Hangman"
3. Click **Install Now**
4. Activate the plugin

### Manual Installation

1. Download the plugin ZIP file
2. Upload to your `/wp-content/plugins/` directory
3. Activate the plugin through the **Plugins** menu in WordPress
4. Ensure the AIML Games Framework is also installed and activated

### Requirements

* WordPress 5.8 or higher
* PHP 7.4 or higher
* AIML Games Framework plugin (required)
* MySQL 5.6 or higher

== Usage ==

### Basic Usage

1. **Shortcode Method**: Add `[aiml_hangman]` to any page or post
2. **CPT Method**: Create a new "Game" post and select "Hangman" as the game type
3. **Widget Method**: Use the AIML Games widget in any widget area

### Shortcode Parameters

```
[aiml_hangman
    theme="agents"           # Word theme (agents, neural, optimization)
    mode="normal"           # Game mode (normal, relaxed)
    timer="true"            # Enable timer (true/false)
    words_count="10"        # Number of words (1-50)
    time_limit="120"        # Time limit in seconds (30-600)
    show_hints="true"       # Enable hints (true/false)
    difficulty="medium"     # Difficulty level (easy, medium, hard, any)
    leaderboard="true"      # Show leaderboard (true/false)
    user_tracking="true"    # Enable user tracking (true/false)
]
```

### Example Shortcodes

Basic game with default settings:
```
[aiml_hangman]
```

Timed game with AI agents theme:
```
[aiml_hangman theme="agents" mode="normal" timer="true" time_limit="90"]
```

Relaxed learning mode with hints:
```
[aiml_hangman mode="relaxed" show_hints="true" timer="false"]
```

### Creating Custom Games

1. Create word posts in the **Words** post type
2. Assign themes and difficulty levels to words
3. Create a new **Game** post
4. Select "Hangman" as the game type
5. Choose specific words or let the system select randomly
6. Configure game settings (timer, hints, login requirements)
7. Publish and embed using the game's URL or shortcode

== Frequently Asked Questions ==

### Do I need the AIML Games Framework?
Yes. AIML Hangman requires the AIML Games Framework plugin to function properly. The framework provides core functionality like user management, analytics, and the leaderboard system.

### Can anonymous users play?
Yes. The game supports both anonymous and registered users. However, some features like progress tracking require user accounts.

### How are words selected?
Words are selected from the framework's word database. You can assign specific themes, difficulty levels, or let the system choose randomly for varied gameplay.

### Is the game mobile-friendly?
Yes. AIML Hangman is fully responsive and works on all devices including smartphones, tablets, and desktop computers.

### Can I customize the scoring system?
Yes. Scoring can be adjusted through the framework settings or individual game settings. Default scoring values are optimized for balanced gameplay.

### How do I add my own words?
Words are managed through the framework's word management system. Create new word posts with definitions, and they'll be available for use in Hangman games.

== Screenshots ==

1. Game interface with hangman drawing and word display
2. Virtual keyboard for letter selection
3. Game completion modal with scoring and statistics
4. Leaderboard showing top players
5. Admin interface for game configuration

== Changelog ==

= 1.0.0 =
* Initial release
* Core Hangman gameplay implementation
* Framework integration complete
* Admin interface for game configuration
* Mobile-responsive design
* Accessibility compliance
* Analytics and leaderboard integration
* Hint system implementation
* Timed and relaxed game modes
* Custom scoring system
* SVG-based hangman graphics

== Upgrade Notice ==

= 1.0.0 =
Initial release. Requires AIML Games Framework 1.0.0 or higher.

== Additional Information ==

### Game Philosophy

AIML Hangman is designed to make learning about artificial intelligence and machine learning concepts engaging and accessible. The game uses proven educational gaming principles to reinforce terminology and concepts in a fun, interactive way.

### Educational Value

Each word in the game includes a comprehensive definition, helping players understand not just the terminology but also the underlying concepts. The hint system encourages learning while maintaining game engagement.

### Technical Features

* Object-oriented PHP architecture following WordPress standards
* Secure AJAX handling with nonce verification
* Rate limiting to prevent abuse
* Comprehensive error handling and logging
* Database optimization for high-traffic sites
* CDN-friendly asset management

### Accessibility

AIML Hangman is built with accessibility in mind:

* Full keyboard navigation support
* Screen reader compatible
* High contrast mode support
* Reduced motion preferences respected
* ARIA labels and descriptions throughout

### Performance

Optimized for performance on shared hosting:

* Minimal database queries
* Efficient asset loading
* Client-side caching strategies
* Server-side optimization
* Progressive enhancement approach

== Support ==

For support, documentation, and updates:

* **Plugin Documentation**: Available in the WordPress admin under AIML Games Framework
* **Support Forum**: WordPress.org support forums
* **GitHub Repository**: Report issues and contribute
* **Developer Documentation**: Comprehensive API documentation available

== Credits ==

* **Lead Developer**: AIML Games Team
* **Educational Content**: AI/ML subject matter experts
* **UI/UX Design**: Educational gaming specialists
* **Framework**: Built on the AIML Games Framework

== License ==

AIML Hangman is released under the GNU General Public License (GPL v2 or later).

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.