Add Rubik’s Cube simulation and solving package

[aditya7balotra]

📦 Proposal: Add Rubik’s Cube simulation and solving package

Hi maintainers 👋

I’d like to contribute a Python package to this repository that focuses on Rubik’s Cube algorithms and simulation. It’s a self-contained, modular package that includes:

• A virtual Rubik’s Cube model (simulate cube state, apply moves/scrambles)

• Multiple solving algorithms, designed for clarity and educational value

  — While solving in fewer moves is appreciated, the focus is on easy-to-understand logic,
  with an emphasis on group theory concepts behind the solving techniques

• Terminal-based visualizations and animations of the cube being solved

• AI-oriented datasets (separate for each available algorithm in the package)

---

🗂 Directory placement question

Since this is a package and touches multiple domains (maths, algorithms, simulations, AI datasets), I'm unsure where it best fits in the current repo structure.

Would you prefer:

1. Adding a new top-level directory like rubik/ or puzzles/rubik/
2. Integrating it into existing folders, if any suitable you find.
3. Keeping it as a standalone package under one folder to preserve its structure?
4. or any different suggestion?

Happy to follow the project’s guidelines and adjust accordingly.

Thanks! 🙏

[mariaspatani]

This looks like a great contribution idea 👍

For a repository like TheAlgorithms, it’s usually better to keep things aligned with the existing structure and educational focus.

A good approach would be:

1. Place it under a relevant category
   Since this relates to puzzles and algorithms, something like:
   puzzles/rubiks_cube/
   would fit well and keep it discoverable.

2. Avoid making it a separate standalone package
   TheAlgorithms typically organizes code by topic rather than full packages, so keeping it modular within the repo is preferred.

3. Keep it simple and educational
   Focus on clear implementations of:

• cube representation
• basic moves
• solving logic

Advanced features like animations or datasets could be optional additions later.

So overall, integrating it into an existing or slightly extended directory (like puzzles/) would likely be the best fit.

Looking forward to seeing this contribution!