added readme + license

This commit is contained in:
2025-01-16 00:52:20 +11:00
parent 9539d8fc73
commit 355d0d73d6
4 changed files with 79 additions and 0 deletions

21
LICENSE Normal file
View File

@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2023
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.

30
README.md Normal file
View File

@@ -0,0 +1,30 @@
# UEMatLib
UEMatLib is a library of materials for use in Unreal Engine. Each material comes with a preview, snippet, and description to help you choose the right one for your project.
## Materials
The materials are defined in the `materials.json` file. Each material has the following properties:
- `author`: The author of the material.
- `name`: The name of the material.
- `categories`: A list of categories the material belongs to.
- `preview`: A path to the preview image of the material.
- `snippet`: A path to the snippet file of the material.
- `description`: A brief description of the material.
## Usage
To use a material, simply copy the snippet from the `snippets` folder and paste it into your Unreal Engine project.
## Contributing
I welcome contributions! If you have a material snippet you'd like to add, please follow these steps:
1. Fork the repository.
2. Add your material to the `materials.json` file.
3. Add your preview image to the `thumbnails` folder.
4. Add your snippet file to the `snippets` folder.
5. Submit a pull request.
## License
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.

View File

@@ -13,6 +13,12 @@
<header> <header>
<div class="header-content"> <div class="header-content">
<h1><span class="highlight">UE</span> Material Snippets</h1> <h1><span class="highlight">UE</span> Material Snippets</h1>
<a href="https://github.com/litruv/UE-MaterialSnippets/pulls" target="_blank" class="add-snippet-button">
<svg height="32" aria-hidden="true" viewBox="0 0 24 24" version="1.1" width="32" data-view-component="true" class="octicon octicon-mark-github v-align-middle">
<path d="M12.5.75C6.146.75 1 5.896 1 12.25c0 5.089 3.292 9.387 7.863 10.91.575.101.79-.244.79-.546 0-.273-.014-1.178-.014-2.142-2.889.532-3.636-.704-3.866-1.35-.13-.331-.69-1.352-1.18-1.625-.402-.216-.977-.748-.014-.762.906-.014 1.553.834 1.769 1.179 1.035 1.74 2.688 1.25 3.349.948.1-.747.402-1.25.733-1.538-2.559-.287-5.232-1.279-5.232-5.678 0-1.25.445-2.285 1.178-3.09-.115-.288-.517-1.467.115-3.048 0 0 .963-.302 3.163 1.179.92-.259 1.897-.388 2.875-.388.977 0 1.955.13 2.875.388 2.2-1.495 3.162-1.179 3.162-1.179.633 1.581.23 2.76.115 3.048.733.805 1.179 1.825 1.179 3.09 0 4.413-2.688 5.39-5.247 5.678.417.36.776 1.05.776 2.128 0 1.538-.014 2.774-.014 3.162 0 .302.216.662.79.547C20.709 21.637 24 17.324 24 12.25 24 5.896 18.854.75 12.5.75Z"></path>
</svg>
+Add Snippet
</a>
</div> </div>
<div class="filter-container"> <div class="filter-container">
<div class="search-box"> <div class="search-box">

View File

@@ -299,3 +299,25 @@ footer {
.footer-content nav a:hover { .footer-content nav a:hover {
color: var(--primary-color); color: var(--primary-color);
} }
.add-snippet-button {
display: flex;
align-items: center;
background-color: #28a745;
color: #fff;
padding: 10px 15px;
border-radius: var(--border-radius);
text-decoration: none;
font-weight: 500;
transition: background-color 0.2s;
}
.add-snippet-button svg {
width: 20px;
height: 20px;
margin-right: 8px;
}
.add-snippet-button:hover {
background-color: #218838;
}