mirror of
https://github.com/litruv/UE-MaterialSnippets.git
synced 2026-07-24 01:06:02 +10:00
added readme + license
This commit is contained in:
30
README.md
Normal file
30
README.md
Normal 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.
|
||||
Reference in New Issue
Block a user