Skip to content

Commit

Permalink
Updated readme: initial public release
Browse files Browse the repository at this point in the history
  • Loading branch information
JanSeliv committed Jun 4, 2023
1 parent 4cfa8e4 commit 8ea33bd
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# 🔘️ Custom Shape Button

The `Custom Shape Button` plugin revolutionizes the way buttons are designed in Unreal Engine. Traditionally, the Unreal Engine restricts you to creating buttons with only rectangular forms. This limitation, however, is eliminated by our plugin.

With the `Custom Shape Button` plugin, you can now create buttons of any shape or form you envision. Whether you want a circular button, a star-shaped one, or one in the shape of a custom image, this plugin allows you to bring that vision to life. Additionally, the plugin ensures the hover and press behavior works flawlessly with the custom shapes, ensuring a seamless user experience.
<img width="480" alt="CustomShapeButton" src="https://github.com/JanSeliv/CustomShapeButton/assets/20540872/09a504a4-b1aa-4992-8c18-4b2865f65340">

## 📚 Documentation

Detailed documentation about the Custom Shape Button can be found [here](https://docs.google.com/document/d/1Ws76obIHRMtsdOjB6YP9K7LTjJR-R56h2uv65PKUBL4).

## 🎓 Sample Projects

Check out our [Release](https://github.com/JanSeliv/CustomShapeButton/releases) page for a sample project showcasing the Custom Shape Button plugin.

Also, explore this [game project repository](https://github.com/JanSeliv/Bomber) to view the Custom Shape Button in action.

## 📅 Changelog
#### 2023-06-04
- 🎉 Initial public release.

## 📫 Feedback & Contribution

This is an open-source project and we encourage you to contribute. If you encounter any bugs, or if you have any feature requests, please file an issue in the GitHub repository.

## 📜 License

This project is licensed under the terms of the MIT license. See [LICENSE](LICENSE) for more details.

We hope you find this plugin useful and we look forward to your feedback and contributions.

0 comments on commit 8ea33bd

Please sign in to comment.