Skip to content

Latest commit

 

History

History
58 lines (41 loc) · 3.54 KB

README.md

File metadata and controls

58 lines (41 loc) · 3.54 KB
Raw

Veil: Advanced Rendering for Minecraft 🖼️✨

Veil 1.20 Veil 1.20.4 Veil 1.21 Veil 1.21.1 Javadoc Discord

Veil is a sophisticated collection of tools and utilities designed to facilitate advanced rendering for Minecraft mod developers. Our goal is to enable more modern game-engine level content in Java Minecraft, pushing the boundaries of what is possible in modding.

Features

  • Animations: A timeline-keyframe system supporting position, rotation, and scale.
  • Colors: Manage colors and use them with Themes.
  • Easings: Apply easing functions for more natural motion.
  • Framebuffer: JSON-driven custom framebuffers.
  • In-World Tooltips: Fully customizable, network-synced 3D tooltips.
  • OpenCL: Harness the power of OpenCL for rendering and other computational tasks.
  • Post Processing: A custom post-processing pipeline with easy texture binding.
  • Shaders: Full support for all OpenGL shader types, with HLSL and Spir-V support potentially coming in the future.
  • Shader Modification: Inject and modify existing shaders to suit your needs.

Getting Started

Explore our Example Mod to see Veil in action and learn how to integrate it into your projects.

For comprehensive documentation and guides, visit our Veil Developer Wiki.

Contribution Guidelines

We welcome contributions from the community! Before contributing, please read our Contributing Guidelines to understand our processes and ensure your contributions align with the project goals.

Code of Conduct

Please note that we expect all contributors to adhere to our Code of Conduct. Respectful and constructive interactions are crucial for maintaining a positive and collaborative community.

License

Veil is licensed under the LGPL License. Feel free to use, modify, and distribute the code as per the terms of the license.

Goals

Our primary goal with Veil is to enable the creation of more modern, game engine-level content within Java Minecraft. We strive to provide mod developers with the tools they need to push the boundaries of what is possible in Minecraft modding, bringing new and exciting experiences to players.

Contact

If you have any questions, feel free to reach out to us through the issues section on GitHub. We're here to help and appreciate your efforts to improve Veil!