From 9a8fb1147c60f563d1639b5e87ef4e99f4c37c6d Mon Sep 17 00:00:00 2001 From: chris Date: Tue, 9 Sep 2025 19:12:54 -0400 Subject: [PATCH] add README --- README.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) diff --git a/README.md b/README.md index 1924ccf..e55ac27 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,53 @@ # MTG_Life +MTG Life Counter + +A sleek and intuitive life counter for Magic: The Gathering, with support for Commander, Poison, and a built-in D20 die roller. + +![A screenshot of the MTG life counter application interface] +🚀 Features + + Life Tracking: Easily increase and decrease life totals for each player. + + Poison & Commander Damage: Dedicated counters for tracking poison and commander damage, which automatically trigger a loss when the threshold is met. + + D20 Die Roller: A responsive and animated D20 die roller is built right into the navigation bar for quick rolls. + + Persistent State: Player names, life totals, and game settings are saved in your browser, so you can close the tab and return to your game later. + + Customizable: Add or remove players, and toggle between standard, commander, and poison match modes. + + Responsive Design: Works beautifully on both desktop and mobile devices. + +🕹ī¸ How to Use + +Just open the index.html file in your web browser. There's no server or installation required. + + Adjust Life: Tap the + or - buttons on a player's card to change their life total. + + Change Name: Tap a player's name to edit it. + + Add/Remove Players: Use the + and - buttons in the top navigation bar. + + Toggle Modes: Use the crown and skull buttons to switch between Commander and Poison modes. + + Roll the Die: Click the D20 icon in the navigation bar to roll. + +🛠ī¸ Tech Stack + + HTML5 + + CSS3 (with custom properties for theming) + + JavaScript (ES6+) + + SweetAlert2 (for pop-ups and alerts) + + Font Awesome (for icons) + +🤝 Contributing + +We welcome contributions! If you have suggestions for new features, bug fixes, or improvements, please feel free to open an issue or submit a pull request. +📄 License + +This project is licensed under the MIT License - see the LICENSE.txt file for details. \ No newline at end of file