Create README.md

README.md

@@ -0,0 +1,72 @@
+# Bloody Checkpoints
+
+**Bloody Checkpoints** is a mod for ULTRAKILL aimed at casual players who prefer a less punishing gameplay experience. It modifies the checkpoint system to fully restore the player's health whenever a checkpoint is activated, offering a smoother and more accessible journey through ULTRAKILL's challenging levels.
+
+---
+
+## 🌟 Features
+
+- **Full Health Restoration**: Every time you activate a checkpoint, your health is fully restored.
+- **Supports Bonus Health**: If you've collected temporary bonus health (up to 200), it will be preserved after interacting with a checkpoint.
+- **Casual-Friendly Gameplay**: Designed to make the game less punishing without removing the thrill of combat.
+
+---
+
+## 🛠️ How It Works
+
+ULTRAKILL's default checkpoint system saves your progress but doesn’t restore your health, making it more difficult to recover from mistakes. **Bloody Checkpoints** changes this by:
+- Detecting when the player activates a checkpoint.
+- Fully restoring the player's health up to their current maximum (including temporary bonus health).
+- Providing a more forgiving experience while maintaining the fast-paced, adrenaline-pumping gameplay ULTRAKILL is known for.
+
+---
+
+## 📥 Installation
+
+### Requirements
+- **BepInEx**: This mod requires BepInEx to function. Make sure it's installed in your ULTRAKILL directory.
+
+### Steps to Install
+1. Download the latest release of **Bloody Checkpoints** from the [Releases](https://github.com/MrRaposinha/BloodyCheckpoints/releases) page.
+2. Extract the `.zip` file into the `BepInEx/plugins` folder of your ULTRAKILL directory.
+   - If the `plugins` folder doesn’t exist, create it.
+3. Launch ULTRAKILL and enjoy!
+
+---
+
+## 🎮 Who Is This Mod For?
+
+This mod is perfect for:
+- **Casual Players**: Those who find the default checkpoint system too punishing.
+- **Experimenters**: Players who want to focus more on exploring and testing their combat skills without being heavily penalized.
+- **Fans of Accessibility**: Anyone looking for a smoother ULTRAKILL experience while keeping the game's core excitement intact.
+
+---
+
+## 🔧 Troubleshooting
+
+If the mod isn’t working:
+1. Ensure **BepInEx** is properly installed.
+2. Verify that the mod files are in the correct `BepInEx/plugins` directory.
+3. Check the game logs (`BepInEx/LogOutput.log`) for errors.
+
+For further help, visit the [Issues](https://github.com/MrRaposinha/BloodyCheckpoints/issues) section of this repository.
+
+---
+
+## 🤝 Contributing
+
+Contributions are welcome! If you want to improve this mod or report bugs:
+1. Fork the repository.
+2. Create a branch for your changes.
+3. Submit a pull request with a clear description of your updates.
+
+---
+
+## 📜 License
+
+This project is licensed under the **MIT License**. See the [LICENSE](LICENSE) file for details.
+
+---
+
+Thank you for trying out **Bloody Checkpoints**! Happy gaming! 🎮🔥