Welcome to the Bevy DSA Learning Game project! This project aims to provide an interactive and engaging learning experience for Data Structures and Algorithms (DSA) using the Bevy game engine. Users can write code in a dedicated editor and witness real-time 3D animations that visualize the execution of their algorithms.
To get started with the project, follow these steps:
-
Clone the repository:
git clone https://github.com/your-username/bevy-dsa-learning-game.git
-
Navigate to the project directory:
cd bevy-dsa-learning-game -
Install dependencies:
cargo build
-
Run the project:
cargo run
- Real-time Code and Animation Sync: Witness 3D animations that sync with your code execution.
- Interactive 3D Canvas: Manipulate visual elements and see the immediate impact on your algorithms.
- Array Visualizations: Arrays are represented as 3D structures for a more intuitive understanding.
- Code Editor Integration: Write code using the integrated code editor with syntax highlighting.
- User Interaction: Click on array elements and use the mouse for interactive learning.
The project follows a modular structure:
src/: Contains the source code for the Bevy DSA Learning Game.assets/: Includes 3D models, textures, and other assets used in the project.
- Bevy Game Engine: The core game engine for 2D and 3D development in Rust.
- [Your Additional Dependencies]: Any additional dependencies or plugins used in the project.
To build and run the project, use the following commands:
cargo build
cargo runIf you'd like to contribute to the project, follow these steps:
-
Fork the repository.
-
Create a new branch for your feature:
git checkout -b feature-name
-
Commit your changes:
git commit -m 'Add feature' -
Push to the branch:
git push origin feature-name
-
Submit a pull request.
This project is licensed under the MIT License.
Feel free to copy and paste this into your project's README.md file on GitHub. Let me know if you need any further adjustments!