Skip to content

Commit

Permalink
docs: update README with goal (#78)
Browse files Browse the repository at this point in the history
  • Loading branch information
kreempuff authored Sep 22, 2024
2 parents 05dfb6b + 97baf09 commit 1dace1f
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,23 @@
# Bazel rules for Unreal Engine

## Goal

The goal of this project is to provide a set of Bazel rules to build Unreal Engine itself and Unreal Engine projects with Bazel.

### Motivation

I'm making my own game using Unreal. I have a background in Software Engineering/Ops and I found it difficult to navigate all the custom build scripts and tools that Unreal Engine uses.
I want it to be easier to build Unreal Engine and Unreal Engine projects in different environments (Linux, Windows, Mac, CI/CD, etc) without having to think about the ins
and outs of Unreal Engine's build system.

### Why Bazel?

[Bazel](https://bazel.build) is a build system that is designed to be fast, reliable, and reproducible. I know it well enough to be able to map Unreal Engine's build system to it.

### Why not use Unreal's build system?

Unreal Engine's build system is complex and not well documented (in my opinion). It's difficult to understand how to build Unreal Engine and Unreal Engine projects in different environments.

## Quick start

TODO
Expand All @@ -10,8 +28,10 @@ TODO
- [ ] Download a specific commit of Unreal Engine as a bazel repo rule
- [ ] Configure Unreal Engine (mimic `Setup.(bat|sh)` functionality)
- [ ] Download git dependencies
- [ ] Unpack git dependencies
- [ ] Build a module of Unreal Engine in Bazel
- [ ] Build an Unreal module with no dependencies
- [ ] Link Unreal Engine modules together
- [ ] Build Unreal Editor in Bazel
- [ ] Build and Package Unreal Engine projects in Bazel
- [ ] Generate BUILD files for Unreal Engine plugins

0 comments on commit 1dace1f

Please sign in to comment.