baileyjm02 / unb-api-go

A Go library for the UnbelievaBoat Discord bot API.

UnbelievaBoat API Wrapper

A Go library for the UnbelievaBoat Discord bot API.
By Bailey and Contributors

Website | Discord

Table of Contents

• Introduction
• Features
• Feedback
• Install Process
• Acknowledgments

Introduction

The UnbelievaBoat API library is an importable package to make using the UnbelievaBoat API easier to use within Go. Although updates may be few and far, all new features are added as they are released. As I talk to the developer of the bot, I am made aware of upcoming changes. PRs, bug reports and feature requests are welcome!

Version 1 (/v1) uses version 1 of the UnbelievaBoat API and should be imported as github.com/BaileyJM02/unb-api-go/v1, more on the install process here. This is allows for the second version of the api to be installed as github.com/BaileyJM02/unb-api-go/v2 etc. upon release.

This may change as Go Module support will soon be implemented.

Features

A few of the things you can do with unb-api-go:

• Connect to the UnbelievaBoat API
• See user balance
• See guild leaderboard
• Set custom http.Client
• And more...

Feedback

Feel free to send me feedback on Twitter or, preferably, file an issue. Feature requests are always welcome. If you wish to contribute, please take a quick look at the guidelines!

If there's anything you'd like to chat about, please feel free to join our Discord Server and mention me: @Bailey#0004!

Install Process

I'm guessing you already have an environment setup.

1. Install the project.
   • $ go get github.com/BaileyJM02/unb-api-go/v1 to install the wrapper using version one.
2. Create a new instance to use the library.
   • ( token is your token found here)

import(
	"github.com/BaileyJM02/unb-api-go/v1"
)

function main() {
	// assign and create a new instance to api.
	api := v1.New(token);
}

3. Use functions like so: api.GetBalance(guildID, userID) . Where guildID and userID are representatives of their Discord values.

Acknowledgments

Thank you to all of the contributors who have added and improved the project!