project-hedra README

README проекта с github.com/maxilevi/project-hedra. Одним файлом markdown: README.md.

Project Hedra

All code at the pre-ai tag and in its earlier history was written before AI-assisted development.

Project Hedra is an ambitious open-world, low-poly RPG. Choose your class, explore endless procedurally generated worlds, unlock different skills and complete procedurally generated quests.

More screenshots at (Screenshots)

Timeline/Context

I started this project when I was in highschool (around 15 yo) in order to learn how OpenGL worked.

The scope creep quickly arrived and after a few years it turned into a fullfledged 3D game and game engine. The codebase has around 100k LOC and the game has first class support for Linux and Windows.

Features

The million lines of code are not in vain. The game and engine are both full of features :)

Game Features

Engine Features

Interesting bits

Interesting facts

Screenshots

image image image image

TODO add more

Code Structure

Overall Architecture

The game is a mod to a base engine. The idea of architecturing this way was to force myself to maintain the mod API up to date, therefore encouraging access to make mods.

Hedra

Basically the entire game. This includes AI logic, components, world generation, module systems, object placement and lots of other stuff.

Hedra.Engine

The core parts of the engine, this defines all the abstractions to the world. It handles rendering, sound, different base systems as well as the general windowing, game loop and platform features. The split was not done at the start so some stuff might still be outside.

Framework

Core primitives used in the engine. This includes heap and stack allocators, custom implementations of lists and arrays as well as wrappers to pointers to native and some other useful primitives

HedraTests

Test suite that

Asset Builder

Command line tool to compress the game assets into convenient binary files. Combines images, models, sound files, shaders into a single binary file with a structure designed for fast data retrieval.

Server

Once upong a time Hedra used to support multiplayer. It worked by doing UDP Hole Punching and having clients communicate P2P, this server was in charge of that. You might also see some networking remnants in the Engine code.

How to build

The build process is pretty straightforward.

  1. Checkout all the submodules
  2. Run the build depedencies scripts
  3. Compile the C# solution

You can check the GitHub actions workflows for some examples on Linux and Windows.

project-hedra (maxilevi/project-hedra)

Ищем в базе…

Что это такое?Project Hedra — это трёхмерная action RPG с открытым миром в низкополигональной графике, а также собственный игровой движок, на котором она построена. Автор начал писать его с нуля ещё в старшей школе. В игре есть процедурно генерируемые миры, квесты, классы, навыки и полноценный воксельный рендерер. Весь код занимает около 100 тысяч строк на C#.
Это просто игра или ещё и движок, который можно использовать повторно?Игра построена как мод поверх отдельного базового движка («Hedra.Engine»). Поэтому код движка (рендеринг, звук, работа с окнами) отделён от кода игры (ИИ, генерация мира, предметы). Но движок создавался специально для этой игры и не выпущен как самостоятельный SDK.
Как собрать и запустить игру?Установщика и готовых сборок нет: проект нужно собирать из исходников. Для этого загрузите все git-субмодули, запустите скрипты установки зависимостей для сборки и скомпилируйте C#-решение. Рабочие шаги сборки для Linux и Windows показаны в workflow-файлах GitHub Actions.
Что нужно установить, чтобы всё скомпилировать?Нужна среда .NET/C# для компиляции решения, а также git-субмодули проекта (в том числе интеграция с Bullet Physics) и сторонние библиотеки, которые подтягивают скрипты установки зависимостей.
Есть ли подвохи, прежде чем я попробую?Готового релиза нет, поэтому собрать игру придётся самому через субмодули и скрипты. Поддержка мультиплеера (P2P через UDP hole-punching) когда-то существовала, но, судя по всему, её убрали: в движке остались только следы сетевого кода. Раздел со скриншотами помечен как TODO.
Игра работает на Windows и Linux?Да, игра полноценно поддерживает Linux и Windows. О macOS ничего не сказано.
Почему проект назван «Hedra»?Название происходит от «tetrahedra» (тетраэдры) — так называется фигура, на которой основан изначальный алгоритм выделения изоповерхностей (Marching Tetrahedra), реализованный автором до перехода на Marching Cubes.
Если файла сохранения мира нет, как игра запоминает мир?Мир полностью генерируется процедурно во время работы игры из сида (seed). Сохраняются только данные игрока и сам сид, а не рельеф, поэтому вся карта каждый раз воссоздаётся детерминированно.
Какая самая крутая техническая деталь в коде?WorldRenderer.cs отрисовывает весь воксельный мир примерно за 3 вызова отрисовки (вода, рельеф, инстансированные объекты) с помощью glMultiDrawElements. Воксельные чанки во время работы превращаются в гладкие поверхности алгоритмом Marching Cubes.
Могу ли я писать моды для игры?Да: в движке есть модульная система и поддержка модов. Моды можно писать на Python через IronPython, который напрямую обращается к C# API, — как в поставляемом скрипте Fishing.py.
Какие есть похожие проекты?2010-rust-rewrite-mashup, sbox-public, raylib, Terrain3D, flutter_scene, BRUTAL, bgfx, wutw-public
Автор
maxilevi
Размер
112.5 MB
Звёзды
197
Обновлён
КоммитOct 22
Возраст
7 г
Коммиты · 90 дней