Skip to content

Commit

Permalink
Added Emoji's to Readme, made it fancier :D
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelsakharov authored Mar 24, 2024
1 parent 8dd8eb8 commit 03fb2f6
Showing 1 changed file with 44 additions and 45 deletions.
89 changes: 44 additions & 45 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[![GitHub stars](https://img.shields.io/github/stars/michaelsakharov/prowl?style=flat-square)](https://github.com/michaelsakharov/prowl/stargazers)
[![Discord](https://img.shields.io/discord/1151582593519722668?style=flat-square)](https://discord.gg/BqnJ9Rn4sn)

# <p align="center">An Open Source Unity-like Engine!</p>
# <p align="center">🎮 An Open Source Unity-like Engine! 🎮</p>

<a id="readme-top"></a>
<ol>
Expand All @@ -28,16 +28,16 @@
<li><a href="#screenshots">Screenshots</a></li>
</ol>

# <p align="center">About The Project</p>
Prowl is an open-source, **MIT-licensed** game engine developed in **pure C# in .NET 8**, (which surprisingly has **no runtime fees** believe it or not!). It aims to provide a seamless transition for developers familiar with Unity by maintaining a similar API while also following KISS and staying as small and customizable as possible. This engine is intended to be customized to your needs, everything is written to be a "Minimal" Production-Ready Implementation. Ideally, there will be plenty of Modules/Packages to expand on functionality for those who don't want (or are unable) to expand the base engine.
# <p align="center">📝 About The Project 📝</p>
Prowl is an open-source, **MIT-licensed** game engine developed in **pure C# in .NET 8**, (which surprisingly has **no runtime fees** believe it or not! 😮). It aims to provide a seamless transition for developers familiar with Unity by maintaining a similar API while also following KISS and staying as small and customizable as possible. This engine is intended to be customized to your needs, everything is written to be a "Minimal" Production-Ready Implementation. Ideally, there will be plenty of Modules/Packages to expand on functionality for those who don't want (or are unable) to expand the base engine.

### [Join our Discord server!](https://discord.gg/BqnJ9Rn4sn)
### [Join our Discord server!](https://discord.gg/BqnJ9Rn4sn) 🎉

**Note:** The Engine is very young and far from production-ready, mainly developed by a single developer in his spare time. **And has only been tested and compiled for Windows!**

![Sponza screenshot](https://i.imgur.com/RrB7A0a.png)

# <p align="center">Features</p>
# <p align="center">Features</p>

- **General:**
- Unity-like Editor & Scripting API
Expand Down Expand Up @@ -100,7 +100,7 @@ Prowl is an open-source, **MIT-licensed** game engine developed in **pure C# in
- Dependency Tracking
<p align="right">(<a href="#readme-top">back to top</a>)</p>

# <p align="center">Getting Started</p>
# <p align="center">🚀 Getting Started 🚀</p>

Getting Prowl up and running is super easy!

Expand All @@ -115,79 +115,78 @@ Getting Prowl up and running is super easy!

1. Clone the repo
2. Open `.sln` file with [Visual Studio Version 17.8.0+](https://visualstudio.microsoft.com/vs/preview/)
3. That's it! :D
3. That's it! 😄 🎉
<p align="right">(<a href="#readme-top">back to top</a>)</p>

# <p align="center">Roadmap</p>
# <p align="center">🗺️ Roadmap 🗺️</p>

### Engine
- [ ] Cross Platform
- [x] Windows - Fully functional
- [ ] Linux - Compiles & Opens but OpenGL Fails
- [ ] MacOS - Compiles, Input fails and color channels seem off?
- [ ] Andriod - Unknown
- [ ] iOS - Unknown
- [ ] Web - Unknown
- [ ] VR Support
- [ ] Editor VR Support - The Entire editor should be able to function in Desktop VR
- [ ] Navmesh and AI Agents
- [ ] Networking Solution
- 🛠️ Cross Platform
- ✔️ Windows - Fully functional
- 🛠️ MacOS - Compiles, Input fails and color channels seem off?
- ❌ Linux
- ❌ Andriod
- ❌ iOS
- ❌ Web
- ❌ VR Support
- ❌ Navmesh and AI Agents
- ❌ Networking Solution

### Rendering
- [ ] SSAO, Screen-Space Decals, etc.
- [ ] Realtime GI
- [ ] Lightmaps and Light Probes
- [ ] Cascaded shadow mapping
- [ ] Skinned Mesh Rendering & Animations - Partially Implemented
- [ ] Particle System
- [ ] Terrain Engine
- SSAO, Screen-Space Decals, etc.
- Realtime GI
- Lightmaps and Light Probes
- Cascaded shadow mapping
- Skinned Mesh Rendering & Animations - Partially Implemented
- Particle System
- Terrain Engine

### Editor
- [ ] Package Manager (Packages partially implemented)
- [ ] Animation Tools
- [ ] Live Collaborative Tools?
- [ ] Visual Scripting
- [ ] Material Node Editor
- [ ] Basic 2D Support
- Package Manager (Packages partially implemented)
- Animation Tools
- Live Collaborative Tools
- Visual Scripting
- Material Node Editor
- Basic 2D Support


See the [open issues](https://github.com/michaelsakharov/prowl/issues) for a full list of proposed features (and known issues).
<p align="right">(<a href="#readme-top">back to top</a>)</p>

# <p align="center">Contributing</p>
# <p align="center">🤝 Contributing 🤝</p>

🚀 **Welcome to the Prowl community! We're thrilled that you're interested in contributing.**

We're not too proud to admit it – we need your help. 🆘

Developing a game engine is a colossal task, and we can't do it alone. We need passionate developers, designers, testers, and documentation enthusiasts, people like you to help make Prowl the best it can be.
Developing a game engine is a colossal task, and we can't do it alone. We need passionate developers, designers, testers, and documentation enthusiasts, people like you to help make Prowl the best it can be. 💪

## How You Can Contribute

### Code Contributions
### Code Contributions 💻

Whether you're a seasoned developer or just getting started, your code contributions are invaluable. We have a list of [open issues](https://github.com/michaelsakharov/prowl/issues) that you can tackle, or feel free to propose your own improvements.

### Bug Reports
### Bug Reports 🐛

Encountered a bug? We want to know! Submit detailed bug reports on our [issue tracker](https://github.com/michaelsakharov/prowl/issues) to help us squash those pesky bugs.

### Feature Requests
### Feature Requests 💡

Have a fantastic idea for a new feature? Share it with us! Open a [feature request](https://github.com/michaelsakharov/prowl/issues) and let's discuss how we can make Prowl even better.

<!--Need a Documentation Site, Probably Hugo?-->
<!--
### Documentation
### Documentation 📚
Documentation is crucial, and we could use your help to make ours more comprehensive and user-friendly. Contribute to the [docs](linktodocshere) and help fellow developers get the most out of Prowl.
-->

### Spread the Word
### Spread the Word 📣

Not a developer? No problem! You can still contribute by spreading the word. Share your experiences with Prowl on social media, blogs, or forums. Let the world know about the exciting things happening here.

## Contributor Recognition
## Contributor Recognition 🏆

We're not just asking for contributors; we're asking for partners in this journey. Every small contribution is a step toward realizing Prowl.

Expand All @@ -196,13 +195,13 @@ All contributors will be acknowledged in our [Acknowledgments](#acknowledgments)
**Thank you for considering contributing to Prowl. Together, let's build something amazing!**
<p align="right">(<a href="#readme-top">back to top</a>)</p>

# <p align="center">Acknowledgments</p>
# <p align="center">🙏 Acknowledgments 🙏</p>

- Hat tip to the creators of [Raylib](https://github.com/raysan5/raylib), While we are no longer based upon it, it has shaved off hours of development time getting the engine to a usable state.
- Some ideas/code have been taken from the amazing 2D Engine [Duality](https://github.com/AdamsLair/duality).
<p align="right">(<a href="#readme-top">back to top</a>)</p>

## Contributors
## Contributors 🌟
- [Michael (Wulferis)](https://twitter.com/Wulferis)
- [Josh Davis](https://github.com/10xJosh)
- [ReCore67](https://github.com/recore67)
Expand All @@ -211,12 +210,12 @@ All contributors will be acknowledged in our [Acknowledgments](#acknowledgments)
- [JaggerJo](https://github.com/JaggerJo)
- [Jihad Khawaja](https://github.com/jihadkhawaja)

# License
# License 📜

Distributed under the MIT License. See `LICENSE.txt` for more information.
<p align="right">(<a href="#readme-top">back to top</a>)</p>

# Dependencies
# Dependencies 📦

### Runtime
- [Silk.NET](https://github.com/dotnet/Silk.NET)
Expand All @@ -229,7 +228,7 @@ Distributed under the MIT License. See `LICENSE.txt` for more information.
- [ImGUI](https://github.com/ocornut/imgui) via [ImGUI.NET](https://github.com/ImGuiNET/ImGui.NET)
<p align="right">(<a href="#readme-top">back to top</a>)</p>

# <p align="center">Screenshots</p>
# <p align="center">📸 Screenshots 📸</p>
![Bokeh Depth of Field](https://i.imgur.com/VYs44qq.png)
![Editor](https://github.com/michaelsakharov/Prowl/assets/8621606/bb3c423b-3cc8-45a1-baa7-c9ad31d945c6)
![image](https://github.com/michaelsakharov/Prowl/assets/8621606/f755ee5d-eba5-4453-9f31-f61768c2554c)
Expand Down

0 comments on commit 03fb2f6

Please sign in to comment.