forked from nonsensical-dev/zenyx-engine
add readme with branding
This commit is contained in:
parent
4803f3dfae
commit
733c7ac80c
GPG key ID:
443E4198D6BBA6DE
6 changed files with 138 additions and 0 deletions
0
CONTRIBUTING.md
Normal file
0
CONTRIBUTING.md
Normal file
119
README.md
119
README.md
|
|
@ -0,0 +1,119 @@
|
|||
<div align="center">
|
||||
|
||||
<img src="assets/Logo.svg" alt="Zenyx engine" width="200"/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
## 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.
|
||||
|
||||
### Features
|
||||
|
||||
> 💡 Note: The following features are goals and are not currently implemented:
|
||||
Zenyx
|
||||
|
||||
***Zenyx aims to provide:***
|
||||
* **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
|
||||
|
||||
|
||||
## FAQ
|
||||
|
||||
<details>
|
||||
<summary>What platforms does Zenyx support?</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 information.
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Is Zenyx ready for production use?</summary>
|
||||
|
||||
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 the [contribution section](CONTRIBUTING.md) for the ways you can help.
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>How can I contribute to Zenyx?</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). For more information, please see the [Contributing section](#contributing).
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>What are the system requirements?</summary>
|
||||
|
||||
Detailed system requirements will be provided as the engine matures. Currently, the only requirement is a modern OS and a system with atleast a semi-recent GPU.
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Is Zenyx free to use?</summary>
|
||||
|
||||
Yes, Zenyx is open-source software licensed under MIT. You can Modify, Distribute, and use Zenyx for any purpose you wish.
|
||||
</details>
|
||||
|
||||
|
||||
### What platforms will be supported?
|
||||
| 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 |
|
||||
|
||||
## Documentation
|
||||
|
||||
### Getting Started
|
||||
|
||||
Zenyx is not yet ready to be used but this may change in the near future.
|
||||
## 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.
|
||||
|
||||
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.
|
||||
|
||||
If you would like to contribute code to Zenyx, follow the instructions below for your platform:
|
||||
|
||||
### Prerequisites (all platforms)
|
||||
0. Install [Rust](https://www.rust-lang.org/tools/install)
|
||||
|
||||
1. Install [git](https://git-scm.com/downloads)
|
||||
### Building
|
||||
|
||||
**1**. Clone the repository:
|
||||
```ps1
|
||||
git clone https://github.com/Caznix/Zenyx.git
|
||||
```
|
||||
|
||||
**2**.
|
||||
cd into the project directory
|
||||
```PS1
|
||||
cd ./Zenyx
|
||||
```
|
||||
**3**. Build the project using the xtask:
|
||||
```ps1
|
||||
cargo xtask run core # also use editor for editor, or engine for both
|
||||
```
|
||||
|
||||
|
||||
### 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]()
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
BIN
assets/Badge.png
Normal file
BIN
assets/Badge.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 26 KiB |
9
assets/Badge.svg
Normal file
9
assets/Badge.svg
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
<svg width="256" height="256" viewBox="0 0 256 256" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M256 128C256 198.692 198.692 256 128 256C57.3075 256 0 198.692 0 128C0 57.3075 57.3075 0 128 0C198.692 0 256 57.3075 256 128Z" fill="#FFCD4E"/>
|
||||
<mask id="mask0_117_566" style="mask-type:alpha" maskUnits="userSpaceOnUse" x="12" y="12" width="232" height="232">
|
||||
<circle cx="128" cy="128" r="116" fill="#E0A100"/>
|
||||
</mask>
|
||||
<g mask="url(#mask0_117_566)">
|
||||
<path d="M107.569 201C97.5992 201 89.5173 192.918 89.5173 182.949C89.5173 180.278 90.1099 177.64 91.2524 175.226L114.486 126.134C123.278 107.558 109.729 86.1563 89.1777 86.1563H-13.9219C-22.8016 86.1563 -30 78.9578 -30 70.0781C-30 61.1984 -22.8016 54 -13.9219 54H147.456C157.426 54 165.508 62.0819 165.508 72.0515C165.508 74.7221 164.915 77.3596 163.773 79.7735L140.539 128.866C131.747 147.442 145.296 168.844 165.847 168.844H278.922C287.802 168.844 295 176.042 295 184.922C295 193.802 287.802 201 278.922 201H107.569Z" fill="black"/>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 1,006 B |
BIN
assets/Logo.png
Normal file
BIN
assets/Logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
10
assets/Logo.svg
Normal file
10
assets/Logo.svg
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
<svg width="506" height="214" viewBox="0 0 506 214" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<mask id="mask0_280_9" style="mask-type:alpha" maskUnits="userSpaceOnUse" x="0" y="18" width="137" height="138">
|
||||
<circle cx="68.5" cy="87" r="68.5" fill="#E0A100"/>
|
||||
</mask>
|
||||
<g mask="url(#mask0_280_9)">
|
||||
<path d="M53.4665 133.076C47.5793 133.076 42.8068 128.304 42.8068 122.417C42.8068 120.84 43.1567 119.282 43.8314 117.857L57.9126 88.1036C62.9363 77.4889 55.194 65.2591 43.4505 65.2591H-18.2759C-23.5195 65.2591 -27.7703 61.0083 -27.7703 55.7647C-27.7703 50.5211 -23.5195 46.2703 -18.2758 46.2703H77.0208C82.908 46.2703 87.6805 51.0428 87.6805 56.93C87.6805 58.5071 87.3306 60.0645 86.6559 61.49L72.5746 91.243C67.551 101.858 75.2933 114.088 87.0368 114.088H154.653C159.897 114.088 164.148 118.338 164.148 123.582C164.148 128.826 159.897 133.076 154.653 133.076H53.4665Z" fill="white"/>
|
||||
</g>
|
||||
<path d="M138.064 51.44C138.064 49.4773 138.789 47.8133 140.24 46.448C141.776 45.0827 143.653 44.4 145.872 44.4H202.832C202.832 49.008 201.979 52.3787 200.272 54.512C198.651 56.6453 196.005 57.712 192.336 57.712H153.424V82.16H188.112C188.112 86.768 187.259 90.1387 185.552 92.272C183.931 94.4053 181.328 95.472 177.744 95.472H153.424V120.688H195.024C198.608 120.688 201.211 121.755 202.832 123.888C204.539 126.021 205.392 129.392 205.392 134H145.872C143.653 134 141.776 133.317 140.24 131.952C138.789 130.587 138.064 128.88 138.064 126.832V51.44ZM231.364 55.792C231.364 51.8667 232.601 48.7947 235.076 46.576C237.636 44.3573 241.135 43.248 245.572 43.248L290.884 113.52L292.036 112.496L287.3 104.688V43.248C292.335 43.248 296.132 44.2293 298.692 46.192C301.252 48.1547 302.532 51.0987 302.532 55.024V124.144C302.532 127.131 301.337 129.733 298.948 131.952C296.559 134.085 293.657 135.152 290.244 135.152L243.012 61.936L241.86 62.832L246.596 70.768V123.376C246.596 127.216 245.273 130.16 242.628 132.208C240.068 134.171 236.313 135.152 231.364 135.152V55.792ZM356.964 101.744L325.22 44.912C325.988 44.4853 327.14 44.1013 328.676 43.76C330.212 43.4187 331.62 43.248 332.9 43.248C335.716 43.248 338.063 43.8453 339.94 45.04C341.903 46.1493 343.567 47.9413 344.932 50.416L364.388 86.768L361.06 93.424L362.34 94.064L384.484 50.416C386.873 45.6373 390.884 43.248 396.516 43.248C397.796 43.248 399.204 43.4187 400.74 43.76C402.276 44.1013 403.428 44.4853 404.196 44.912L372.452 101.744V123.376C372.452 127.131 371.129 130.032 368.484 132.08C365.839 134.128 361.999 135.152 356.964 135.152V101.744ZM430.352 135.152C426.939 135.152 423.995 133.872 421.52 131.312L452.624 87.792L423.056 46.064C423.995 45.2107 425.189 44.528 426.64 44.016C428.091 43.504 429.627 43.248 431.248 43.248C433.467 43.248 435.515 43.632 437.392 44.4C439.355 45.168 440.763 46.192 441.616 47.472L460.304 75.248L456.976 79.856L458.128 80.624L480.656 47.472C481.595 46.192 483.003 45.168 484.88 44.4C486.757 43.632 488.848 43.248 491.152 43.248C492.688 43.248 494.181 43.504 495.632 44.016C497.083 44.528 498.277 45.2107 499.216 46.064L469.776 87.792L500.752 131.312C498.448 133.872 495.504 135.152 491.92 135.152C490.043 135.152 488.293 134.768 486.672 134C485.136 133.147 483.856 131.995 482.832 130.544L461.2 99.184L439.44 130.544C438.416 131.909 437.093 133.019 435.472 133.872C433.936 134.725 432.229 135.152 430.352 135.152Z" fill="white"/>
|
||||
<path d="M125.52 156.488C125.52 155.293 125.968 154.291 126.864 153.48C127.803 152.627 128.933 152.2 130.256 152.2H158.864C158.864 155.016 158.395 157.064 157.456 158.344C156.517 159.624 155.003 160.264 152.912 160.264H134.928V170.376H151.696C151.696 173.192 151.227 175.24 150.288 176.52C149.349 177.8 147.835 178.44 145.744 178.44H134.928V188.936H154.256C156.304 188.936 157.797 189.576 158.736 190.856C159.675 192.136 160.144 194.184 160.144 197H130.256C128.933 197 127.803 196.595 126.864 195.784C125.968 194.973 125.52 193.949 125.52 192.712V156.488ZM172.295 158.984C172.295 156.723 173.063 154.931 174.599 153.608C176.135 152.285 178.204 151.624 180.807 151.624L201.351 184.136L202.055 183.56L199.175 178.76V151.624C202.204 151.624 204.508 152.2 206.087 153.352C207.666 154.504 208.455 156.189 208.455 158.408V191.368C208.455 192.435 208.114 193.459 207.431 194.44C206.791 195.379 205.916 196.147 204.807 196.744C203.698 197.299 202.524 197.576 201.287 197.576L179.399 162.952L178.695 163.528L181.575 168.328V190.792C181.575 193.011 180.786 194.696 179.207 195.848C177.628 197 175.324 197.576 172.295 197.576V158.984ZM240.194 197.576C236.354 197.576 232.919 196.829 229.89 195.336C226.861 193.843 224.493 191.773 222.786 189.128C221.122 186.44 220.29 183.389 220.29 179.976V169.096C220.29 165.683 221.101 162.653 222.722 160.008C224.386 157.363 226.69 155.315 229.634 153.864C232.621 152.371 236.013 151.624 239.81 151.624C243.607 151.624 246.999 152.2 249.986 153.352C252.973 154.461 255.277 156.019 256.898 158.024C258.562 160.029 259.394 162.333 259.394 164.936C259.394 166.6 258.839 167.923 257.73 168.904C256.621 169.843 255.106 170.312 253.186 170.312C252.077 170.312 250.989 170.163 249.922 169.864C250.05 168.968 250.114 167.901 250.114 166.664C250.114 164.616 249.154 162.952 247.234 161.672C245.314 160.349 242.839 159.688 239.81 159.688C236.823 159.688 234.391 160.563 232.514 162.312C230.637 164.061 229.698 166.323 229.698 169.096V179.976C229.698 182.792 230.658 185.096 232.578 186.888C234.541 188.637 237.079 189.512 240.194 189.512C243.181 189.512 245.613 188.829 247.49 187.464C249.367 186.099 250.306 184.349 250.306 182.216V180.744H245.634C243.885 180.744 242.455 180.061 241.346 178.696C240.279 177.331 239.746 175.56 239.746 173.384H255.298C256.578 173.384 257.623 173.789 258.434 174.6C259.245 175.368 259.65 176.392 259.65 177.672V182.408C259.65 185.352 258.818 187.976 257.154 190.28C255.533 192.584 253.25 194.376 250.306 195.656C247.362 196.936 243.991 197.576 240.194 197.576ZM273.062 158.472C273.062 156.339 273.873 154.675 275.494 153.48C277.158 152.243 279.484 151.624 282.47 151.624V190.728C282.47 192.904 281.638 194.589 279.974 195.784C278.353 196.979 276.049 197.576 273.062 197.576V158.472ZM297.183 158.984C297.183 156.723 297.951 154.931 299.487 153.608C301.023 152.285 303.092 151.624 305.695 151.624L326.239 184.136L326.943 183.56L324.063 178.76V151.624C327.092 151.624 329.396 152.2 330.975 153.352C332.553 154.504 333.343 156.189 333.343 158.408V191.368C333.343 192.435 333.001 193.459 332.319 194.44C331.679 195.379 330.804 196.147 329.695 196.744C328.585 197.299 327.412 197.576 326.175 197.576L304.287 162.952L303.583 163.528L306.463 168.328V190.792C306.463 193.011 305.673 194.696 304.095 195.848C302.516 197 300.212 197.576 297.183 197.576V158.984ZM346.77 156.488C346.77 155.293 347.218 154.291 348.114 153.48C349.053 152.627 350.183 152.2 351.506 152.2H380.114C380.114 155.016 379.645 157.064 378.706 158.344C377.767 159.624 376.253 160.264 374.162 160.264H356.178V170.376H372.946C372.946 173.192 372.477 175.24 371.538 176.52C370.599 177.8 369.085 178.44 366.994 178.44H356.178V188.936H375.506C377.554 188.936 379.047 189.576 379.986 190.856C380.925 192.136 381.394 194.184 381.394 197H351.506C350.183 197 349.053 196.595 348.114 195.784C347.218 194.973 346.77 193.949 346.77 192.712V156.488Z" fill="white"/>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 7 KiB |
Loading…
Add table
Add a link
Reference in a new issue