Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jilwer/vrcgo

Utility bot for VRChat
https://github.com/jilwer/vrcgo

bot discord go vrchat

Last synced: 2 months ago
JSON representation

Utility bot for VRChat

Awesome Lists containing this project

README

        

# VRCGO
VRCGO plans to be a full featured discord bot that wrap's the VRChat API

## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Features](#features)
- [Contributing](#contributing)
- [Thanks](#thanks)
- [License](#license)

## Getting Started
To get started with VRCGO, follow these steps:

### Installation
1. Clone the repository: `git clone https://github.com/Jilwer/vrcgo.git`
2. Install the required dependencies: `go mod tidy`
3. Build the Application `go build`

### Usage
1. Create a new Discord bot on the Discord Developer Portal.
2. Copy the bot token.
3. Rename the `config.example.toml` file to `.config.toml` and replace `YOUR_BOT_TOKEN` with your actual bot token.
4. Run the generated executable!

### Features
VRCGO Plans to be as robust as possible by trying to wrap as much of the VRCAPI as possible.
#### Finished
- Online Users
#### WIP
TODO

### Contributing
Contributions are welcome! If you have any ideas or improvements, feel free to open an issue or submit a pull request.

### Thanks
- Special thanks to the VRChat API Docs team for providing easy to access documentation on the VRChat API. https://vrchatapi.github.io/

### License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.