Pilgrimage 6.0.7

Pilgrimage

Quest and inventory orchestration for .NET and Unity. Lightweight domain models. Practical game-facing APIs. Story, progression, and rewards without building the plumbing yourself.

Why

When your game needs quests, rewards, inventory checks, and player progression, the hard part is keeping the rules consistent. Pilgrimage gives you a focused API for starting quests, validating requirements, completing objectives, and granting rewards.

No full game framework. No forced architecture. Just quest and inventory flow you can plug into your own systems.

Install

dotnet add package Pilgrimage

Install into Unity

In Package Manager add the following git url:

https://github.com/olivegamestudio/Pilgrimage.git?path=/upm

Quick start

using Microsoft.Extensions.DependencyInjection;
using Pilgrimage;

IServiceCollection services = new ServiceCollection();
services.AddPilgrimage();

IServiceProvider provider = services.BuildServiceProvider();
IPilgrimage pilgrimage = provider.GetRequiredService<IPilgrimage>();

PlayerProgress progress = new(new Dictionary<int, QuestState>());
Inventory inventory = new(new List<InventorySlot>(), capacity: 20);
Player player = new(id: 1, inventory, progress);

var eligibility = pilgrimage.CheckStartingRequirements(player, questId: 10);
if (!eligibility.IsError)
{
    pilgrimage.StartQuest(player, questId: 10);
}

var canAdd = pilgrimage.CanAddItem(player, itemId: 42, quantity: 3);
if (!canAdd.IsError)
{
    pilgrimage.AddItem(player, itemId: 42, quantity: 3);
}

API

• ErrorOr<Success> StartQuest(Player player, int questId)
• ErrorOr<Success> CheckStartingRequirements(Player player, int questId)
• ErrorOr<Success> CompleteQuest(Player player, int questId)
• ErrorOr<Success> CheckCompletingRequirements(Player player, int questId)
• ErrorOr<Quest> GetQuestDefinition(int questId)
• ErrorOr<Success> CanAddItem(Player player, int itemId, int quantity)
• ErrorOr<Success> AddItem(Player player, int itemId, int quantity)
• ErrorOr<bool> HasItem(Player player, int itemId, int quantity)

License

MIT