{"id":29406368,"url":"https://github.com/teoadal/hexecs","last_synced_at":"2026-01-17T02:57:15.699Z","repository":{"id":297221550,"uuid":"996054164","full_name":"teoadal/Hexecs","owner":"teoadal","description":"Это маленький движок логики, имплементирующий ECS (Entity-Component-System), который весьма удобен для создания игровой логики на C#","archived":false,"fork":false,"pushed_at":"2025-06-05T08:15:39.000Z","size":257,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-07-05T16:22:44.845Z","etag":null,"topics":["c-sharp","ecs","entity-component-system","game","game-engine","gamedev"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/teoadal.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-06-04T11:46:10.000Z","updated_at":"2025-06-05T05:46:44.000Z","dependencies_parsed_at":"2025-06-08T05:45:15.159Z","dependency_job_id":null,"html_url":"https://github.com/teoadal/Hexecs","commit_stats":null,"previous_names":["teoadal/hexecs"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/teoadal/Hexecs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teoadal%2FHexecs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teoadal%2FHexecs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teoadal%2FHexecs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teoadal%2FHexecs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/teoadal","download_url":"https://codeload.github.com/teoadal/Hexecs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teoadal%2FHexecs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264686799,"owners_count":23649565,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["c-sharp","ecs","entity-component-system","game","game-engine","gamedev"],"created_at":"2025-07-10T23:20:07.240Z","updated_at":"2026-01-17T02:57:15.686Z","avatar_url":"https://github.com/teoadal.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![.NET Core](https://github.com/teoadal/Hexecs/actions/workflows/dotnet.yaml/badge.svg?branch=master)](https://github.com/teoadal/Hexecs/actions/workflows/dotnet.yaml)\n[![NuGet](https://img.shields.io/nuget/v/Hexecs.svg)](https://www.nuget.org/packages/Hexecs)\n[![NuGet](https://img.shields.io/nuget/dt/Hexecs.svg)](https://www.nuget.org/packages/Hexecs)\n[![codecov](https://codecov.io/gh/teoadal/Hexecs/branch/master/graph/badge.svg?token=8L4HN9FAIV)](https://codecov.io/gh/teoadal/Hexecs)\n[![CodeFactor](https://www.codefactor.io/repository/github/teoadal/Hexecs/badge)](https://www.codefactor.io/repository/github/teoadal/Hexecs)\n\n# HexECS\n\nПривет! Это движок, имплементирующий ECS. Тут ты можешь делать многое, к чему и так привык.\nПри этом, ты можешь чуть больше, чем обычные ECS, так как помимо ECS в библиотеке есть встроенный CQRS и DI.\nCQRS в связке с ECS представляется мне максимально подходящей штукой для управления состоянием сущностей через системы.\nDI необходим для того, чтобы всё это работало удобно.\n\n## Базовые возможности\n\nТак как всё в этом мире завязано на \"мир\" (`World`), то мы начнём с его создания.\n```csharp\nvar world = new WorldBuilder()\n    .DefaultParallelWorker(4) // чтобы обрабатывать сущности в 4 потока\n    .DebugWorld() // чтобы получать больше информации в Debug-режиме \n    .CreateLogger(logger =\u003e logger.UseConsoleSink()) // чтобы логи выводились в консоль\n    .Build();\n```\nЭтот код создаёт сконфигурированный объект World. Так как библиотека AOT-friendly, тут нет сканеров assembly для регистрации отдельных компонентов. Всё нужно регистрировать вручную.\n\n### Создание компонента\n\nКомпонент - это один из базовых кирпичиков ECS.\nДля того, чтобы системы могли наполнить сущность жизнью, сущность должна обладать признаками - компоненты и есть эти признаки.\n\n```csharp\npublic struct FlyComponent(int current, int max) : IActorComponent { // необходимо указать маркерный интерфейс\n    public int CurrentSpeed = current;\n    public int MaxSpeed = max;\n}\n```\nКомпоненты должны быть `struct`, чтобы всё в вашем мире могло работать эффективно и быстро.\nНапример, обрабатывать в системах или обработчиках шины сообщений.\n\n### Создание сущности\n\nВ этом мире есть две сущности - Actor'ы и Asset'ы.\n- **Актёры** - это динамичные изменяемые сущности, которые могут создаваться и удаляться, и которым можно добавлять и удалять компоненты.\n- **Ассеты** - это сущности, которые нельзя изменить, представляющие из себя настройки мира, но которые также имеют компоненты.\nЕдинственное отличие - их нельзя создавать в процессе работы, так как они, по задумке, представляют из себя ресурсы, на основе которых будут создаваться актёры.\n\nСоздать актёра можно следующим образом:\n```csharp\nActor actor = world.Actors.CreateActor();\nactor.Add(new FlyComponent(10, 20));\nActor\u003cFlyComponent\u003e typedActor = actor.As\u003cFlyComponent\u003e();\n```\n\nВ последней строчку был создан т.н. \"типизированный актёр\" или актёр, в котором точно есть летающий компонент.\nЭта щепотка типизации очень важна в случаях, когда вам хотелось бы знать заранее - действительно ли актёр содержит нужный компонент. Например, в шине сообщений.\n\nСтруктура `Actor` и `Actor\u003cT\u003e` предоставляют удобную обёртку для взаимодействия с актёром. Актёр всегда знает к какому `ActorContext` он принадлежит и просто проксирует методы к контексту, чтобы программисту было проще.\n\nБолее привычным типом entity для классических ECS будет являться содержимое поля `Actor.Id`, которое содержит в себе идентификатор актёра. \nЕсли вам удобнее работать с ними, можно сделать так:\n\n```csharp\nActorId actorId = typedActor;\n```\n\n### Добавление компонентов\n\nСозданный актёр может быть создан с использованием метода `world.Actors.Create()`.\nВ этом случае он не будет обладать компонентом `FlyComponent`. Если мы не добавили его ранее, то добавим его:\n```csharp\nactor.Add(new FlyComponent { CurrentSpeed = 5, MaxSpeed = 7 });\n```\nТо, что компонент теперь принадлежит актёру можно легко проверить с помощью метода:\n```csharp\nactor.Has\u003cFlyComponent\u003e(); // it's true!\n```\n\nПоздравляю, мы создали компонент и теперь можем его редактировать.\nДля этого достаточно получить ссылку на компонент и отредактировать его.\n```csharp\nref var component = ref actor.Get\u003cFlyComponent\u003e();\ncomponent.Current = 15;\n```\n\nОднако, в данном случае никто никогда не узнает о том, что было что-то изменено. \nИногда это важно, например, чтобы держать кэш позиций некоторых актёров.\n\nЧтобы все точно узнали, что были изменения, нужно использовать специальный метод:\n\n```csharp\nvar component = actor.Get\u003cFlyComponent\u003e(); // копируем компонент\ncomponent.Current = 15; // изменяем значение копии\nactor.Update(component); // в этот момент все узнают, что что-то изменилось\n```\n\n### Удаление компонентов\n\nТут всё тоже предельно просто. Представим, что у нас есть компонент `Pilot` (на самом деле структура `PilotComponent : IActorComponent`), который мы уже добавили к актёру-самолёту.\nПосле того как пилот захотел спать, он покинет самолёт следующим способом:\n```csharp\nactor.Remove\u003cPilotComponent\u003e();\n```\nЕсли пилота там не было, метод вернёт `false` и мы сможем обработать это вопиющее нарушение правил полётов.\nЕсли компонент был, то метод вернёт `true`, а значит мы можем быть уверенными, что пассажиры в безопасности.\n\n## Дочерние элементы\n\nПассажиры! Их тоже можно создать примерно так:\n\n```csharp\nAsset passengerAsset = world.GetAsset\u003cPassengerAsset\u003e(); \nActor passenger = world.Actor.BuildActor(passengerAsset, Arg.Rent(\"plane\", planeActor))\n```\n\nМы находим ассет пассажира (вспомним, что у него есть компоненты). \nДопустим, что он всего один. \nНа второй строке, с помощью зарегистрированных `IActorBuilder` (имплементации \"строителей\" актёров по компонентам ассета), буквательно создаём актёра.\nКстати, если нам будет нужно, мы сможем проверить, по какому ассету был построен актёр, запросив `actor.TryGetAsset`.\n\nПосле создания пассажиров, мы можем в прямом смысле посадить их на самолёт.\nДля этого нужно воспользоваться следующим методом:\n\n```csharp\nActor\u003cFlyComponent\u003e plane = ...; \nActor passenger = ...;\nplane.AddChild(passenger);\n```\n\nЕсли повторить это много раз, то в самолёте будут сидеть множество пассажиров (в зависимости от типа самолёта, конечно).\n\n## Системы\n\nУ нас же ecS, а значит у нас есть системы. \nСистемы - это классы, которые обрабатывают компоненты актёров. \nОни могут быть зарегистрированы в мире и запущены для обработки компонентов.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteoadal%2Fhexecs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fteoadal%2Fhexecs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteoadal%2Fhexecs/lists"}