Skip to content

Commit

Permalink
Added icon and updated readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
jimbuck committed Nov 24, 2024
1 parent 0803f60 commit 7d7a433
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 11 deletions.
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
<Configurations>Debug;Release;DebugGenerators</Configurations>
<AllowUnsafeBlocks>True</AllowUnsafeBlocks>
<Platforms>AnyCPU</Platforms>
<ApplicationIcon>Assets\favicon.ico</ApplicationIcon>
</PropertyGroup>
<ItemGroup>
<None Remove="appsettings.json" />
Expand All @@ -21,6 +22,9 @@
<Content Include="Assets\15-Breakout-Tiles.png">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</Content>
<Content Include="Assets\favicon.ico">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</Content>
<Content Include="Assets\49-Breakout-Tiles.png">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</Content>
Expand Down
29 changes: 18 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Ion Engine
A small, positively-charged, middleware-based game engine for C#.

- **Modern:** Built using modern C# features and design patterns, Ion setup closely resembles ASP.NET Core setup.
- **Modern:** Built using modern C# features and design patterns, Ion setup closely resembles ASP.NET Core in setup and configuration.
- **Modular:** Ion is a collection of modules that build on the `Ion.Core` module. You can use as many or as few modules as you want.
- **Middleware:** Using middleware, you can easily add functionality to the engine without having to modify the engine itself. This allows for easy extensibility and customization.

Expand All @@ -16,8 +16,11 @@ A simple, modern code-first game engine inspired by Monogame and Bevy with an AP
- Events
- Storage

### Ion.Extensions.Scenes
Adds support for scenes that each have thier own scope for dependency injection!
### Ion.Extensions.Assets
Adds support for loading assets such as textures, models, and sounds.

### Ion.Extensions.Audio
Adds support for audio playback and manipulation.

### Ion.Extensions.Coroutines
Adds support for coroutines, allowing for async code to be run in a synchronous manner.
Expand All @@ -28,27 +31,31 @@ Adds support for debug utils such as a trace profiler and debug renderer.
### Ion.Extensions.Graphics.Veldrid
Adds window, input, and graphics support using the Veldrid API. Includes a built-in sprite batch for easy 2D rendering.

### Ion.Extensions.Scenes
Adds support for scenes that each have thier own scope for dependency injection!

----

## Planned Modules
- **Ion.Extensions.UI**
- **Ion.Extensions.Networking**
- **Ion.Extensions.Physics**
- Multi-platform support
- Web-based UI Framework
- Low-level Networking
- Plugin-in Physics Engine Support
- Multi-platform build support

## Built Using
## Built Using/Inspired By
- [Veldrid](https://github.com/veldrid/veldrid) for Graphics
- [Assimp.Net](https://github.com/StirlingLabs/Assimp.Net) for asset loading
- [Peridot by Ezequias Silva](https://github.com/ezequias2d/peridot) for Sprite Batch
- [Coroutines by ChevyRay](https://github.com/ChevyRay/Coroutines)

## Contributing

WIP
Feel free to check out the samples and open any issues or pull requests. If you have any questions, feel free to ask in the discussions tab.

### Useful Links
## Examples

- [Graph Visualizer](https://csacademy.com/app/graph_editor/): To visual archetype graph.
Check out the Breakout ECS example for a simple game using the Ion Engine.
![Breakout ECS Screenshot](./breakout-physics-debug.png)

----

Expand Down
Binary file added breakout-physics-debug.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7d7a433

Please sign in to comment.