Skip to content

SUPPORT.md

Latest commit

 

History

History
130 lines (91 loc) · 6.44 KB

SUPPORT.md

File metadata and controls

130 lines (91 loc) · 6.44 KB
Raw

Support for Chess Ultimate

Thank you for using Chess Ultimate! We’re dedicated to ensuring you have a great experience with this web-based chess game. This document outlines how to seek support, report issues, request features, and find additional resources.

Table of Contents

Getting Help

If you encounter issues or have questions about Chess Ultimate, follow these steps:

  1. Check the Documentation:

  2. Search Existing Issues:

    • Visit the Issues page to see if your question or issue has been addressed.

  3. Explore FAQs:

    • Check the FAQs section below for solutions to common problems.

  4. Ask the Community:

  5. Contact the Maintainer:

    • For private or urgent matters, reach out via a private issue or discussion on the GitHub repository.

Reporting Bugs

If you find a bug in Chess Ultimate:

  1. Verify the Issue:

    • Ensure you’re using the latest version from the repository.
    • Reproduce the issue in multiple browsers (e.g., Chrome, Firefox).

  2. Submit a Bug Report:

    • Open a new issue on the Issues page.
    • Use the bug report template and include:
      • A clear title and description.
      • Steps to reproduce the bug (e.g., specific moves or actions).
      • Expected vs. actual behavior.
      • Screenshots, videos, or browser console logs.
      • Your environment (e.g., browser, operating system, device).

  3. Follow Up:

    • Respond to any questions or requests for clarification from maintainers.
    • Test any proposed fixes if requested.

Example:

  • Title: "AI Move Button Freezes Game"
  • Steps: Start a game, play as white, click "AI Move" repeatedly.
  • Expected: AI makes a valid move for black.
  • Actual: Game becomes unresponsive.
  • Environment: Firefox 115, macOS 14.

Requesting Features

Have an idea to improve Chess Ultimate? We’d love to hear it!

  1. Check for Duplicates:

    • Search the Issues page to ensure your feature hasn’t been suggested.

  2. Submit a Feature Request:

    • Open a new issue using the feature request template.
    • Provide:
      • A clear title and detailed description.
      • The problem the feature solves or the benefit it provides.
      • Any examples, mockups, or references to similar functionality.

  3. Engage with Feedback:

    • Discuss your idea with maintainers and the community.
    • Be open to refining the proposal based on feedback.

Example:

  • Title: "Add Online Multiplayer Mode"
  • Description: Implement WebSocket-based multiplayer to allow remote play.
  • Benefit: Expands the game to support global competition.

FAQs

Q: Why don’t sound effects work?
A: The sound effects in chess_script.js reference invalid audio file paths (e.g., path/to/move-sound.mp3). To enable sounds, update the SOUND_EFFECTS object with valid .mp3 or .wav files and host them in the assets folder.

Q: Why does the AI make weak moves?
A: The current AI selects random valid moves. To improve it, consider contributing a stronger algorithm (e.g., minimax with alpha-beta pruning) as outlined in the Contributing Guidelines.

Q: How do I castle or perform en passant?
A: Castling is available when the king and rook haven’t moved, the path is clear, and the king isn’t in check. Move the king two squares toward the rook. For en passant, move a pawn to capture an opponent’s pawn that just advanced two squares, as if it moved one.

Q: Why is the board too small/large on my device?
A: Adjust the board size in the settings modal using the slider or +/- buttons. The size ranges from 50 to 100 vmin, adapting to your screen.

Q: Can I play offline?
A: Yes, after loading initial assets (e.g., Bootstrap, Font Awesome), the game works offline. Host files locally to ensure full offline functionality.

Q: How do I reset my settings?
A: Clear the browser’s local storage via developer tools (e.g., localStorage.removeItem('chessSettings')) or implement a reset button in the settings modal (future feature).

Q: Why does the game lag on mobile?
A: The particle.js background or animations may strain low-end devices. Disable particles in js/chess_script.js or reduce animation speed in settings. Report performance issues on the Issues page.

Q: How do I change the language?
A: Use the language dropdown in the navbar to select from English, Spanish, French, German, Japanese, Korean, or Chinese. The UI updates automatically.

Community and Contact

Join the Chess Ultimate community to connect with other players and the maintainer:

  • GitHub Discussions: Ask questions, share ideas, or discuss features in the Discussions section.
  • Issues Page: Report bugs or request features at Issues.
  • Maintainer Contact: For direct support, create a private issue or discussion on the GitHub repository.

We aim to respond to questions and issues within 48 hours, though community responses may be faster.

Supporting the Project

Chess Ultimate is free and open-source, but your support helps maintain and improve it! Here’s how you can contribute:

  • Contribute: Help improve the code, documentation, or community by following the Contributing Guidelines.
  • Star the Repository: Show your support by starring the project on GitHub.
  • Spread the Word: Share Chess Ultimate with friends or on social media.
  • Provide Feedback: Report bugs or suggest features to enhance the game.

Thank you for your support and for playing Chess Ultimate!