Rhystic_Buddy

Rhystic Buddy

A life counter & game utility app for Magic: The Gathering's Commander (EDH) format, built with React Native.

---

Rhystic Buddy is an app designed to be a simple, but feature-rich companion for your Commander games. It features life tracking & offers a suite of tools to manage board states & streamline gameplay, all wrapped in a clean, gesture-driven interface.

✨ Key Features

• Multi-Player Life Tracking: Supports games from 2 to 6 players, with clear, easily adjustable life totals.
• Commander Damage: Dedicated interface to track commander damage dealt by each player to their opponents.
• Turn Order Randomizer: Quickly determine who goes first with a single tap.
• In-App Rulings: Integrated Scryfall search to look up card rulings without leaving the app.
• Customizable Backgrounds: Personalize your player panel by searching for & setting your favorite Magic card art as a background.
• Counter Tracking: Easily manage counters like poison, energy, & floating mana.
• Intuitive Gestures: A smooth, carousel-based UI for navigating between different utility views.

🛠️ Tech Stack

• Framework: React Native
• Language: TypeScript
• State Management: Zustand & TanStack Query
• Animation & Gestures: React Native Reanimated & React Native Gesture Handler
• UI: React Native SVG for custom components & Lucide for icons.

📂 Project Structure

The project uses a feature-sliced architecture to keep the codebase modular, scalable, & easy to navigate.

src/
├── consts/         # Application-wide constants (colors, layout values)
├── features/       # Self-contained feature modules
│   ├── central-menu/
│   ├── commander-damage/
│   ├── counters-menu/
│   └── player-panel/
├── helpers/        # Utility functions (e.g., API helpers)
├── hooks/          # Shared custom React Hooks
├── lib/            # Core libraries & managers (e.g., queryClient)
├── styles/         # Global styles & design tokens
└── types/          # Shared TypeScript type definitions

🚀 Getting Started

Prerequisites

• Node.js (>=18)
• Yarn (v1.x)
• Watchman (macOS)
• Ruby & Bundler (iOS)
• JDK (Android)
• React Native Environment Setup completed for your OS.

Installation & Running

1. Clone the repository:

   git clone git@github.com:BrodyHughes/Rhystic_Buddy.git
   cd Rhystic_Buddy
   

2. Install all dependencies: This command handles Yarn packages, Ruby gems, & CocoaPods in one go.

   yarn install-all
   

3. Start the Metro server:

   yarn start
   

4. Run on a simulator or device: Keep the Metro server running in a separate terminal.

   • For iOS:

     yarn ios
     

   • For Android (still in development):

     yarn android
     

📜 Available Scripts

Command	Description
yarn start	Starts the Metro bundler.
yarn ios	Builds & runs the app on the iOS Simulator.
yarn android	Builds & runs the app on an Android emulator or device.
yarn install-all	Installs all JS, Ruby, & CocoaPods dependencies.
yarn lint	Lints the codebase with ESLint.
yarn lint:fix	Lints & automatically fixes issues.
yarn typecheck	Runs the TypeScript compiler to check for type errors.
yarn format	Formats code with Prettier.
yarn clean	Removes all generated files & caches.

🤝 Contributing

Contributions are welcome! Whether it’s a bug report, a new feature, or a suggestion, please feel free to open an issue or submit a pull request.

1. Fork the repository & create your feature branch: git checkout -b <your-username>/<short-description>
2. Make your changes.
3. Ensure your code passes local checks before pushing:

   yarn lint:fix && yarn typecheck
   

4. Push your branch & open a Pull Request against the main branch.

📄 License

This project is licensed under the Apache License 2.0. See the LICENSE file for details.

🙏 Acknowledgements

• Icons by Lucide
• Card data & images via the Scryfall API

⚖️ Disclaimer

Rhystic Buddy is unofficial Fan Content permitted under the Wizards of the Coast Fan Content Policy. Not approved/endorsed by Wizards. Portions of the materials used are property of Wizards of the Coast. ©Wizards of the Coast LLC.

This application uses data from the Scryfall API, but is not produced by, endorsed by, supported by, or affiliated with Scryfall.

This site is open source. Improve this page.