Tugi.Integration.IGaming 1.6.3

Tugi.Integration

The Tugi integration library simplifies connecting your code with the Tugi support system and AI agent. It is designed to provide most features out of the box; however, any feature may be overridden for enhanced control. For example the library will add all the /.tugi endpoints to your application and only defer to your code when absolutely necessary, but you can choose to forgo these default implementations and add the endpoints in your own code in your own style. This library is fully open-source (with the MIT licence, so as to be usable with proprietary code) if you would like to use our implementations as a reference.

Niches

Some parts of the code are specialised towards certain markets (aka verticals), as the requirements differ between them. For example the data required about users in healthcare would be very different to the data required about users in bike maintenance. These areas of specialisation are referred to in the code as a Niche, and we can use a namespace alias to keep most code generic:

using Tugi.Integration;
using Niche = Tugi.Integration.IGaming;

namespace MyApplication;

public class TugiUserProvider(PlayerDatabase _db) : Niche.IUserProvider
{
	public async Task<(string, Niche.UserProfile?)> GetAsync(BrandConfig brand, string? id, CancellationToken _)
	{
		var player = _db.GetPlayer(id);
		return (id, new()
		{
			Name = player.Name,
			DisplayName = player.Username,
			Email = player.EMail,
		});
	}
}

The technical reasons for this are that Tugi.Integration requires an IUserProvider instance in the core library, but also needs to know the concrete types provided without knowing which other library (Tugi.Integration.IGaming in this case) is in use. Using the type alias Niche just makes the code more readable while having two slightly different IUserProvider interfaces.

Use

• Installation

  Tugi.Integration is a transitive dependency of the niche-specific integration libraries, so only one of those needs to be installed (and indeed, only one at once is supported):

  dotnet package add Tugi.Integration.IGaming --project MyApplication.csproj
  

• Importing

  using Tugi.Integration;
  using Niche = Tugi.Integration.IGaming;
  

• Basic Setup

  // Service to provide user data to `Tugi`.
  builder.Services.AddSingleton<IUserProvider, TugiUserProvider>();
  
  // Add the internal `Tugi` services.
  builder.Services.AddTugi();
  
  // Use the internal `Tugi` endpoints.
  app.UseTugi();