|
1 | | -# Amino.NET.Interactions |
| 1 | +# Amino.NET.Interactions |
| 2 | +The official Amino.NET Framework made for chatbots! |
| 3 | +# What is this framework about? |
| 4 | +Making chatbots on Amino has always ben quite a hassle, with the Amino.NET.Interactions framework this has never been easier! |
| 5 | + |
| 6 | +## Extras & Credits |
| 7 | +- This C# library is based on [Amino.NET](https://github.com/Amino-NET-Group/Amino.NET) and will therefore include it as a dependency, in case anything on this Library breaks consider updating Amino.NET to the latest stable (or dev) version, if this does not fix your issue, open an issue on github and or [join our community Discord Server](https://discord.gg/qyv8P2gegK) |
| 8 | +- If you find a bug or have an idea you'd like to see in this project, please open an issue for it or join our community discord, alternatively you can always make a pull request if you'd like to contribute to the development of it |
| 9 | +- Sometimes the documentation is not always up to date, we are aware of it and will fix it over time |
| 10 | +- Amino.NET Group / Amino Scripting group and its sub parts do not take any responsibility for any harm being done using this framework, as it is free and **open source**, therefore we can not prevent any harm done. |
| 11 | +- This is a non-profit project, however if you do want to us and our work you can check the Sponsor options of this repository, alternatively you can [check out our Ko-Fi!](https://ko-fi.com/fabiothefox) |
| 12 | +## Important Notice |
| 13 | +By using this library you agree that you are aware of the fact that you are breaking the App services Terms of Service - as Team Amino strictly forbids the use of any sort of third party software / scripting to gain an advantage over other members, any activity by third party tools found by Team Amino may result in your account getting banned from their services! |
| 14 | +## How to install |
| 15 | +You can install Amino.NET.Interactions [on NuGet](https://www.nuget.org) and in any NuGet package manager of your choice! |
| 16 | +## Quick Links |
| 17 | +- [General idea and setup](#where-to-start) |
| 18 | +- [Objects and Values](./Objects.md) |
| 19 | +- [Attributes Guide](./Attributes.md) |
| 20 | +- [Command Examples](./examples.md) |
| 21 | + |
| 22 | + |
| 23 | +# Where to start |
| 24 | +Because Amino.NET.Interactions is a framework built on top of Amino.NET you first need to initialize your Amino Client |
| 25 | +```cs |
| 26 | +Amino.Client client = new Amino.Client(); // Note that you should fill in possible parameters if you want |
| 27 | +client.login("email", "password"); // You need to be logged into your Amino Account (or the account you plan to use as a bot) make sure to NOT disable your websocket as it will be needed |
| 28 | +``` |
| 29 | +### Creating your interaction Client |
| 30 | +The InteractionsClient can be found in the **Amino.Interactions** namespace and needs an **Amino.Client** to be constructed |
| 31 | +```cs |
| 32 | +InteractionsClient interactionClient = new InteractionsClient(client); |
| 33 | +// Our InteractionsClient has a few values we could set, but we will leave it on default for now |
| 34 | +``` |
| 35 | +### Creating your first command module |
| 36 | +With Amino.NET.Interactions you can easily create Command Modules, in short: Every class that is **public** and inherits **InteractionBase** is valid to be registered |
| 37 | +```cs |
| 38 | +public class MyCommandClass : InteractionBase { ... } // This module is valid because it is both public and inherits InteractionBase |
| 39 | +``` |
| 40 | +### Creating your first command |
| 41 | +Amino.NET.Interactions has a few Attributes you can use for your commands, they are stored in the **Amino.Interactions.Attributes** namespace, in this case we will use Async Tasks to get our command done, all commands should be stored inside of a **valid module** |
| 42 | +```cs |
| 43 | +[Command("ping", "Simple Ping Command")] |
| 44 | +public async Task PingCommand(Interaction context) |
| 45 | +{ |
| 46 | + await Respond(context, "pong"); |
| 47 | +} |
| 48 | +``` |
| 49 | +### Registering your modules |
| 50 | +In order for your commands to take effect and be usable, you must first register your modules, you have 2 options for it, register them all or register specific ones |
| 51 | +```cs |
| 52 | +interactionClient.RegisterModule<MyCommandClass>(); // This will register the MyCommandClass as it is a valid module |
| 53 | +interactionClient.RegisterModules(Assembly.GetEntryAssemlbly()); // This will register all valid modules of the project, note that it will always need an Assembly object to be constructed, just pass in the EntryAssembly as shown in the example |
| 54 | +``` |
| 55 | +### Handling Interactions |
| 56 | +In order for your Interactions to be received, you must first subscribe to an event on the `InteractionsClient`, once that is done, Amino.NET.Interactions will automatically redirect incoming interactions into the corresponding functions. |
| 57 | +```cs |
| 58 | +interactionClient.InteractionCreated += (ctx) => { |
| 59 | + interactionClient.HandleInteraction(ctx); // Note that you could also just build a function instead of catching the event like this |
| 60 | +}; |
| 61 | +``` |
| 62 | +### Rules and conventions |
| 63 | +Amino.NET.Interactions has a few rules to keep in mind, these are: |
| 64 | +- In order for a module to be valid it must be **public** and inherit **InteractionBase** |
| 65 | +- Every Command function **must** have a parameter of type **Interaction** as its first parameter, this object will be used for our interaction Context, it is located in the **Amino.Interactions.Objects** namespace |
| 66 | +- For command parameters you currenly only have 2 options, String and String[], a `string` will contain a single word while `string[]` assume that you want to collect the rest of the message, which is why it is advised to be the last parameter, if you choose to collect all remaining words using a `string[]` parameter, you can find them in `index 0` of the array |
| 67 | +- Commands can **not** contain spaces, consider using `-` or `_` |
0 commit comments