-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'origin/master'
- Loading branch information
Showing
3 changed files
with
85 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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/spacemex/HealthSystem/wiki) for detailed documentation. | ||
|
||
## Quick Links | ||
- [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. | ||
|
||
## 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! |