Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (45 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

69 lines (45 loc) · 2.43 KB

Contributing to BalatroBench

Welcome to the BalatroBench community! We're excited to see your custom strategies for playing Balatro with AI. Contributing is simple: test your strategy locally, then submit it through our community form.

🚀 Quick Submission Guide

  1. Test Locally - Develop and test your strategy using balatrollm
  2. Submit Form - Fill out the embedded form on our community page
  3. Server Validation - We'll run your strategy on our servers

📋 Step-by-Step Instructions

Step 1: Develop Your Strategy

Create your strategy using the balatrollm framework:

# Test your strategy locally
balatrollm --strategy path/to/strategy/directory

Test thoroughly with different seeds and game scenarios to ensure your strategy works consistently.

Step 2: Submit Through Community Form

Visit the Community page on our website and find the submission form. You'll need to provide:

Required Fields:

  • Provider/Model: The AI provider and model
  • Base URL: API endpoint for your chosen provider
  • API Key: Your API key for the service
  • Strategy Name: A clear, descriptive name for your strategy
  • Author: Your name or GitHub username
  • STRATEGY.md.jinja: Paste your complete strategy template directly into the form

Step 3: Server Validation

After submission:

  • We'll automatically run your strategy on our benchmark servers
  • Results will be added to the leaderboard if validation passes
  • No manual review process - fully automated

🎯 Strategy Development Tips

  • Test Thoroughly: Run multiple games with different seeds locally
  • Clear Instructions: Write detailed, specific prompts for the AI
  • Focus on Results: Optimize for consistent high scores and win rates

📊 What Makes a Good Strategy

  • Consistency: Performs well across different game scenarios
  • Clarity: Easy to understand and implement
  • Innovation: Brings new approaches or insights
  • Reproducibility: Others can achieve similar results

🤝 Community Guidelines

  • Be respectful and constructive
  • Share knowledge and insights
  • Focus on improving AI performance in Balatro
  • Use appropriate language in all submissions

❓ Need Help?

Ask questions on our Discord server in the #balatrobench channel.

Thank you for contributing to BalatroBench! We look forward to seeing your innovative AI strategies.