Skip to content

Commit

Permalink
Readme: initial release
Browse files Browse the repository at this point in the history
  • Loading branch information
JanSeliv committed May 26, 2023
1 parent 0d17a7c commit d2403df
Showing 1 changed file with 23 additions and 20 deletions.
43 changes: 23 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,25 @@
### Settings Widget Constructor
Plugin allows automatically generate UI for your game settings in few clicks just by adding new row for each desired option:
![Settings_31-12-21](https://user-images.githubusercontent.com/20540872/147825296-ce7d33da-dfda-4757-b070-bfd08f700134.jpg)
# ⚙️ Settings Widget Constructor

Settings Widget Constructor is a handy plugin for Unreal Engine 5 that lets you automatically generate user interface (UI) for your game settings. All it takes is a few clicks and adding a new row to the table for each desired option.

![Settings UI](https://user-images.githubusercontent.com/20540872/147825296-ce7d33da-dfda-4757-b070-bfd08f700134.jpg)

<img width="948" alt="image" src="https://github.com/JanSeliv/Bomber/assets/20540872/5b4592a4-173d-4e6c-8a31-a502c14bd2c6">

### How-To:
1. In `Content Drawer`, click on `Settings Windget Constructor` tab:
<img width="438" alt="ContentDrawer" src="https://github.com/JanSeliv/Bomber/assets/20540872/e27aa18a-2291-48a9-90a6-876525a839ff">
2. Create `Settings Data Table` asset - `A` from screenshot of step 1.

It creates default table with 2 columns and scroll bar:
<img width="305" alt="image" src="https://github.com/JanSeliv/Bomber/assets/20540872/dce5f000-9922-40d1-ab07-a147525717d6">
3. In `Project Settings`, click `Settings Widget Constructor` tab.
4. Choose created `Settings Data Table` asset:
![ProjectSettings](https://github.com/JanSeliv/Bomber/assets/20540872/5b3f0905-b6ee-4867-9182-fdeef61d6e4a)
5. Create `Settings Widget` asset - `B` from screenshot of step 1.
6. Display created 'Settings Widget' asset:
<img width="774" alt="image" src="https://github.com/JanSeliv/Bomber/assets/20540872/d9defe1f-7ba1-462f-9eaa-e69e436d69c5">

**As the result**, you will see next default Settings Widget:
<img width="1092" alt="image" src="https://github.com/JanSeliv/Bomber/assets/20540872/cd53c719-7da6-411e-ba41-74fce938a451">
## 📚 Documentation

Detailed documentation about the Settings Widget Constructor can be found [here](https://docs.google.com/document/d/1IXnOqrgaXTClP-0cIo28a9f6GHc9N1BCgTNnMk-X9VQ).

## 📅 Changelog
#### 2023-05-26
- 🎉 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 d2403df

Please sign in to comment.