Skip to content

Latest commit

 

History

History
74 lines (50 loc) · 3.53 KB

README.md

File metadata and controls

74 lines (50 loc) · 3.53 KB
Raw

Victreebot

The Victreebot Discord bot, a discord bot for Pokémon Go communities.


Invite Victreebot bot

This bot is available for invite using the following invite link:

https://discord.com/api/oauth2/authorize?client_id=927258608234811394&permissions=1506728470775&scope=bot%20applications.commands

There is also an support server available for you to join and ask questions, give feedback or just hang-out!

https://discord.gg/sVmMUXCYp2



Using Victreebot

Victreebot utilizes Discords Slash Commands only! To use these comands, just type / and Discord will automatically prompt you with some commands (Hint: only typing / allows you to explore all slash commands (from all bots) available in the server)

Victreebot has the following commands available for you to use:

  • /info > Get information about the bots settings and some server stats!
  • /trade > Let other people now you are looking to trade a pokémon (Supports proposing a trade, Offering a Pokémon to trade or searching for a specified pokémon)1
  • /locations > Add/Delete/Edit a Gym or Pokéstop, get a list of all Gyms or Pokéstops or get information about a specific Gym or Pokéstop
  • /pokedex > Get information about a specific Pokémon
  • /profile {edit/view} > Edit your profile (Your Friend code(s) and active location(s)) or view some elses profile
  • /raid {create/edit/delete} > Create/Edit/Delete a raid
  • /reset > Reset Victreebot to the default values (This only resets the emoji's, roles and channels (logs and raids), this does NOT reset Victreebot settings!)2
  • /setup > Setup Victreebot with the default emoji's, roles and channels2
  • /settings update {general/raid/logging} > Update Victreebot's settings2


Submitting issues for Victreebot

If you encounter any issues, you have some feature requests or have ideas to improve the bot, please let me know! There are two simple ways of getting in contact:

  • Join the Support server and chat with me!
  • Submit an issue on this repository!


Developing Victreebot

Victreebot uses Semantic Versioning. All changes will be placed in the CHANGELOG.md file
If you want to help the development of Victreebot, there are a few steps involved:

  • Read the CONTRIBUTING.md guidelines of Victreebot
  • Fork the repository. In the repository, make a virtual environment (python -m venv .venv) and enter it (source .venv/bin/activate on Linux, or for Windows use one of .venv\Scripts\activate.ps1, .venv\Scripts\activate.bat, source .venv/Scripts/activate).
  • Install dependencies using pip install -r requirements.txt

After finishing the feature, bugfix or other task, create a merge request and wait!



LICENSE

This code is developed under the MIT License. The license can be found here: LICENSE



Footnotes

  1. This is NOT a trading system! This sends an embed with some details so other server members can see the trade in the server! ↩

  2. This command can only be executed by users who have the Manage Server permissions! ↩ ↩2 ↩3