Differences

This shows you the differences between two versions of the page.

--- rpd:ai_wiki [2025/12/20 22:55] – Add ai_wiki page documenting tools and methodologies for AI-assisted wiki maintenance mike
+++ rpd:ai_wiki [2025/12/20 22:55] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
+====== AI Wiki Documentation and Tool Suggestions ======
+This page documents the tools, methodologies, and best practices used in the AI-assisted wiki maintenance process for Remixed Dungeon.
+==== Tools Used ====
+===== Code Search and Analysis =====
+  * **grep_search**: Used extensively to find specific code implementations, string resources, and configuration files across the codebase
+  * **read_file**: Utilized to examine the actual implementation of game entities in Java, Lua, JSON, and XML files
+  * **read_many_files**: Used when needed to understand multiple related files simultaneously
+===== Wiki Maintenance Tools =====
+  * **find_red_links.py**: Python script to identify red links in the wiki data
+  * **scale_sprites_for_wiki.py**: Enhances sprites for better wiki visualization
+  * **check_broken_images.py**: Checks for broken image links in wiki pages
+==== Methodology for Wiki Page Creation and Verification ====
+===== Process for Creating/Updating Wiki Pages =====
+. **Research**: Use grep_search to locate relevant code, JSON configs, and string resources
+. **Implementation Analysis**: Read Java files to understand game mechanics
+. **Lua Script Review**: Examine Lua scripts for moddable entities
+. **JSON Configuration Review**: Check JSON files for entity definitions
+. **String Resources**: Find localized text in XML files
+. **Create/Update Page**: Write comprehensive wiki page based on discovered information
+. **Cross-reference**: Link related pages appropriately
+. **Verify**: Ensure all information is accurate and up-to-date
+===== Information Sources =====
+Each wiki page should reference:
+  * Java implementation files
+  * Lua scripts for moddable entities
+  * JSON configuration files
+  * String resources (with specific line numbers when possible)
+  * Image resources
+  * Related game entities
+==== Page Structure Recommendations ====
+===== Standard Sections for Game Entity Pages =====
+  * **Description**: What the entity is in-game
+  * **Stats**: Numerical values (with depth-scaling when applicable)
+  * **Special Abilities**: Unique mechanics and behaviors
+  * **Loot**: Items dropped or obtained
+  * **Strategy**: How to interact with the entity effectively
+  * **Technical Details**: Links to source code
+  * **Code References**: Direct links to relevant code files
+  * **See Also**: Related entities and concepts
+===== Naming Conventions =====
+  * Use snake_case for all wiki page names
+  * Use entity type suffixes (e.g., _mob, _item, _spell, _buff, _class, _subclass)
+  * Maintain consistency with existing page naming
+==== Special Considerations for MR Namespace Pages ====
+Machine-readable namespace pages (mr:) should contain:
+  * Entity kind identifiers used in getEntityKind() method
+  * Raw code excerpts
+  * JSON configuration files content
+  * Lua script code
+  * String resource keys and values
+  * Direct file paths to implementations
+==== Common Issues Found and Resolved ====
+===== Obsolete Information =====
+  * Stats that don't reflect depth scaling
+  * Old ability descriptions that don't match current implementations
+  * Incorrect item drops or probabilities
+  * Wrong immunities, resistances or vulnerabilities
+===== Red Links =====
+  * Create missing pages for referenced entities
+  * Ensure proper cross-linking between related pages
+  * Use correct namespace and naming conventions
+===== Inconsistent Information =====
+  * Different pages having conflicting information about the same entity
+  * Outdated strategy sections that no longer apply to current game mechanics
+==== Suggested Automation Tools ====
+===== Potential AI-Assisted Tools =====
+  * **Auto-verification Script**: Automatically compares wiki information with game code to identify discrepancies
+  * **MR Page Generator**: Creates/updates mr: namespace pages based on entity discovery
+  * **Stat Validation**: Checks that entity stats on wiki match the actual game implementation
+  * **Link Validation**: Ensures all internal links are valid and creates missing pages automatically
+  * **Localization Checker**: Verifies that wiki pages align with string resources for different languages
+  * **API Documentation Generator**: Creates documentation from code comments and structure
+===== Proposed Workflow Improvements =====
+  * Integrate wiki validation into the build process
+  * Create automatic detection for new game entities that need wiki pages
+  * Develop templates for different types of game entities to ensure consistency
+  * Implement version tracking to understand when wiki pages become outdated compared to code changes
+==== Quality Assurance Practices ====
+===== Information Accuracy =====
+  * Always verify information against the actual source code
+  * Include specific file paths and line numbers when referencing code
+  * Note when information is depth-dependent or conditional
+  * Flag information that might change between game versions
+===== Page Completeness =====
+  * Ensure all major properties of game entities are documented
+  * Include both mechanical effects and strategic implications
+  * Add proper cross-references to related entities and mechanics
+  * Include appropriate images and visual aids
+{{tag> rpd ai wiki tools }}