README.md

Tomat.TatsuSharp

Tatsu wrapper in C# for .NET. Adapated from the official Golang wrapper.

Using

Usage is incredibly simple. All you need to do is add the assembly as an assembly reference (fetch the latest release from the Releases page), initialize a TatsuClient with your API key, and do honestly whatever.

Examples

                // Create a TatsuClient by inputting an API key, which is read from a text file in this example.
                TatsuClient client = new(await File.ReadAllTextAsync("tatsu.txt"));
                
                // Context is provided by the Discord.NET API, what matters is we're using the client's IDs.
                TatsuUser user = await client.GetUserProfile(Context.User.Id.ToString());
                
                // Example usage of displaying the information in a Discord.NET embed.
                await ReplyAsync(embed: new BaseEmbed(Context.User)
                {
                    // This serves as an example of using the given fields of a TatsuUser, which stores global Tatsu information (XP, rep, etc.)
                    Title = user.Title,
                    Description = $"Avatar URL: {user.AvatarURL}" +
                                  $"\nCredits: {user.Credits}" +
                                  $"\nDiscriminator: {user.Discriminator}" +
                                  $"\nID: {user.ID}" +
                                  $"\nInfo box: {user.InfoBox}" +
                                  $"\nReputation: {user.Reputation}" +
                                  $"\nTokens: {user.Tokens}" +
                                  $"\nUsername: {user.Username}" +
                                  $"\nXP: {user.XP}"
                }.Build());

Here's what the output looks like:

The general idea is the same for all deserializable types provided. You simply need to initialize a client and all the available methods, which will spit back a deserialized JSON if the given parameters are correct. Rate limiting happens across a singular client instance, so it's advised to only use one instance, as any more won't avoid the rate limit, you'll just get smacked with an error code anyway, and your API key could get revoked if it happens to often.

Rate Limiting

You will be automatically rate-limited after attempting to make 60 requests in a single minute. Your remaining requests are reset to 60 every minute. Rate limiting is handled by the RequestBucket instance in your TatsuClient.