From 1e90e5fcfcb54d7f8afcb156c1c3d5d11e75766e Mon Sep 17 00:00:00 2001 From: Wulferis Date: Fri, 22 Mar 2024 11:33:45 +1100 Subject: [PATCH 1/2] Update Readme.md --- Readme.md | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/Readme.md b/Readme.md index 66ea32840..6255a2ddf 100644 --- a/Readme.md +++ b/Readme.md @@ -1,10 +1,14 @@ ---- +[![GitHub version](https://img.shields.io/github/v/release/michaelsakharov/prowl?include_prereleases&style=flat-square)](https://github.com/michaelsakharov/prowl/releases) +[![GitHub license](https://img.shields.io/github/license/michaelsakharov/prowl?style=flat-square)](https://github.com/michaelsakharov/prowl/blob/main/LICENSE.txt) +[![GitHub issues](https://img.shields.io/github/issues/michaelsakharov/prowl?style=flat-square)](https://github.com/michaelsakharov/prowl/issues) +[![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) -# Prowl, An Open Source Unity-like C# Game Engine! - +#

An Open Source Unity-like Engine!

+
  1. About The Project
  2. Features
    3. @@ -23,7 +27,7 @@
  3. Screenshots
-# About The Project +#

About The Project

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) @@ -32,7 +36,7 @@ Prowl is an open-source, **MIT-licensed** game engine developed in **pure C# in ![Sponza screenshot](https://i.imgur.com/RrB7A0a.png) -# Features +#

Features

- **General:** - Unity-like Editor & Scripting API @@ -94,7 +98,7 @@ Prowl is an open-source, **MIT-licensed** game engine developed in **pure C# in - Sub-Assets, Assets stored inside other assets

(back to top)

-# Getting Started +#

Getting Started

Getting Prowl up and running is super easy! @@ -110,7 +114,7 @@ Getting Prowl up and running is super easy! 3. That's it! :D

(back to top)

-# Roadmap +#

Roadmap

### Engine - [ ] Cross Platform @@ -146,7 +150,7 @@ Getting Prowl up and running is super easy! See the [open issues](https://github.com/michaelsakharov/prowl/issues) for a full list of proposed features (and known issues).

(back to top)

-# Contributing +#

Contributing

🚀 **Welcome to the Prowl community! We're thrilled that you're interested in contributing.** @@ -188,7 +192,7 @@ All contributors will be acknowledged in our [Acknowledgments](#acknowledgments) **Thank you for considering contributing to Prowl. Together, let's build something amazing!**

(back to top)

-# Acknowledgments +#

Acknowledgments

- 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). @@ -221,7 +225,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)

(back to top)

-# Screenshots +#

Screenshots

![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) From 3ec968262ba9011152a80164df43dd23c748fb07 Mon Sep 17 00:00:00 2001 From: Wulferis Date: Fri, 22 Mar 2024 11:38:51 +1100 Subject: [PATCH 2/2] Update Readme.md --- Readme.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Readme.md b/Readme.md index 6255a2ddf..2672866bf 100644 --- a/Readme.md +++ b/Readme.md @@ -102,6 +102,8 @@ Prowl is an open-source, **MIT-licensed** game engine developed in **pure C# in Getting Prowl up and running is super easy! +**Note: There are no official releases yet so you need to download this repository to use Prowl!** + ### Prerequisites * [Visual Studio Version 17.8.0+](https://visualstudio.microsoft.com/vs/preview/) - Required to support .NET 8