Skip to content

Commit 83d3c6f

Browse files
Update README.md
1 parent 466ff27 commit 83d3c6f

File tree

1 file changed

+42
-20
lines changed

1 file changed

+42
-20
lines changed

README.md

Lines changed: 42 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,21 @@
1-
# TODO
1+
![GitHub-Mark-Light](https://user-images.githubusercontent.com/50978201/193459338-32d71599-19d6-4eb6-b5b3-c34348d623b9.svg#gh-dark-mode-only)
2+
![GitHub-Mark-Dark](https://user-images.githubusercontent.com/50978201/193459322-b078ed0d-cf0d-4791-ad10-ee2f3131cd20.svg#gh-light-mode-only)
23

3-
- Replace Project Name in /github
4-
- Ensure that all binaries are built in src/bin
5-
- Ensure that build, unit and release workflows work.
6-
- Create nice README.
7-
8-
<div align="center">
9-
10-
![Logo1](https://github.com/user-attachments/assets/685303c1-4357-4b0e-ac5f-2df69abed36c#gh-light-mode-only)
11-
![Logo](https://github.com/user-attachments/assets/d19450e2-b91f-48ca-b8ca-3fe0f8a30c29#gh-dark-mode-only)
12-
13-
</div>
144

155
<div align="center">
166

17-
# Welcome to {{Project Name}}!
18-
19-
[![✅ Build Status Check](https://github.com/softwareantics/{{ProjectName}}/actions/workflows/build-status-check.yml/badge.svg?branch=final)](https://github.com/softwareantics/FinalEngine/actions/workflows/build-status-check.yml)
20-
[![🧪 Unit Tests Status Check](https://github.com/softwareantics/{{ProjectName}}/actions/workflows/unit-test-status-check.yml/badge.svg)](https://github.com/softwareantics/FinalEngine/actions/workflows/unit-test-status-check.yml)
7+
[![✅ Build Status Check](https://github.com/softwareantics/FinalEngine/actions/workflows/build-status-check.yml/badge.svg?branch=final)](https://github.com/softwareantics/FinalEngine/actions/workflows/build-status-check.yml)
8+
[![🧪 Unit Tests Status Check](https://github.com/softwareantics/FinalEngine/actions/workflows/unit-test-status-check.yml/badge.svg)](https://github.com/softwareantics/FinalEngine/actions/workflows/unit-test-status-check.yml)
219

10+
<strong>Final Engine</strong> is an open-source game engine developed in C# using .NET 9.0.
11+
What began as a hobby project has rapidly evolved into a tool we're committed to actively developing and maintaining.
12+
The core objective of Final Engine is to offer a feature-rich environment that prioritizes simplicity, accessibility, and full creative freedom.
2213
</div>
2314

15+
<p align="center">
16+
<em>Create an engine that makes game development enjoyable, straightforward, and effortless while granting users complete creative freedom.</em>
17+
</p>
18+
2419
<div align="center">
2520

2621
https://www.softwareantics.com.au
@@ -33,6 +28,7 @@ https://www.softwareantics.com.au
3328
</div>
3429

3530
<p align="center">
31+
<a href="#-key-features">Key Features</a> •
3632
<a href="#-getting-started">Getting Started</a> •
3733
<a href="#-download">Download</a> •
3834
<a href="#-contributing">Contributing</a> •
@@ -41,11 +37,37 @@ https://www.softwareantics.com.au
4137

4238
---
4339

40+
## 🔑 Key Features
41+
42+
### 🖥️ Platform Support
43+
44+
While currently Windows-only, the architecture is intentionally modular and extensible. Key systems (such as rendering, input, and resource management) follow interface-driven design, allowing cross-platform implementations to be added over time.
45+
46+
### 🎨 Rendering Engine
47+
48+
Final Engine currently uses a minimal GDI+ software renderer to prioritize accessibility and simplicity. Through interface segregation, the rendering backend is **designed to be extensible**, paving the way for future support for APIs like OpenGL, Vulkan, or DirectX without disrupting existing code.
49+
50+
### ⚙️ Entity-Component-System (ECS) Architecture
51+
52+
Final Engine is built on the ECS paradigm, promoting a clean separation of concerns and a flexible game structure. This pattern enables high-performance systems and easily testable game logic.
53+
54+
> Learn more about ECS [here](https://en.wikipedia.org/wiki/Entity_component_system).
55+
56+
### 📦 Effortless Resource Management
57+
58+
Includes a lightweight and intuitive `IResourceManager` system, with plug-and-play support via `ResourceLoaderBase`. It’s easy to register and manage new asset types like textures, audio, and more.
59+
60+
### 🛠️ Desktop Editor *(Work in Progress)*
61+
62+
We're actively developing a desktop editor to streamline game development. This visual tool will help users manage scenes, entities, systems, and resources. A preview build is expected by the end of 2025.
63+
64+
---
65+
4466
## 🚀 Getting Started
4567

4668
Follow these steps to build and run the engine.
4769

48-
> 💬 **Need help?** Join our [Discord](https://discord.gg/UNdKXsdeQb) if you run into any setup issues or have feature questions, your feedback is invaluable and helps shape development.
70+
> 💬 **Need help?** Join our [Discord](https://discord.gg/UNdKXsdeQb) if you run into any setup issues or have feature questions. While we don’t yet have full user documentation, your feedback is invaluable and helps shape development.
4971
5072
### ✅ Prerequisites
5173

@@ -54,7 +76,7 @@ Follow these steps to build and run the engine.
5476
### 🧱 Building (Windows, Mac, Linux)
5577

5678
1. Clone or download the repository.
57-
2. Open `{{ProjectName}}.sln` in your preferred IDE.
79+
2. Open `FinalEngine.sln` in your preferred IDE.
5880
3. Build the solution or run `dotnet build` from the CLI.
5981

6082
---
@@ -63,7 +85,7 @@ Follow these steps to build and run the engine.
6385

6486
Release builds will be available via:
6587

66-
- [GitHub Releases](https://github.com/softwareantics/{{ProjectName}}/releases)
88+
- [GitHub Releases](https://github.com/softwareantics/FinalEngine/releases)
6789
- [NuGet Packages](https://www.nuget.org/profiles/softwareantics)
6890

6991
---
@@ -76,6 +98,6 @@ We welcome contributions! Please read our [contribution guidelines](./CONTRIBUTI
7698

7799
## 🧾 License
78100

79-
Licensed under the **GNU AGPL-3.0**.
101+
Licensed under the **GNU AGPL-3.0** with a special exception allowing proprietary games built using the engine.
80102

81103
See [LICENSE](./LICENSE) for full terms.

0 commit comments

Comments
 (0)