lore README

The project's README from github.com/EpicGames/lore. As one markdown file: README.md.

Lore — open source version control by Epic Games

Lore

Next-generation open source version control

Download Lore  ·  Quickstart  ·  Read the docs  ·  Join the conversation

License: MIT Built with Rust

Table of contents

About Lore

Lore is an open source version control system designed for unprecedented scalability of both data and teams. It is optimized for projects that combine code with large binary assets, including games and entertainment, and caters for the needs of developers and artists alike.

[!NOTE] Lore is pre-1.0 and under active development. Interfaces, on-disk formats, and APIs may change between releases.

(back to top)

Get started with Lore

Or try it right now — install Lore and start a local server in demo mode:

macOS / Linux

curl -fsSL https://raw.githubusercontent.com/EpicGames/lore/main/scripts/install.sh | bash -s -- --demo

Windows (PowerShell)

$env:LORE_DEMO=1; irm https://raw.githubusercontent.com/EpicGames/lore/main/scripts/install.ps1 | iex

(back to top)

Overview

[!NOTE] Lore is the built-in version control system for UEFN (Unreal Editor for Fortnite), but today's open source tooling can't yet talk to it: the UEFN build uses a proprietary compression format that can't ship with the open source project. We're actively moving UEFN onto an open compression format — the same one this open source project uses — to eliminate the gap between the two.

(back to top)

Lore's architecture

Lore is a centralized, content-addressed version control system that represents repository state as Merkle trees and an immutable revision chain, optimized for binary-first storage, deduplication, and sparse/on-demand data hydration at scale. For the full model—on-disk formats, chunking internals, and the mechanics of the Merkle tree—read the system design doc.

Highlights

(back to top)

Lore's repositories

Lore spans a family of repositories: the core library, server, and CLI in this repository, plus a software development kit (SDK) for each supported language.

Repository Description Link
Lore Library, Server & CLI The core Lore library, the Lore Server, and the Lore CLI. You are here. View on GitHub
JavaScript SDK The JavaScript binding for the Lore API. View on GitHub
Python SDK The Python binding for the Lore API. View on GitHub
C# SDK The C# binding for the Lore API. View on GitHub
Go SDK The Go binding for the Lore API. View on GitHub

(back to top)

Fully open source

We believe a truly open ecosystem is built collectively using open standards. Lore is fully open source under an MIT license, and we invite you to build the version control system of the future in the open. See CONTRIBUTING.md to get involved.

(back to top)

Contributing

Contributions of every kind are welcome — code, documentation, bug reports, and reviews. Start with CONTRIBUTING.md for the development workflow, then read the Code of Conduct and the project governance model. New to the codebase? The good-first-issue label is a good place to start.

(back to top)

License

Lore is released under the MIT License. See LICENSE for the full text. Copyright (c) 2026 Epic Games, Inc.

(back to top)

Contact and community

(back to top)

lore (EpicGames/lore)

unreal-engine
Searching Database…

8.9K ·GitHub
What is this?Lore is Epic Games' next-generation open source version control system, built for huge repos and teams — especially projects mixing code with large binary assets, like games and entertainment.
Is it one tool or a whole system?It's a suite: a core library, a centralized Lore server, and a CLI. Repository state is stored as content-addressed Merkle trees with an immutable revision chain, and the CLI exposes all functionality.
How do I get it running?Install Lore, then start a local server in demo mode — the README has ready commands for macOS/Linux and Windows PowerShell. The Quickstart guide then walks you through your first commit.
Is it production-ready?Lore is pre-1.0 and under active development: interfaces, on-disk formats, and APIs may change between releases, so expect churn if you build on it.
Which platforms does it run on?macOS, Linux, and Windows — demo-mode install commands are provided for all three.
How does Lore handle huge binary files like game assets?Files are stored as reusable, content-addressed chunks with indexed lookup, so big assets are deduplicated and updates and transfers stay efficient. Workspaces can also stay sparse, fetching file data only when it's actually needed.
Are branches cheap to create and switch?Yes. Branches are lightweight mutable references, so creating and switching them is low-overhead with no duplication of the underlying data — built for freely experimenting, iterating, and releasing.
What does Lore have to do with Fortnite?Lore is already the built-in version control system for UEFN (Unreal Editor for Fortnite). The open source tooling can't talk to those UEFN repos yet because UEFN uses a proprietary compression format, but Epic is migrating UEFN to the same open format this project uses.
Can I integrate Lore with my own tools?Yes — the API is described as full-surface, reachable via C/C++, C#, Rust, Go, Python, or JavaScript, with official SDK repos for JavaScript, Python, C#, and Go. The CLI itself gives one-to-one access to all Lore functionality.
What are similar projects?SpacetimeDB, nakama, AirSim, kubo, z3, supertonic, walgithub, crab
Creator
EpicGames
Size
15.2 MB
Stars
8.9K
Age
4mo
Commits · 90 Days