diff --git a/README.md b/README.md index cbee4a1..469cd80 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,71 @@ -# unstable-cogs +# Unstable Kitsune Red-DiscordBot Cogs created by KWUK +--- +This repository will serve as the main housing for any **KItsunic Works - Unstable Kitsune** Branded Red-DiscordBot Cogs! +As such if any issues occur, Please place a new issue within this repository's Issue Panel! +--- +## Requirements +- ## Red-DiscordBot Instance + +- Needed for Red-DiscordBot! + - ["Get your Bot & Token"](https://discord.com/developers/applications) +- How to install Red-DiscordBot + - ["Install Red-DiscordBot"](https://docs.discord.red/en/stable/install_guides/index.html) +--- + +## Repository Installation +``` +IMPORTANT NOTE: + You will need to use your bot's PREFIX in order to use a bot command. In this guide a bot's PREFIX is defined as `[p]`. +``` + +1. Be sure to have the downloader cog loaded! + - `[p]load downloader` + ``` + load downloader + ``` +2. Add the repository to the bot's data directory. Note: repository KWUK is placeholder & can be changed! + - `[p]repo add KWUK https://git.kitsunic.org/kitsunicWorks/unstable-cogs ` + ``` + repo add KWUK https://git.kitsunic.org/kitsunicWorks/unstable-cogs + ``` +3. Use the following command with the cog name from my repository list & attached at the end of the command. + - `[p]cog install KWUK COG_NAME` - be sure to replace COG_NAME with the cog you want to install! +``` +cog install KWUK +``` +4. Use the following command to load the cog! Otherwise it will not be actived/enabled. + - `[p]load COG_NAME`- be sure to replace COG_NAME with the cog you want to install! + --- +## Available Cogs + +### kBump: +- kBump will allow you to use your RDB to "bump" -or- "Advertise" your server on a [Disboard Clone](https://disboard.org)- WIP + +Currently there is no other cogs to list! Please check back in at a later date! +--- +## Contributing to my work. +If you have any ideas for a cog you would like, -or- If you have changes made to any cogs just Connect with me! I'd be happy to update my cogs! + +--- +## Translations +Currently all KWUK cogs will be in English only. If you would like to translate a cog, Feel free to do so! Just connect with me please! + +--- +## Cog Support +The [Wiki](https://git.kitsunic.org/kitsunicWorks/unstable-cogs/wiki) within this repository will house most +answers to general questions & issues with any KWUK cogs. If your issue is not listed, Please feel free to post an new [Issue](https://git.kitsunic.org/kitsunicWorks/unstable-cogs/issues), Ping me within Discord, Or even [DM](https://discord.com/users/1355344202304716810) or [Support Server](https://discord.kitsunic.org/invite/server/kitsunicWorks)! + +--- +## You can fund my projects! +As this is my main focus, All the support is welcomed & extremely appreicated! If you enjoy my cogs, Please consider donating via [Ko-Fi](https://ko-fi.com/unstablekitsune) -or- [Stripe Direct Payments](https://buy.stripe.com/14AeVcacV8z25uO8ir1ck00) + +--- +# Credits +- [Cog-Creators](https://github.com/Cog-Creators) +--- +## License +This repository and is cogs are protected under the GPU-3.0 License. +For Further information visit [GPC-30 License](https://git.kitsunic.org/kitsunicWorks/unstable-cogs/src/branch/main/LICENSE) + +Copyright (C) 2025-present kitsunicWorks unstable-cog \ No newline at end of file