https://github.com/AdaEngine/AdaEngine

AdaEngine - Multi-platform 2D and 3D game engine written on Swift
https://github.com/AdaEngine/AdaEngine

apple-metal game-development game-engine linux multi-platform swift swift-game-engine vulkan

Last synced: 13 days ago
JSON representation

AdaEngine - Multi-platform 2D and 3D game engine written on Swift

• Host: GitHub
• URL: https://github.com/AdaEngine/AdaEngine
• Owner: AdaEngine
• License: mit
• Created: 2021-08-14T01:01:55.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-22T19:48:26.000Z (6 months ago)
• Last Synced: 2024-05-22T20:51:13.661Z (6 months ago)
• Topics: apple-metal, game-development, game-engine, linux, multi-platform, swift, swift-game-engine, vulkan
• Language: Swift
• Homepage: https://adaengine.github.io
• Size: 103 MB
• Stars: 32
• Watchers: 2
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Authors: AUTHORS.md

Awesome Lists containing this project

README

        


  

    

  



[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/AdaEngine/AdaEngine/blob/main/LICENSE)

## What is AdaEngine?

AdaEngine is a game engine fully written on Swift. The main idea is to encourage Swift developers to use this game engine to create fast and impressive games and user interfaces using Swift as their main language. We hope that AdaEngine can become as popular in the GameDev community as Rust and C# are.

![Screenshot from test game SpaceInvaders](Assets/tilemap.png)

![Screenshot from test game SpaceInvaders](Assets/space_invaders.jpeg)

## Design Goals

* **Capable:** Offer a complete 2D feature set.

* **ECS:** AdaEngine is based on the data-oriented paradigm using a self-written ECS. The AdaEngine has been inspired by Apple's RealityKit framework.

* **Simple:** AdaEngine is easy to use, and our main goal is to enable a quick start and deliver quick results.

## Docs

* **[Tutorials](https://adaengine.github.io/adaengine-docs/tutorials/adaengine/)**: AdaEngine's offical tutorials with how to start your first project.

## Getting started

We recommend checking out the **[Create your first project guide](https://adaengine.github.io/adaengine-docs/tutorials/adaengine/createproject)** for a brief introduction.

To draw a plain window with standard functionality use:

```swift

import AdaEngine

@main

struct AdaEditorApp: App {

    var scene: some AppScene {

        GUIAppScene {

            Window()

        }

        .windowMode(.windowed)

        .windowTitle("AdaEngine")

    }

}

```

## Contributing to AdaEngine

You are welcome to contribute to AdaEngine. Currently, it is under development, and we are working towards our roadmap goals. If you find a bug or have some improvements, we would be glad to see your pull request!

## How to build

Currently we use Bazel and Swift Package Manager as build tools. 

#### Bazel 

Bazel is major build system for project, SPM maybe will be removed in the future versions. To build project for development download [Bazelisk](https://github.com/bazelbuild/bazelisk). To generate xcproject, use `make xcproj` command in terminal. 

#### Swift Package Manager

Use Xcode 15.3 or Visual Studio Code with the [Swift VSCode Extension](https://www.swift.org/blog/vscode-extension/) and then open `Package.swift` file from the root directory.