nonsensical-dev/zenyx-engine
nonsensical-dev/zenyx-engine
3
0
Fork 1
Code Issues 6 Pull requests 2 Projects 1 Releases Activity Actions

chore: modify readme to use up to date information

Browse source
This commit is contained in:
Chance 2025-04-13 19:01:56 -04:00 • committed by lily
parent 061826f4ab
commit 03ec88b035
Signed by: lily
GPG key ID: 601F3263FBCBC4B9
1 changed files with 53 additions and 80 deletions
Download patch file Download diff file Expand all files Collapse all files

133
README.md
View file

@ -3,7 +3,7 @@
<img src="assets/Logo.svg" alt="Zenyx engine" width="350"/>
![Version](https://img.shields.io/badge/version-0.1.0-blue)
![License](https://img.shields.io/github/license/Caznix/Zenyx)
![License](https://img.shields.io/gitlab/license/Caznix/Zenyx)
![Build](https://img.shields.io/github/actions/workflow/status/Caznix/Zenyx/rust.yml?branch=main)
![platform](https://img.shields.io/badge/platform-windows%20%7C%20linux%20%7C%20macos-informational)
@ -12,53 +12,41 @@
---
# What is zenyx?
# What is Zenyx?
Zenyx is a game engine built on top of [wgpu](https://github.com/gfx-rs/wgpu)
and [winit](https://github.com/rust-windowing/winit). It is designed to be an
intuitive and innovative game engine that can both adapt to your workflow and
bring new ideas to the table.
Zenyx is an in-development game engine leveraging the power of [wgpu](https://github.com/gfx-rs/wgpu) for graphics rendering and [winit](https://github.com/rust-windowing/winit) for window management. Built with Rust, Zenyx aims to be an intuitive and innovative game engine, designed to adapt to various workflows while introducing new possibilities for game development.
## Features
## Planned Features
> 🚀 Note: The following features are goals and are not currently implemented:
> Zenyx
> 🚀 Note: The following features represent the intended direction of Zenyx and are not fully implemented at this stage.
### **Zenyx aims to provide:**
### **Zenyx is being designed with the following capabilities in mind:**
- ✨ **Cross platform support** - Windows, Linux and macOS support
- 🎮 **Support for multiple renderers** - Zenyx can use Vulkan. OpenGL, and
DirectX. In both 2D and 3D
- ⚡ **Safe Performance** - Written in Rust for speed and safety
- 🎯 **Intuitive Design** - User-friendly workflows and highly extensible tools
- 📝 **Flexible Scripting** - Easy to use scripting language without sacrificing
performance
- 🔧 **Extensible Architecture** - Modular design for easy customization
- 🛠️ **Fully Featured Toolset** - Built in tools for playing spatial audio and
level editing
- 🖥️ **Real-time Editor** - Live preview and Incredible User experience
- 📦 **Asset Management** - Efficient resource handling system
- 🎲 **Physics Integration** - Built-in physics simulation
- 🗂️ **Improved Scene Management** - Flexible scene organization tools
- ✨ **Cross-Platform Compatibility:** Targeting Windows, Linux, and macOS.
- ⚡ **Performance and Safety:** Built with Rust to provide both speed and memory safety.
- 🎯 **Intuitive and Extensible Design:** Focusing on user-friendly workflows and highly customizable tools.
- 🔧 **Modular Architecture:** Designed with a modular structure for straightforward customization.
- 🛠️ **Integrated Toolset:** Envisioning built-in tools for spatial audio and level editing.
- 📦 **Efficient Asset Management:** Developing a robust resource handling system.
- 🎲 **Performant Physics Engine:** Zenyx Makes use of [Rapier2D](https://docs.rs/rapier2d/latest/rapier2d/) & [Rapier3D](https://docs.rs/rapier3d/latest/rapier3d/)
- 🗂️ **Advanced Scene Management:** Designing flexible tools for organizing game scenes.
## Star history ⭐
### **Current Limitations:**
<a href="https://star-history.com/#Caznix/Zenyx&Date">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=Caznix/Zenyx&type=Date&theme=dark" />
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=Caznix/Zenyx&type=Date" />
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=Caznix/Zenyx&type=Date" />
</picture>
</a>
Currently, Zenyx faces certain limitations due to its early stage of development and the capabilities of its underlying rendering backend, wgpu:
- **No Hardware Ray Tracing:** As wgpu currently only supports standard rasterization pipelines, Zenyx inherits this limitation. Hardware ray tracing is not yet available. You can follow the progress of ray tracing support in wgpu [here](https://github.com/gfx-rs/wgpu/issues/6762).
- **Alpha software:** Zenyx is in the initial phases of development. It is not yet suitable for any practical use cases. Many of the features listed above are still goals and have not been implemented.
- **Limited macOS Support:** While macOS (and or IOS) is a target platform, it currently requires MoltenVK due to wgpu's lack of native Metal support. This might introduce additional dependencies, potential compatibility issues, or generally unintended behavior on such platforms
- **Incomplete Documentation and Tooling:** As the engine is under active development, comprehensive documentation and a full suite of built-in tools are not yet available, however they are still planned for the near future.
## FAQ
<details>
<summary><b>What platforms does Zenyx support?</b></summary>
Zenyx primarily supports Windows and Linux, with secondary support for macOS
(requires MoltenVK). See the
[Platform support table](#what-platforms-will-be-supported) for more
Zenyx primarily supports Windows and Linux, with secondary support for macOS. See the
[Platform support table](#what-platforms-will-be-supported-in-the-future) for more
information.
</details>
@ -68,7 +56,7 @@ information.
Zenyx is currently in early development and is not yet ready for any simple use
cases, but we're working hard to make it the best it can be before we release
1.0. If this interests you and you're interested in helping, please check out
1.0. If this interests you, and you're interested in helping, please check out
the [contribution section](CONTRIBUTING.md) for the ways you can help.
</details>
@ -77,8 +65,8 @@ the [contribution section](CONTRIBUTING.md) for the ways you can help.
<summary><b>How can I contribute to Zenyx?</b></summary>
We welcome contributions! Please check our contribution guidelines and open a
pull request on GitHub, if you arent a developer, you can also report bugs or
feature requests on our [issue tracker](https://github.com/Caznix/Zenyx/issues).
pull request on GitHub, if you aren't a developer, you can also report bugs or
feature requests on our [issue tracker](https://codeberg.org/Zenyx/zenyx/issues).
For more information, please see the [Contributing section](#contributing).
</details>
@ -101,75 +89,60 @@ Distribute, and use Zenyx for any purpose you wish.
## What platforms will be supported in the future?
| Platform | Support Priority | Status | Notes |
| :--------: | :--------------: | :----: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Windows | Primary | ✅ | |
| Linux/*BSD | Primary | ✅ | |
| macOS | Secondary | 🌋 | Requires MoltenVK for both editor and exported games due to Wgpu's lack of support for Metal |
| Android | TBD | ❓ | |
| iOS | TBD | ❓+🌋 | |
| Web | TBD | ❓ | |
| Consoles | Not planned | ⛔ | Consoles require specific dev kits,proprietary licenses, and substantial fees that we (Caznix & the open source contributors) currently do not have the capacity for. This may change in the future but most likely will not be soon. |
| Platform | Support Priority | Status | Notes |
|:----------:|:----------------:|:------:|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Windows | Primary | ✅ | |
| Linux/*BSD | Primary | ✅ | |
| macOS | Secondary | ⚠️ | The current main set of maintainers do not own any native MacOS devices to perform tests with. |
| Android | Help wanted | ❓ | |
| iOS | Not planned | ❓ | |
| Web | TBD | ❓ | |
| Consoles | Not planned | ⛔ | Consoles require specific dev kits,proprietary licenses, and substantial fees that we (Nonsensical-dev,the Zenyx maintainers,and the open source contributors) currently do not have the capacity for. This may change in the future but most likely will not be soon. |
# Documentation
## Getting Started
Zenyx is not yet ready to be used but this may change in the near future.
Zenyx is currently in a pre-release state and is not yet ready for general use.
Keep an eye on this section for updates on when you can start using Zenyx.
# Contributing
We welcome contributions of any kind! If you're interested in contributing,
please check out our CONTRIBUTING.md file for coding standards and guidelines.
We encourage community involvement in the development of Zenyx! If you're interested in contributing,
please review our [Contribution Guide](CONTRIBUTING.md) for our coding standards and community guidelines.
Even if you're not a developer, you can still help tremendously by spreading the
word about Zenyx, reporting bugs, suggesting features, or helping improve our
documentation.
You can contribute in various ways, even if you're not a developer. Spreading the word about Zenyx,
reporting any bugs you encounter, suggesting new features,
and helping us improve our documentation are all valuable contributions.
If you would like to contribute code to Zenyx, follow the instructions below for
your platform:
If you are interested in contributing code to Zenyx, please follow the platform-specific instructions below:
## Prerequisites (all platforms)
0. Install [Rust](https://www.rust-lang.org/tools/install)
1. Ensure you have [Rust](https://www.rust-lang.org/tools/install) installed on your system.
1. Install [git](https://git-scm.com/downloads)
2. Make sure you have [git](https://git-scm.com/downloads) installed for version control.
## Building
**1**. Clone the repository:
**1**. Clone the Zenyx repository from your favorite mirror:
git clone https://github.com/Caznix/Zenyx.git
git clone https://codeberg.org/Zenyx/zenyx
**2**. cd into the project directory
**2**. Navigate to the project directory:
cd ./Zenyx
**3**. Build the project
**3**. Build the project using Cargo:
cargo run
## macOS
⚠️ as of this current time, we do not have any macOS contributors to write this
guide, so follow the [General](#building) instructions and try to fill in the
gaps, you can also ask questions on the [Discord]()
## Subcrates
Zenyx is split into multiple crates to make it easier to maintain and update, you can find the crates in the `subcrates` directory, each crate has its own README file so you can find more information for each crate there. Here is a list of the crates:
* [Zephyr (ECS)](subcrates/zephyr/README.md)
* Aims to provides a lightweight and boilerplate-free ECS framework for modular game development.
# Press kit
## Typefaces
### Text
Main typeface
<img src="assets/Logo.png" width="200" alt="Zenyx Typeface">
## Colored badges
<img src="assets/Badge.png" width="100" alt="Zenyx Logo">
<img src="assets/Logo.png" width="256" alt="Zenyx Typeface">
### Colored badges
<img src="assets/Badge.png" width="128" alt="Zenyx Logo">