base on Rubik Cube # Rubik-Cube # <p align="center">✨Rubik-Cube✨</p> <p align="center"> <a href="https://github.com/Dev-tanay/Rubik-Cube/issues"> <img src="https://img.shields.io/github/issues/Dev-tanay/Rubik-Cube?style=for-the-badge" alt="GitHub issues"> </a> <a href="https://github.com/Dev-tanay/Rubik-Cube/network/members"> <img src="https://img.shields.io/github/forks/Dev-tanay/Rubik-Cube?style=for-the-badge" alt="GitHub forks"> </a> <a href="https://github.com/Dev-tanay/Rubik-Cube/stargazers"> <img src="https://img.shields.io/github/stars/Dev-tanay/Rubik-Cube?style=for-the-badge" alt="GitHub stars"> </a> <a href="https://github.com/Dev-tanay/Rubik-Cube/blob/main/LICENSE"> <img src="https://img.shields.io/github/license/Dev-tanay/Rubik-Cube?style=for-the-badge" alt="GitHub license"> </a> <a href="https://dev-tanay.github.io/Rubik-Cube/"> <img src="https://img.shields.io/website?style=for-the-badge&down_color=red&down_message=offline&up_color=green&up_message=online&url=https%3A%2F%2Fdev-tanay.github.io%2FRubik-Cube%2F" alt="Website status"> </a> </p> ## 🌐 Link to Game Demo <a href="https://dev-tanay.github.io/Rubik-Cube/">https://dev-tanay.github.io/Rubik-Cube/</a> <img src="images/home.png" height="500" width="1200"> ## 📖 About the Game This is a simple and elegant game where you can play Rubik's Cube from your own web browser. - Each of the six faces of the Rubik's cube is in one of the six colors - red, green, yellow, blue, white, and orange. - The visible part of the cube is divided into 26 pieces: - 6 central pieces (one colored side) - 12 edge pieces (two colored sides) - 8 corner pieces (three colored sides) - The 26 pieces are "scrambled" to have different colors on each face. ## 🕹️ How to Play The objective of this game is to get each face of the cube to have a single color. This can be done in two ways: 1. **Twisting the Segments** - This can be done by dragging the cursor over the segment you want to rotate. <img src="images/twist1.png" width="300"> <img src="images/twist2.png" width="300"> 2. **Changing the View of the Cube** - This can be done by dragging the cursor in an arrow around the cube. <img src="images/changeview.png" width="300"> ## 🧩 Installation Guide for Rubik-Cube Follow the steps below to install and set up the Rubik-Cube project on your local machine. ### 📋 Prerequisites - Ensure you have `git` installed on your system. If not, download and install it from [here](https://git-scm.com/). - A modern web browser (e.g., Chrome, Firefox, Edge). ### 🛠️ Steps 1. **🔗 Clone the Repository** Open your terminal (or Command Prompt on Windows) and run the following command to clone the repository: ```sh git clone https://github.com/Dev-tanay/Rubik-Cube.git ``` 2. **📂 Navigate to the Cloned Repository** Change directory to the cloned repository: ```sh cd Rubik-Cube ``` 3. **🌐 Open the Index.html File** Locate the `index.html` file in the repository and open it in your web browser. You can do this by either: - **Double-clicking the `index.html` file** in your file manager. This will open the file in your default web browser. - **Running a simple HTTP server** (if you prefer): **Using Python (if installed):** ```sh python -m http.server ``` Open your web browser and go to `http://localhost:8000`. **Using Node.js (if installed) with http-server package:** ```sh npx http-server ``` Open your web browser and go to the provided local server URL (usually `http://127.0.0.1:8080` or similar). 4. **🎮 Play the Game** Once the `index.html` file is opened in the web browser, the game screen will be displayed. You can now start playing the Rubik-Cube game. ### ℹ️ Notes - Ensure your browser allows running JavaScript, as the game likely depends on it. - If you encounter any issues, check the browser console for error messages and ensure all assets are properly loaded. Enjoy your Rubik-Cube game! 🕹️✨ ## 🧭 Navigating the Game Screen - **Home** <h2>About the Game</h2> <p>This is a simple and elegant game where you can play Rubik's Cube from your own web browser.</p> <p>Each of the six faces of the Rubik's cube is in one of the six colors - red, green, yellow, blue, white, and orange.</p> <p>The visible part of the cube is divided into 26 pieces:</p> <ul> <li>6 central pieces (one colored side)</li> <li>12 edge pieces (two colored sides)</li> <li>8 corner pieces (three colored sides)</li> </ul> <p>The 26 pieces are "scrambled" to have different colors on each face.</p> <h4>Link to Game Demo</h4> <a href="https://dev-tanay.github.io/Rubik-Cube/">https://dev-tanay.github.io/Rubik-Cube/</a> <h2>How to Play</h2> <p>The objective of this game is to get each face of the cube to have a single color.</p> <p>This can be done in two ways:</p> <ol type="i"> <li>Twisting the segments</li> <p>This can be done by dragging the cursor over the segment you want to rotate or letters(r l u b d f) for the move(Hold Shift for prime/anticlockwise moves)</li> </p> <img src="images/twist1.png" width="300"> <img src="images/twist2.png" width="300"> <li>Changing the view of the cube</li> <p>This can be done by dragging the cursor in an arrow or arrowkeys (up,down,right,left) around the cube.</p> <img src="images/changeview.png" width="300"> <li>Using keyboard shortcuts</li> <p>You can also use keyboard shortcuts to rotate the cube:</p> <ul> <li>Press <strong>w</strong> or <strong>Arrow Up</strong> to rotate the cube upwards.</li> <li>Press <strong>s</strong> or <strong>Arrow Down</strong> to rotate the cube downwards.</li> <li>Press <strong>a</strong> or <strong>Arrow Left</strong> to rotate the cube to the left.</li> <li>Press <strong>d</strong> or <strong>Arrow Right</strong> to rotate the cube to the right.</li> </ul> </ol> <h2>Technology Used</h2> <p> <a href="https://www.w3schools.com/html/"> <img src="https://img.icons8.com/color/70/000000/html-5--v1.png" alt="HTML" /></a> <a href="https://www.w3schools.com/css/"> <img src="https://img.icons8.com/color/70/000000/css3.png" alt="CSS" /></a> <a href="https://www.w3schools.com/js/"> <img src="https://img.icons8.com/?size=70&id=PXTY4q2Sq2lG&format=png&color=000000" alt="js" /></a> </p> <h2>Installation</h2> <ol type="i"> <li>Clone the repository</li> <pre><code>git clone https://github.com/Dev-tanay/Rubik-Cube.git</code></pre> <li>Navigate to the cloned repository</li> <pre><code>cd Rubik-Cube</code></pre> <li>Open the <code>index.html</code> file in a web browser</li> </ol> <p>There, you've opened the game screen!</p> <h2>Navigating the Game Screen</h2> <ul> <li>Home</li> <img src="images/home1.png" width="300"> - You'll see two icons at the bottom corners of the screen: (1) Leaderboard and (2) Preferences. - You can start the game by double-clicking on the text "DOUBLE TAP TO START". - **Game Start** <img src="images/start.png" width="300"> - Once you start the game, a timer will show above the cube. - Now you'll see only one icon, which is Back. - **Preferences** <img src="images/preferences.png" width="300"> - Clicking Preferences from the Home screen will lead you to the settings page. - Options available for customization: - Cube size - Flip Type - Scramble - Camera Angle - Color Scheme - Two new icons in the bottom corners: (3) Back and (4) Theme. - **Theme** <img src="images/theme.png" width="300"> - Here, you can adjust the hue, saturation, and lightness of the screen. - New icons in the bottom corners: (5) Back and (6) Reset. - **Stats** <img src="images/stats.png" width="300"> - Displays statistics of your Rubik's Cube game, including: - Total Number of Solves - Best time - Average of 5, 12, 25 <h3>LICENSE</h3> <p>This project is licensed under the MIT License - see the <a href="LICENSE">LICENSE</a> file for details.</p> <div align="center"> <h2><font size="6"><img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Smilies/Red%20Heart.png" alt="Red Heart" width="40" height="40" /> Contributors </font></h2> </div> <br> - This project thanking all the contributors for having your valuable contribution to our project - Make sure you show some love by giving ⭐ to our repository <br> <center> <a href="https://github.com/Dev-tanay/Rubik-Cube/graphs/contributors"> <img src="https://contrib.rocks/image?repo=Dev-tanay/Rubik-Cube" /> </a> </center> <br> <p align="right"><a href="#top">Back to top</a></p> ## 📜 License This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. ", Assign "at most 3 tags" to the expected json: {"id":"10106","tags":[]} "only from the tags list I provide: []" returns me the "expected json"