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)

Searching Database…

8.9K ·GitHub
Что это такое?Lore — это система контроля версий нового поколения от Epic Games с открытым исходным кодом, созданная для огромных репозиториев и больших команд — особенно для проектов, где код сочетается с крупными бинарными ассетами, например игр и развлекательного контента.
Это один инструмент или целая система?Это целый набор: базовая библиотека, централизованный сервер Lore и CLI. Состояние репозитория хранится в виде Merkle-деревьев с адресацией по содержимому и неизменяемой цепочкой ревизий, а CLI открывает доступ ко всей функциональности.
Как его запустить?Установите Lore и запустите локальный сервер в демо-режиме — в README есть готовые команды для macOS/Linux и Windows PowerShell. Дальше Quickstart-гайд проведёт вас через первый коммит.
Можно ли использовать в продакшене?Lore ещё не дошёл до версии 1.0 и активно разрабатывается: интерфейсы, форматы на диске и API могут меняться от релиза к релизу, так что если строить на нём что-то — готовьтесь к постоянным изменениям.
На каких платформах он работает?macOS, Linux и Windows — команды установки в демо-режиме есть для всех трёх.
Как Lore справляется с огромными бинарными файлами вроде игровых ассетов?Файлы хранятся в виде переиспользуемых чанков с адресацией по содержимому и индексированным поиском, поэтому крупные ассеты дедуплицируются, а обновления и передача данных остаются быстрыми. Рабочие копии могут оставаться разреженными (sparse) — данные файла подгружаются только тогда, когда они действительно нужны.
Ветви легко создавать и переключаться между ними?Да. Ветви — это лёгкие изменяемые ссылки, поэтому их создание и переключение почти ничего не стоят и не требуют дублирования данных — всё рассчитано на свободные эксперименты, итерации и релизы.
Какое отношение Lore имеет к Fortnite?Lore уже сейчас — встроенная система контроля версий в UEFN (Unreal Editor for Fortnite). Инструменты с открытым кодом пока не могут подключаться к репозиториям UEFN, потому что UEFN использует проприетарный формат сжатия, но Epic переносит UEFN на тот же открытый формат, который использует этот проект.
Могу ли я интегрировать Lore со своими инструментами?Да — API описан как full-surface, то есть доступен через C/C++, C#, Rust, Go, Python или JavaScript, причём есть официальные SDK-репозитории для JavaScript, Python, C# и Go. Сам CLI даёт прямой доступ ко всей функциональности Lore.
What are similar projects?SpacetimeDB, nakama, AirSim, kubo, z3, supertonic, walgithub, crab
Creator
EpicGames
Size
14.5 MB
Stars
8.9K
Age
4mo
Commits · 90 Days