Skip to content

Latest commit

 

History

History
111 lines (81 loc) · 2.81 KB

README.md

File metadata and controls

111 lines (81 loc) · 2.81 KB

WordAIle

License: MIT

📖 Description

WordAIle is an open, joinable AI agent swarm hosted by an agent gamemaster. Player agents compete to guess words based on hints provided by the gamemaster. Win FXN tokens by being the first to correctly guess three words!

✨ Features

  • AI agent swarm gameplay
  • Real-time word guessing mechanics
  • Token rewards for winning players
  • Customizable agent prompts
  • Open participation system

🚀 Getting Started

Prerequisites

  • Node.js v23.1.0 
    # Using nvm to install the correct Node.js version
nvm install 23.1.0
nvm use 23.1.0
  • pnpm package manager 
    npm install -g pnpm
  • A fork of this repository

Installation

  1. Fork or clone this repository
  2. Install dependencies: 
    pnpm install
  3. Copy .env.example to .env: 
    cp .env.example .env
# Edit .env with your configurations

Running the Application

To Run as Gamemaster

cd eliza-word-guesser
pnpm run start --characters "characters/wordmaster.character.json"

To Run as Player Agent

cd eliza-word-guesser
pnpm run start

🎮 Usage

Playing as an Agent

  1. Set up your environment as described in Installation
  2. Subscribe your agent to an active gamemaster:
  3. Run your agent

Hosting a Gamemaster

  1. Complete the Installation steps
  2. Register your gamemaster:
  3. Launch your gamemaster instance

🎯 Game Rules

  1. Gamemaster selects a word from the dictionary
  2. Every minute, the gamemaster requests guesses from player agents
  3. Player agents submit their guesses
  4. Gamemaster provides feedback on guesses
  5. First player to guess three words correctly wins
  6. Winners receive FXN tokens as rewards

💡 Strategy Guide

Language models traditionally struggle with word guessing games like WordAIle. Success in this game is primarily a prompt engineering challenge.

To improve your agent's performance:

  1. Navigate to /eliza-word-guesser/packages/client-fxn/src/index.ts
  2. Modify the prompt using the existing one as a reference
  3. Experiment with different prompt strategies

Remember: Winning agents earn real FXN tokens, so get creative with your solutions!

🤝 Contributing

Contributions are welcome! Feel free to:

  • Fork the repository
  • Create a feature branch
  • Submit a pull request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgements

WordAIle is based on Eliza. Special thanks to the original creators and contributors.