=== AIML Word Scramble ===
Contributors: rubenramirez
Tags: education, games, ai, machine learning, word scramble
Requires at least: 5.0
Tested up to: 6.4
Stable tag: 1.0.0
Requires PHP: 7.4
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html

Educational word scramble game for AI and machine learning concepts - part of AIML Games Framework.

== Description ==

AIML Word Scramble is an educational game plugin that helps users learn AI and machine learning terminology through interactive word scramble puzzles. This plugin is part of the AIML Games Framework ecosystem.

**Key Features:**

* **Educational Content**: Pre-loaded with AI and ML terminology
* **Multiple Game Sets**: Organized by topics (AI Agents, Neural Networks, Optimization)
* **Flexible Gameplay**: Normal mode with scoring or relaxed mode for learning
* **Leaderboard System**: Track high scores and compete with others
* **Hint System**: Definitions available for learning support
* **Responsive Design**: Works on desktop and mobile devices
* **Analytics Integration**: Track player progress and performance
* **Achievement System**: Unlock achievements for various accomplishments

**Game Modes:**

* **Normal Mode**: Race against time with full scoring system
* **Relaxed Mode**: Learn at your own pace without time pressure

**Requirements:**

This plugin requires the AIML Games Framework plugin to function properly. The framework provides shared services like user management, analytics, and leaderboard functionality.

== Installation ==

1. Install and activate the AIML Games Framework plugin first
2. Upload the `aiml-word-scramble` folder to the `/wp-content/plugins/` directory
3. Activate the AIML Word Scramble plugin through the 'Plugins' menu in WordPress
4. Go to the AIML Games > Word Scramble menu to configure the game
5. Use the `[aiml_word_scramble]` shortcode to display the game on any page or post

== Frequently Asked Questions ==

= Do I need the AIML Games Framework plugin? =

Yes, this plugin requires the AIML Games Framework to function properly. The framework provides shared services and ensures compatibility with other AIML game plugins.

= Can I create custom word sets? =

Yes! Games are created as Custom Post Types (aiml_game). Words are managed via the AIML Words CPT and linked to games. Create games in WordPress admin and assign words to build custom word sets.

= How do I customize the game appearance? =

The plugin includes comprehensive CSS classes that you can override in your theme. Additionally, the framework provides common styling utilities.

= Can I disable the timer or leaderboard? =

Yes, both features can be controlled through shortcode parameters:
`[aiml_word_scramble timer="false" leaderboard="false"]`

= Is the plugin mobile-friendly? =

Yes, the game is fully responsive and works on desktop, tablet, and mobile devices.

== Shortcode ==

Use the `[aiml_word_scramble]` shortcode to display the game:

**Basic Usage:**
`[aiml_word_scramble game_id="123"]`
Where `123` is the ID of an `aiml_game` post.

**Advanced Usage:**
`[aiml_word_scramble game_id="123" mode="relaxed" timer="false"]`

**Available Parameters:**

* `game_id` - The ID of an aiml_game post (required)
* `mode` - Game mode (normal, relaxed)
* `timer` - Enable timer (true, false)
* `leaderboard` - Enable leaderboard (true, false)
* `words_count` - Number of words to display (5-50)
* `time_limit` - Time limit in seconds (0 for unlimited)
* `is_in_set` - Whether this game is part of a game set (true, false)
* `set_id` - Game set ID if in a set
* `set_position` - Position within the game set (1-based)
* `set_total` - Total number of games in the set

== Screenshots ==

1. Game interface with scrambled words
2. Admin dashboard showing game statistics
3. Word management interface
4. Game set management
5. Shortcode builder tool

== Changelog ==

= 1.0.0 =
* Initial release
* Integration with AIML Games Framework
* Multiple game sets (AI Agents, Neural Networks, Optimization)
* Normal and relaxed game modes
* Leaderboard and achievement system
* Comprehensive admin interface
* Responsive design
* Shortcode builder tool

== Upgrade Notice ==

= 1.0.0 =
Initial release of AIML Word Scramble plugin. Requires AIML Games Framework plugin.

== Developer Notes ==

**Framework Integration:**
This plugin integrates with the AIML Games Framework for shared services:
- User progress tracking
- Cross-game leaderboards
- Analytics and event tracking
- Achievement system
- Session management

**Hooks and Filters:**
The plugin provides various hooks for customization:
- `aiml_word_scramble_before_game`
- `aiml_word_scramble_after_game`
- `aiml_word_scramble_score_calculated`
- `aiml_word_scramble_word_sets` (filter)
- `aiml_word_scramble_difficulty_levels` (filter)

**Data Architecture:**
The plugin uses WordPress Custom Post Types:
- `aiml_game` - Game instances with settings
- `aiml_word` - Individual word entries
- `aiml_game_set` - Collections of games
- Words are linked to games via post relationships

**Legacy Database Tables (Deprecated):**
The following tables are no longer used and kept only for backward compatibility:
- `wp_aiml_word_scramble_sets` - Replaced by aiml_game CPT
- `wp_aiml_word_scramble_words` - Replaced by aiml_word CPT
- `wp_aiml_word_scramble_word_gamesets` - Replaced by post relationships

**Security:**
All user input is properly sanitized and validated. WordPress nonces are used for form security. SQL queries use prepared statements.

== Support ==

For support, feature requests, or bug reports, please visit our website or contact the development team.

== Credits ==

Developed by the AIML.com team as part of the educational gaming initiative to make AI and machine learning concepts more accessible through interactive learning.