From f8a09467ae6ccf478038332658d65c3a0198818d Mon Sep 17 00:00:00 2001 From: spacemex <51067067+spacemex@users.noreply.github.com> Date: Wed, 3 Jan 2024 16:11:15 -0600 Subject: [PATCH 1/4] Create README.md --- README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..4f329c6 --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# HealthSystem Plugin for Unreal Engine + +The HealthSystem plugin provides a robust framework for managing health and armor mechanics within your Unreal Engine projects. + +## Features +- Health and Armor tracking +- Configurable regeneration +- Efficient damage handling system +- Extendable for custom gameplay mechanics + +## Getting Started +Clone the repository into your project's `Plugins` directory and enable it through the Unreal Engine Editor under `Edit > Plugins`. + +## Documentation +Refer to the [Wiki](https://github.com/space_mex/HealthSystem/wiki) for detailed documentation. + +## Quick Links +- [Overview](https://github.com/space_mex/HealthSystem/wiki/Overview) +- [Health System](https://github.com/space_mex/HealthSystem/wiki/Health-System) +- [Armor System](https://github.com/space_mex/HealthSystem/wiki/Armor-System) +- [Regeneration System](https://github.com/space_mex/HealthSystem/wiki/Regeneration-System) +- [Damage Handling](https://github.com/space_mex/HealthSystem/wiki/Damage-Handling) + +## Contributing +Contributions are welcome! Please read our [contributing guidelines](CONTRIBUTING.md) before submitting pull requests. + +## License +This project is licensed under the MIT License - see the [LICENSE.md](LICENSE) file for details. + +## Support +If you find any issues or have a question, please file an issue. + +Happy coding! From 0388c6f6f5f5fac56016c7e6d63783f12cf343b9 Mon Sep 17 00:00:00 2001 From: spacemex <51067067+spacemex@users.noreply.github.com> Date: Wed, 3 Jan 2024 16:13:09 -0600 Subject: [PATCH 2/4] Update README.md --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 4f329c6..1e27430 100644 --- a/README.md +++ b/README.md @@ -12,14 +12,14 @@ The HealthSystem plugin provides a robust framework for managing health and armo Clone the repository into your project's `Plugins` directory and enable it through the Unreal Engine Editor under `Edit > Plugins`. ## Documentation -Refer to the [Wiki](https://github.com/space_mex/HealthSystem/wiki) for detailed documentation. +Refer to the [Wiki](https://github.com/spacemex/HealthSystem/wiki) for detailed documentation. ## Quick Links -- [Overview](https://github.com/space_mex/HealthSystem/wiki/Overview) -- [Health System](https://github.com/space_mex/HealthSystem/wiki/Health-System) -- [Armor System](https://github.com/space_mex/HealthSystem/wiki/Armor-System) -- [Regeneration System](https://github.com/space_mex/HealthSystem/wiki/Regeneration-System) -- [Damage Handling](https://github.com/space_mex/HealthSystem/wiki/Damage-Handling) +- [Overview](https://github.com/spacemex/HealthSystem/wiki/Overview) +- [Health System](https://github.com/spacemex/HealthSystem/wiki/Health-System) +- [Armor System](https://github.com/spacemex/HealthSystem/wiki/Armor-System) +- [Regeneration System](https://github.com/spacemex/HealthSystem/wiki/Regeneration-System) +- [Damage Handling](https://github.com/spacemex/HealthSystem/wiki/Damage-Handling) ## Contributing Contributions are welcome! Please read our [contributing guidelines](CONTRIBUTING.md) before submitting pull requests. From ecad521bf7ba5e322926c87d892b3a09dc0da476 Mon Sep 17 00:00:00 2001 From: spacemex <51067067+spacemex@users.noreply.github.com> Date: Wed, 3 Jan 2024 16:14:31 -0600 Subject: [PATCH 3/4] Create LICENSE --- LICENSE | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8907970 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 spacemex + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. From 85b6eeca0898378eef01b9f8fe3de62e1f242d40 Mon Sep 17 00:00:00 2001 From: spacemex <51067067+spacemex@users.noreply.github.com> Date: Wed, 3 Jan 2024 16:16:48 -0600 Subject: [PATCH 4/4] Create CONTRIBUTING.md --- CONTRIBUTING.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..916dab8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,31 @@ +# Contributing to HealthSystem + +We welcome contributions to the HealthSystem plugin! If you would like to contribute, please follow these guidelines. + +## How to Contribute + +1. **Fork the Repository** + - Fork the [HealthSystem repository](https://github.com/spacemex/HealthSystem) on GitHub. + +2. **Create a Branch** + - Create a new branch for each feature or improvement. + +3. **Make Your Changes** + - Make your changes in your branch. Be sure to adhere to the project's coding standards. + +4. **Write Commit Messages** + - Use clear and descriptive commit messages. + +5. **Submit a Pull Request** + - Push your branch to your fork on GitHub and submit a pull request to the `main` branch of the HealthSystem repository. + +## Reporting Issues + +- Use the [issue tracker](https://github.com/spacemex/HealthSystem/issues) to report bugs. +- Please include as much detail as possible in your issue report. + +## Code of Conduct + +- Be respectful and considerate in both your contributions and interactions with other contributors. + +Thank you for contributing to the HealthSystem plugin!