https://github.com/bitwizeshift/alloy
🚧A WIP hobbyist game engine written in modern C++
https://github.com/bitwizeshift/alloy
cpp cpp17 entity-component-system game-development game-engine gamedev open-source
Last synced: 9 months ago
JSON representation
🚧A WIP hobbyist game engine written in modern C++
- Host: GitHub
- URL: https://github.com/bitwizeshift/alloy
- Owner: bitwizeshift
- License: mit
- Created: 2019-01-19T13:31:42.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-10-10T20:49:49.000Z (about 3 years ago)
- Last Synced: 2025-03-26T14:01:45.942Z (10 months ago)
- Topics: cpp, cpp17, entity-component-system, game-development, game-engine, gamedev, open-source
- Language: C++
- Homepage:
- Size: 4.71 MB
- Stars: 10
- Watchers: 4
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://github.com/bitwizeshift/Alloy/releases/latest)
[](https://raw.githubusercontent.com/bitwizeshift/Alloy/master/LICENSE)
[](https://github.com/bitwizeshift/Alloy/issues)
**Alloy** is a flexible game-engine and development kit under active
development written in C++.
It is characterized by upholding a strict set of design-goals which
center around maintainability and readability through proper
software engineering practices. The overall goal for this project
is to be a well-rounded and easy-to-use, efficient game-engine.
It is inspired by many great open-source projects that
have come before it, the complete list can be seen
[below](#inspirations).
## Table of Contents
* [Features](#features) \
A summary of all existing features in **Alloy**
* [Components](#components) \
A brief summary of all components in **Alloy**
* [API Reference](https://bitwizeshift.github.io/alloy/api/latest/manual.html) \
For doxygen-generated API information
* [Tutorials](https://bitwizeshift.github.io/alloy/api/latest/tutorials.html) \
For tutorials on how to use **Alloy**
* [Legal](doc/legal.md) \
Information about how to attribute this project
* [How to build](doc/building.md) \
Detailed instructions for how to build **Alloy**
* [Design Goals](doc/design-goals.md) \
The design goals of this library
* [Contributing Guidelines](.github/CONTRIBUTING.md) \
Guidelines that must be followed in order to contribute to the project
* [x] Written with Modern C++ (C++17)
* [x] Supports for `constexpr` wherever possible
* [x] Designed using componentized architecture (easier reuse)
* [x] Strong focus on readability and design
* [ ] Supports multiple render systems _(in progress)_
* [ ] OpenGL
* [ ] DirectX
* [ ] Vulkan
* [ ] Supports multiple audio systems _(in progress)_
* [ ] OpenAL
* [ ] FMOD
* [ ] Handles intersections of geometric objects
* [ ] Easily build scene graphs and skeletons
* [ ] Manages game objects using entity-component system
**Alloy** is designed using component-based architecture in order to promote
better logical design and reusability through code-sharing.
The library and application components are detailed below:
### Libraries
* [`Alloy::Core`](lib/alloy-core/README.md) \
The core library that the rest of **Alloy** is built off of
* [`Alloy::IO`](lib/alloy-io/README.md) \
The library for managing all IO tasks (filesystem, network, etc)
* [`Alloy::Render`](lib/alloy-render/README.md) \
The library for managing rendering tasks, and abstracting the
underlying rendering system (DX, OpenGL, etc)
* [`Alloy::Audio`](lib/alloy-audio/README.md) \
The library for managing the audio tasks, and abstracting the
underlying mixing system (FMOD, OpenAL, etc)
* [`Alloy::Engine`](lib/alloy-engine/README.md) \
The library for managing all engine details, including subsystem
initialization & coordination, entity-component management,
resource management, etc.
### Applications
TODO detail applications
**Alloy** was inspired by a variety of existing open-source projects.
Some of these projects are listed below:
- [Godot](https://github.com/godotengine/godot)
- [Blade](https://github.com/crazii/blade)
- [Ogre](https://github.com/OGRECave/ogre/pulls)
- [Nomad](https://github.com/taurheim/NomadECS)
- [easy-engine](https://github.com/callebstrom/easy-engine)
**Note:** _inspired_ does not mean that any code was taken without following
proper license attribution. It simply means that certain designs and concepts
may have been adjusted to align with what other existing projects are
already doing.
The following compilers are currently being tested through
[continuous integration](#continuous-integration) with
[Travis](https://travis-ci.com/bitwizeshift/Alloy) and
[AppVeyor](https://ci.appveyor.com/project/bitwizeshift/Alloy/)
| Compiler | Operating System | Architectures |
|-----------------------|-------------------|---------------|
| g++-9 | Ubuntu 18.04 | x86, x86_64 |
| clang++-9 | Ubuntu 18.04 | x86, x86_64 |
| clang xcode 11.3 | macOS (Latest) | x86_64 |
| Visual Studio 2019 | Windows (Latest) | x86, x86_64 |
| clang-cl | Windows (Latest) | x86, x86_64 |
| clang++-9 | Windows (Latest) | x86, x86_64 |
| **Build** | **Status** |
|---------------|-----------------|
| Windows | [](https://github.com/bitwizeshift/Alloy/actions?query=workflow%3Abuild-windows) |
| Linux | [](https://github.com/bitwizeshift/Alloy/actions?query=workflow%3Abuild-linux) |
| macOS | [](https://github.com/bitwizeshift/Alloy/actions?query=workflow%3Abuild-macos) |
| **Host** | **Release** |
|---------------------|------------------|
| Github | [](https://github.com/bitwizeshift/Alloy/releases/latest) |
| Conan | [](#)
**Alloy** is licensed under the
[MIT License](http://opensource.org/licenses/MIT):
> Copyright © 2018 Matthew Rodusek
>
> Permission is hereby granted, free of charge, to any person obtaining a copy
> of this software and associated documentation files (the "Software"), to deal
> in the Software without restriction, including without limitation the rights
> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
> copies of the Software, and to permit persons to whom the Software is
> furnished to do so, subject to the following conditions:
>
> The above copyright notice and this permission notice shall be included in all
> copies or substantial portions of the Software.
>
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
> SOFTWARE.