Skip to content

nrynss/neom-mathventure

Repository files navigation

Neom Mathventure 🧮 ✨

A mathematics learning game built with Rust and WebAssembly, featuring Kerala's cultural elements and trilingual support (Malayalam, Manglish, and English).

🌟 Features

Educational Elements

  • Progressive difficulty levels
  • Age-appropriate mathematics (5-8 years)
  • Instant feedback system
  • Score and accuracy tracking
  • Time-based challenges with bonuses
  • Adaptive difficulty based on performance

Cultural Integration

  • Mascots:
    • തങ്കമ്മ (Thangamma) the Tapir
    • കണ്ണപ്പൻ (Kannappan) the Capybara

Language Support

  • 🌿 Malayalam (മലയാളം)
  • 🌱 Manglish (Malayalam transliterated)
  • 🍃 English
  • Real-time language switching without game interruption

Visual Design

  • Kerala art-inspired UI elements
  • Traditional color schemes
  • Kathakali-inspired animations
  • Interactive mascot animations
  • Celebration effects with cultural motifs

🛠️ Technology Stack

  • Frontend: HTML5, CSS3, JavaScript
  • Backend: Rust
  • Compilation: WebAssembly
  • Performance: Optimized for both desktop and mobile devices

🚀 Getting Started

Prerequisites

  • Rust (latest stable version)
  • wasm-pack
  • A modern web browser
  • Basic understanding of command line tools

Installation

  1. Clone the repository:
git clone https://github.com/yourusername/neom-mathventure.git
cd neom-mathventure
  1. Install dependencies:
# Install wasm-pack
curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
  1. Build the WebAssembly module:
wasm-pack build --target web
  1. Set up web directory:
cd www
ln -s ../pkg .  # Create symbolic link to pkg directory
  1. Start a local server:
# Using Python 3
6. Interact with Thangamma and Kannappan for encouragement!

## 🎨 Cultural Elements

- **Visual Design**: Inspired by Kerala mural paintings
- **Color Palette**: Traditional Kerala art colors
- **Animations**: Influenced by classical art forms
- **Language**: Authentic Malayalam expressions
- **Mascots**: Cultural accessories and decorations

## 📱 Responsive Design

- Optimized for various screen sizes
- Touch-friendly interface
- Adaptive layout for mobile devices
- Accessible controls

## 🤝 Contributing

We welcome contributions to Neom Mathventure! Here's how you can help:

### Types of Contributions

- 🐛 Bug fixes
- ✨ New features
- 🌍 Translations
- 📚 Documentation
- 🎨 UI/UX improvements
- ♿ Accessibility enhancements
- 🧪 Tests

### Contribution Process

1. **Fork the Repository**
   - Create your own fork of the project
   - Clone your fork locally

2. **Create a Branch**

```bash
git checkout -b feature/your-feature-name
# or
git checkout -b fix/your-fix-name
  1. Code Style
  • Follow existing code formatting
  • Use meaningful commit messages
  • Maintain existing patterns and practices
  • Add comments for complex logic
  • Keep accessibility in mind
  1. Testing
  • Add tests for new features
  • Ensure existing tests pass
  • Test across different browsers
  • Check mobile responsiveness
  1. Documentation
  • Update README if needed
  • Add JSDoc comments for functions
  • Document any new features
  • Include screenshots if relevant
  1. Submit a Pull Request

    • Describe your changes in detail
    • Link any related issues
    • Provide context and reasoning
    • Include before/after screenshots if applicable

Cultural Sensitivity Guidelines

  • Respect Kerala cultural elements
  • Verify Malayalam translations
  • Maintain cultural authenticity
  • Consult with community members when unsure

Code of Conduct

  • Be respectful and inclusive
  • Welcome newcomers
  • Provide constructive feedback
  • Maintain professional communication

📄 License

This project is licensed under the Apache License 2.0.

⭐ Acknowledgment

This project has been developed with the assistance of Anthropic's Claude AI, which provided guidance in code development, cultural integration, and project structuring.

🔮 Future Plans

  • Add more traditional Kerala elements
  • Expand language support
  • Include more mathematical concepts
  • Add audio with Malayalam narration
  • Implement multiplayer mode

Built with 💝 and കേരള സംസ്കാരം (Kerala culture)

About

A mathematics learning game built with Rust and WebAssembly, featuring Kerala's cultural elements and trilingual support (Malayalam, Manglish, and English).

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors