Getting Started: Developing the bot

Installing Guilded.NET

First of all, create a new project. Guilded.NET works with any template.

Guilded.NET offers installable MSBuild templates, which can be found here. Just be sure to edit the config/config.json file and insert your token.

Install Guilded.NET by typing dotnet add package Guilded.NET and Guilded.NET dependency should be added to your project. Now we’ll need to run your bot.

Configuring your bot

Now we’ll need to define prefix and an authentication token for your bot. You can use either constants or configuration files for that, but we’ll use a configuration file.

The name of the directory, the file and even properties in the file can be whatever you want to name it, but make sure it is referenced in your code. We’ll use config/config.json in this documentation.

In your config file, create a property auth and property prefix, where your authentication token and prefix will be stored:

{    "auth": "authentication_credentials_here",    "prefix": "!"}

Be sure to make MSBuild not ignore your config folder in your project file:

<!-- ... Other stuff ... --><ItemGroup>    <Content Include="config/*">        <CopyToOutputDirectory>Always</CopyToOutputDirectory>    </Content></ItemGroup><!-- ... Other stuff ... -->

We now have a configuration file that we can safely reference in our code and use properties in it. You can use either System.Text.Json or Newtonsoft.Json to deserialize our JSON and get its values. For this tutorial, we are going to use Newtonsoft.Json, since Guilded.NET has Newtonsoft.Json as a dependency. Newtonsoft.Json will be removed as a dependency in the future, so if you’ll still want to use Newtonsoft.Json, it is recommended to add Newtonsoft.Json as a dependency in your project.

We are now going to get the configuration and use it in our bot:

using System.IO;using Guilded;using Newtonsoft.Json.Linq;

JObject config = JObject.Parse(File.ReadAllText("./config/config.json"));string auth   = config.Value<string>("auth"),       prefix = config.Value<string>("prefix");await using var client = new GuildedBotClient(auth);

You can now run your project, but as we can see, it doesn’t really do anything. But that’s because we are only creating our bot, not connecting to Guilded yet, which we are going to do in the next section.

Connecting to Guilded

Method ConnectAsync is used to connect the client to Guilded. But once you use it, the bot will connect to Guilded and program will close seeing that it’s done. One of the ways to stop it from closing is to use await Task.Delay(-1):

using System.IO;using System.Threading.Tasks;using Guilded;using Newtonsoft.Json;

// Below static void Main()static async Task RunAsync(GuildedBotClient client){    await client.ConnectAsync().ConfigureAwait(false);    // Stop program from closing    await Task.Delay(-1);}

Now we can reference it in Main method:

// static void Main()RunAsync(client).GetAwaiter().GetResult();

To see if connection between Guilded and the client are initiated, we can subscribe to Prepared or Connected events:

using System;using System.IO;using System.Threading.Tasks;using Guilded;using Newtonsoft.Json;

// Below `await using GuildedBotClient client = ...;`client.Prepared      .Subscribe(me =>          Console.WriteLine("The bot is prepared.\nLogged in as \"{0}\" with the ID \"{1}\"", me.Name, me.Id)      );

The main difference is that Connected gets connected once the bot is online and can be functional, while Prepared is called once the bot is connected and gets additional information, such as client.Me. If Connected gets called before Prepared, the client.Me property will always be null.

Once the bot successfully connects and does everything it needs, you will be able to see The bot is prepared. in the console.

The bot won’t do anything apart from connecting to Guilded. In Powering up the bot document, we are going to give functionality to our bot with text commands.