Skip to content

Shuu-37/xi-ai-skill

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LandSandBoat FFXI Development Skill

A Claude Code skill that provides expert knowledge for Final Fantasy XI private server development using the LandSandBoat codebase.

What is This?

This skill enables Claude to automatically assist with FFXI private server development by providing:

  • Comprehensive documentation (~164 KB) covering architecture, gameplay systems, database schema, networking, scripting, and utilities
  • Complete reference codebase access to LandSandBoat's C++20 and Lua implementation
  • Expert context for building GM tools, APIs, and custom content

When you mention FFXI, LandSandBoat, or related concepts, Claude automatically activates this skill and gains access to specialized knowledge.

Features

Documentation Coverage

  • Architecture Overview - Multi-process server design, technology stack, build system
  • Gameplay Systems - Combat, entities, status effects, quests, missions, zones
  • Database Schema (56 KB) - Complete reference for 126+ tables with relationships
  • Networking - IPC, HTTP API, packet structures, protocols
  • Scripting - Lua integration, patterns, examples
  • Utilities - Python tools for server management

Reference Codebase

Access to complete LandSandBoat source:

  • C++20 core engine (~26% of codebase)
  • Lua scripting layer (~63% of codebase)
  • 297 zone implementations
  • 126+ SQL schema files
  • Python development tools

Installation

Option 1: Personal Installation (Recommended)

Install once and use across all your projects:

# Clone to your personal Claude skills directory
git clone https://github.com/your-org/landsandboat-skill ~/.claude/skills/landsandboat-ffxi

# Navigate to skill directory
cd ~/.claude/skills/landsandboat-ffxi

# Run setup to download LandSandBoat reference codebase
./scripts/setup-reference.sh

On Windows (Git Bash or WSL):

git clone https://github.com/your-org/landsandboat-skill ~/AppData/Roaming/Claude/skills/landsandboat-ffxi
cd ~/AppData/Roaming/Claude/skills/landsandboat-ffxi
./scripts/setup-reference.sh

Option 2: Project-Level Installation

For teams working on FFXI projects together:

# From your project root
git clone https://github.com/your-org/landsandboat-skill .claude/skills/landsandboat-ffxi

# Run setup
cd .claude/skills/landsandboat-ffxi
./scripts/setup-reference.sh

Team members will receive the skill when they pull changes.

Option 3: Plugin (Future)

Once published to Claude Code plugin marketplace:

claude install landsandboat-ffxi

Usage

Once installed, Claude automatically activates this skill when you mention:

  • "LandSandBoat"
  • "LSB"
  • "FFXI private server"
  • "Final Fantasy XI development"
  • Game mechanics (combat, quests, NPCs)
  • Database tables (chars, mob_spawn_points, etc.)
  • Lua scripting for zones

Example Interactions

You: I need to create a GM tool to manage player inventory

Claude: [Activates landsandboat-ffxi skill]
I'll help you build a GM tool for inventory management. Let me reference
the database schema for character inventory...
[References docs/database.md and provides implementation]
You: How do I script an NPC that starts a quest in LandSandBoat?

Claude: [Activates landsandboat-ffxi skill]
I'll show you the pattern for quest-giving NPCs based on LandSandBoat
scripting conventions...
[References docs/scripting.md and reference/scripts/zones/ examples]
You: What's the database structure for mob spawns?

Claude: [Activates landsandboat-ffxi skill]
The mob spawn system uses several related tables. Let me walk you through
the schema...
[References docs/database.md with detailed table relationships]

Repository Structure

landsandboat-skill/
├── SKILL.md                    # Skill definition with YAML frontmatter
├── README.md                   # This file
├── docs/                       # AI-friendly documentation (164 KB)
│   ├── architecture-overview.md
│   ├── gameplay-systems.md
│   ├── database.md            # Primary database reference (56 KB)
│   ├── networking.md
│   ├── scripting.md
│   └── utilities.md
├── scripts/
│   └── setup-reference.sh     # Clone LandSandBoat codebase
└── reference/                  # LandSandBoat source (gitignored)
    ├── src/                   # C++20 source
    ├── scripts/               # Lua scripts
    ├── sql/                   # Schema files
    └── tools/                 # Python utilities

Reference Codebase Setup

The reference/ directory contains the complete LandSandBoat codebase for AI reference. It's gitignored and must be set up locally.

First-Time Setup

cd ~/.claude/skills/landsandboat-ffxi  # or your skill location
./scripts/setup-reference.sh

This clones the latest LandSandBoat repository into reference/.

Updating Reference Code

cd ~/.claude/skills/landsandboat-ffxi
./scripts/setup-reference.sh  # Pulls latest changes if already cloned

What Gets Downloaded

  • Complete C++20 source code
  • All 297 zone Lua scripts
  • 126+ SQL schema files
  • Python development tools
  • Configuration examples
  • LandSandBoat documentation

Size: ~200-300 MB

Requirements

  • Claude Code: This skill is designed for Claude Code CLI
  • Git: Required for cloning the reference codebase
  • Disk Space: ~300 MB for reference codebase
  • OS: Works on Linux, macOS, Windows (with Git Bash or WSL)

Common Use Cases

Building GM Tools

  • Player management interfaces
  • Item distribution tools
  • Server announcement systems
  • Economy monitoring dashboards

Lua Scripting

  • Zone scripts (NPCs, mobs, events)
  • Quest and mission implementations
  • Custom content (BCNMs, dynamis, etc.)
  • Status effect behaviors

Database Work

  • Schema design for custom content
  • Data migration scripts
  • Player data queries and reports
  • Game data management

API Development

  • RESTful APIs for web interfaces
  • Discord bot integrations
  • Admin panel backends
  • Analytics and monitoring

Advantages Over Traditional Documentation

Automatic Activation

No need to manually reference docs - Claude knows when to use this skill.

Context-Aware

Claude understands relationships between systems (e.g., how database tables relate to C++ entities and Lua scripts).

Comprehensive

164 KB of structured documentation plus complete source code access.

Always Available

Install once, works across all your FFXI projects.

Team Sharing

Commit to .claude/skills/ in your repository for team-wide access.

Updating the Skill

To get the latest documentation and improvements:

cd ~/.claude/skills/landsandboat-ffxi
git pull origin main

To update the reference codebase:

./scripts/setup-reference.sh

Contributing

Contributions welcome! To improve this skill:

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes:
    • Update documentation in docs/
    • Improve SKILL.md instructions
  4. Test with Claude Code
  5. Submit a pull request

Documentation Guidelines

  • Keep docs AI-friendly (clear structure, examples, relationships)
  • Use code references with file:line format
  • Provide context for complex systems
  • Include common pitfalls and considerations

Troubleshooting

Claude Isn't Activating the Skill

Check installation location:

ls ~/.claude/skills/landsandboat-ffxi/SKILL.md

Verify YAML frontmatter is valid:

head -n 5 ~/.claude/skills/landsandboat-ffxi/SKILL.md

Be more explicit: Instead of: "How do I create an NPC?" Try: "How do I create an NPC in LandSandBoat?"

Reference Directory Missing

Run the setup script:

cd ~/.claude/skills/landsandboat-ffxi
./scripts/setup-reference.sh

Permission Issues (Windows)

Use Git Bash or WSL to run the setup script. PowerShell may have issues with the bash script.

Skill Path Issues

Ensure the skill is in one of these locations:

  • ~/.claude/skills/landsandboat-ffxi/ (personal)
  • .claude/skills/landsandboat-ffxi/ (project-level)

License

This skill repository is MIT licensed. The LandSandBoat reference codebase in reference/ maintains its original GPL-3.0 license.

Related Resources

Version

Skill Version: 1.0.0 Last Updated: 2025-11-05 LandSandBoat Version: Latest stable (main branch)


Built with ❤️ for the FFXI private server development community

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages