Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/STREGAsGate/GateEngine
Swift Game Engine supporting Windows, Linux, macOS, HTML5, and more 🚂
https://github.com/STREGAsGate/GateEngine
cross-platform directx directx-12 game-engine gamedev html5 ios linux macos metal opengl swift-game-engine swift5 wasm webassembly webgl windows
Last synced: 8 days ago
JSON representation
Swift Game Engine supporting Windows, Linux, macOS, HTML5, and more 🚂
- Host: GitHub
- URL: https://github.com/STREGAsGate/GateEngine
- Owner: STREGAsGate
- License: apache-2.0
- Created: 2023-01-22T01:56:10.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-05T12:25:16.000Z (3 months ago)
- Last Synced: 2024-10-05T17:15:42.464Z (about 1 month ago)
- Topics: cross-platform, directx, directx-12, game-engine, gamedev, html5, ios, linux, macos, metal, opengl, swift-game-engine, swift5, wasm, webassembly, webgl, windows
- Language: Swift
- Homepage:
- Size: 6.16 MB
- Stars: 309
- Watchers: 9
- Forks: 10
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# GateEngine
A cross platform game engine for Swift that allows you to build 2D and 3D games.
GateEngine includes intuitive APIs for loading resources, handling user inputs, and rendering content.
## Platform Support:
| Platform | CI | Graphics | Audio | Keyboard | Mouse | Touch | Gamepad |
|---------:|:---|:---------|:------|:---------|:------|:------|:--------|
| [**Windows**](https://www.swift.org/getting-started/#on-windows)¹ | [](https://github.com/STREGAsGate/GateEngine/actions/workflows/Windows.yml) | ✔︎ | ⛌ | ✔︎ | ✔︎ | ⛌ | ✔︎ |
| [**macOS**](https://apps.apple.com/us/app/xcode/id497799835) | [](https://github.com/STREGAsGate/GateEngine/actions/workflows/macOS.yml) | ✔︎ | ✔︎ | ✔︎ | ✔︎ | ✔︎ | ✔︎ |
| [**Linux**](https://www.swift.org/getting-started/#on-linux)² | [](https://github.com/STREGAsGate/GateEngine/actions/workflows/Linux.yml) | ✔︎ | ✔︎ | ✔︎ | ✔︎ | ⛌ | ✔︎
| [**iOS**/**tvOS**](https://apps.apple.com/us/app/xcode/id497799835) | [](https://github.com/STREGAsGate/GateEngine/actions/workflows/iOS-tvOS.yml) | ✔︎ | ✔︎ | ✔︎ | ✔︎`iPad` ⛌`tvOS/iPhone` | ✔︎`iOS` ⛌`tvOS` | ✔︎
| **Android**³ | [](https://github.com/STREGAsGate/GateEngine/actions/workflows/Android.yml) | ⛌ | ⛌ | ⛌ | ⛌ | ⛌ | ⛌
| [**HTML5**](https://book.swiftwasm.org/getting-started/setup.html)⁴ | [](https://github.com/STREGAsGate/GateEngine/actions/workflows/HTML5.yml) | ✔︎ | ✔︎ | ✔︎ | ✔︎ | ✔︎ | ✔︎ |
Complete: ✔︎ | Incomplete: ⛌ | Partial: ◑
¹Windows support for Swift is in development. Latest Swift toolchain recommended.
²Developed and tested using Ubuntu (Debian). Fedora compatibility is unknown.
³Pending a community made cross compile SDK.
⁴Targeting recent versions of Safari, FireFox, Edge, and Chrome.
## About
GateEngine is designed to give game developers access to approachable and intuitive APIs to code a game using Swift.
### Math
GateEngine has a custom math library completely coded in Swift.
GameMath allows developers to write math functions using a spoken language style API.
GameMath uses context aware types like `Position3`, `Direction3`, and `Size3`.
This adds an additional layer of understanding to APIs due to the inherent context each type provides.
```swift
let position: Position3 = Position3(0, 1, 0) * Size3(1, 1, 1)
...
let moved: Position3 = position.moved(units, toward: direction)
...
let reflected: Direction3 = direction.reflected(off: surfaceNormal)
...
let halfway = source.interpolated(to: destination, .linear(0.5))
```
### Resources
GateEngine has a simple and intuitive resource loading and caching API.
Resources can be constructed instantly and are non-blocking.
The reference returned is a cache handle and creating multiple instances of the same resource will return the same cache handle.
So you don't need to worry about managing your resources.
You can simply create resources wherever you need.
```swift
// Load geometry
let geometry = Geometry(path: "model.obj")
// Reused the same cache as above. No load required.
let theSameGeometry = Geometry(path: "model.obj")
```
A resource state lets you know when a resource is ready to be used.
In many situations the resource state is checked automatically, like when rendering.
The renderer will automatically skip resources that aren't ready.
But in some situations you may need to check the resource state manually.
```swift
let tileMap = TileMap(path: "tilemap.tmj")
...
if tileMap.state == .ready {
// ready to be accessed
}
```
GateEngine tucks error handling away.
A resource failing to load is usually a development error in games.
It's not typically a runtime error that needs to be handled.
Writing do-try-catch for every resource would become tedious so GateEngine places errors in the resource state.
This allows you to code the game as if the resource was a value type.
Resource errors are logged automatically so you don't usually need to check them.
```sh
[GateEngine] warning: Resource "tileSet.tsj" failedToLocate
[GateEngine] warning: Resource "tileMap.tmj" failedToLocate
```
But if you would like to design a fail-able resource handling mechanism, you can do so by checking for the error in the resource state.
```swift
if case .failed(let error) = resource.state {
// This error was already output as a warning
}
```
### Rendering
GateEngine uses a high level rendering API designed to be flexible and customizable.
Rendering is done in the order things are added allowing you to easily reason about the outcome.
```swift
// Create a 2D draw container
var canvas = Canvas()
// Draw a sprite at a specific location
canvas.insert(sprite, at: position)
// Draw the canvas inside the window
window.insert(canvas)
```
Advanced users can also leverage the lower level DrawCommand API for even more customizability.
### Shaders
In most cases, shaders are handled automatically.
However if you need to make a custom shader, GateEngine provides an easy and intuitive solution.
GateEngine uses a Swift based shader API that allows you to write your shaders directly within your project.
The shaders automatically work on every platform, and there is no cross-compile tools or files to mess with.
```swift
// "Vertex Colors" vertex shader written in Swift
let vsh = VertexShader()
let mvp = vsh.modelViewProjectionMatrix
let vertexPosition = vsh.input.geometry(0).position
vsh.output.position = mvp * Vec4(vertexPosition, 1)
vsh.output["color"] = vsh.input.geometry(0).color
// "Tinted Texture" fragment shader written in Swift
let fsh = FragmentShader()
let sample = fsh.channel(0).texture.sample(
at: fsh.input["texCoord0"]
)
fsh.output.color = sample * fsh.channel(0).color
```
*Shaders are currently under development and are missing some functionality.*
## Getting Started
Add the package to your project like any other package.
```swift
.package(url: "https://github.com/STREGAsGate/GateEngine.git", .upToNextMinor(from: "0.1.0"))
```
*iOS/tvOS require an Xcode project. You cannot use a Swift Package Manager executable for iOS or tvOS.*
### Windows Specific Setup
Swift 5.9.0-5.9.1 Only: A linker error for dinput.lib can be fixed with a workaround [here](https://github.com/apple/swift/issues/68887).
### Linux Specific Setup
For Linux you must install dev packages for OpenGL and OpenAL.
On Ubuntu the following terminal commands will install the needed packages:
```sh
sudo apt-get update --fix-missing
sudo apt-get install freeglut3-dev
sudo apt-get install libopenal-dev
```
# Examples
A suite of example projects is available at [GateEngine Demos](https://github.com/STREGAsGate/GateEngineDemos).
These examples cover a variety of topics including Rendering, User Input and Scripting.
# Support GateEngine!
GateEngine relies on community funding.
If you appreciate this project, and want it to continue, then please consider putting some currency into it.
Every little bit helps!
Support With:
[GitHub](https://github.com/sponsors/STREGAsGate),
[Ko-fi](https://ko-fi.com/STREGAsGate),
or
[Patreon](https://www.patreon.com/STREGAsGate).
## Community & Followables
A GateEngine development blog is published on Discord [here](https://discord.gg/PfqFwQPV96).
Discord is also a great place to ask questions or show off your creations.
[](https://discord.gg/5JdRJhD)
[](https://twitter.com/stregasgate)
[](https://youtube.com/stregasgate)
[](https://www.reddit.com/r/stregasgate/)
# History
GateEngine started its life in 2016 as a "for fun" project that used the typical strategy, for hobby game engine projects, of high performance and small footprint.
It used a scene graph and only worked on Apple devices using OpenGL.
I created a deferred renderer, which is a technique that can reduce work for extremely complicated triple-A games.
At the time I thought this was the greatest thing ever and I really enjoyed learning about.
Then I added lighting, which was again a really fun learning process.
Being able to see results on screen is very motivating and I'm sure that's why most game engines start out as graphics libraries.
And then I added shadow and normal mapping.
Eventually I added skinning and UI.
And I created a 3D model of myself as a test.
This is an early attempt at loading files from the COLLADA format.
Something was still a little off, but I did eventually fix it 😜
And I still needed to actually build the "engine" part. At this point the engine was just a graphics simulation.
Drawing stuff is actually a fairly small portion of what a game engine does.
I eventually learned about collision and different data techniques like Entity-Component-System.
And thats when I started the re-writes...
Developing an engine is a large learning process.
Every time you come up with a good way to do it, you will come up with a better way before you're done implementing the previous way.
At the beginning, iterations are complete rewrites and over time the iterations become more fine grained.
Slowly, my skill at making engines caught up to the designs I was creating and GateEngine began to stabilize.
It was at this point that I realized I wasn't making any games.
I was just building tech demos.
So I decided on my first 3D game. Espionage is a 3D stealth action game that I'm still working on today.
It's inspired by the games I grew up with, and it's the kind of game I always wanted to make.
It's a very big project and it will likely take me a very long time to finish it as a solo developer.
I personally prefer large projects.
I haven't yet been enticed to join a game jam, but perhaps that would be fun experience to try at some point.
Maybe we'll have a GateJam someday!
Anyway, GateEngine was a massive undertaking, and was created to be enjoyed.
So go make something awesome of your own!