Skip to content
This repository has been archived by the owner on Dec 24, 2023. It is now read-only.

Commit

Permalink
Updated readme.md, removed buttons on /help
Browse files Browse the repository at this point in the history
  • Loading branch information
XnonXte committed Jun 27, 2023
1 parent 3fbfa2a commit a99a035
Show file tree
Hide file tree
Showing 4 changed files with 64 additions and 78 deletions.
63 changes: 8 additions & 55 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
# PortalGuessr

PortalGuessr is a Discord bot that challenges you to guess a Portal chamber from a random picture taken from various locations, similar to GeoGuessr. Written in Python with discord.py library.
PortalGuessr is a discord bot that challenges you to guess a Portal chamber from a random picture taken from various locations, similar to GeoGuessr, thus the name PortalGuessr. Written in Python with [discord.py](https://github.com/Rapptz/discord.py) library.

| [INVITE LINK](https://discord.com/api/oauth2/authorize?client_id=1117773586522968105&permissions=2147601472&scope=bot%20applications.commands) |
|:---------------------------------------------------------------------------------------------------------------------------------------------:|

## Contributions

We welcome contributions to enhance the data sets used by the bot. If you would like to contribute, please join our [Discord server](https://discord.gg/hHYfnqa6zS).

## Self-hosting the bot

Hosting the bot is straightforward. Simply modify the token argument inside the `bot.run()` function and launch `launch.bat` for an easy startup. You can download the release version if available.
If you'd like to host the bot for yourself, you oculd do so by modifying the token argument inside the `bot.run()` function and launch `launch.bat` for an easy startup. You can download the release version if available.

### Requirements

Expand All @@ -18,57 +21,7 @@ The requirements.txt should contain the required libraries that your IDE will de
pip install -r requirements.txt
```

## Changelogs

- v0.4-beta:

- Renamed a few commands, mainly reverting statistics to leaderboard.
- major rework to /guess, mainly how the bot would send the message and response to the user.
- Added the correct answer to the timeout message due to recent demand for it.

- v0.4-beta-Unstable-Version:

- Overhauled commands into using cogs for ease of development.
- Added the /upload command to upload an image directly to the bot.
- Reworked config commands; added /clear_stats.
- Several QoL changes and bug fixes.
- added a lot of emojis.
- Revamped /help message.
- Added ;sync to sync slash commands into the tree.

- v0.3.1-beta:

- Added activity status.
- Renamed much of leaderboard to statistics.
- Statistics (previously leaderboard) are now available for every server and they're separate from each other.
- Removes admin.py in components and instead relies on app_commands.checks.has_permission() for permissions check.

- v0.3-beta:

- Rewritten using Rapptz's discord.py; this will make future development easier.
- Same as v0.2.2.1-beta feature-wise except for several QoL improvements and some slight renaming.

- v0.2.2-beta:

- Fixed the issues with several admin commands not working properly.
- Fixed the issue with the leaderboard not being able to display usernames and scores as intended.
- Removed /upload since it prompts some hurdles that I don't want to fix at the moment.
- The bot is now using discord.ext.commands instead of discord.ext.bridge for a temporary fix to hybrid commands that cannot pass arguments into options.

- v0.2.1-beta-Unstable-Build:

- Added several new features, including admin commands.
- Fixed the issue with how the bot listens to responses in /guess.
- Added /leaderboard command.
- Restructured PGComponents into smaller components for ease of use.

- v0.2-beta:

- Added easy, medium, and hard difficulty levels for /guess.
- Introduced /ping command to check the bot's latency.
- Implemented several quality-of-life improvements.
- Added the /bridge command.

- v0.1-beta:
## Acknowledgement

- Initial commit, representing the most basic version of this bot.
- Everyone in ITB for beta-testing the bot.
- Rapptz for creating discord.py
54 changes: 54 additions & 0 deletions changelogs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Changelogs

- v0.4-beta:

- Renamed a few commands, mainly reverting statistics to leaderboard.
- major rework to /guess, mainly how the bot would send the message and response to the user.
- Added the correct answer to the timeout message due to recent demand for it.

- v0.4-beta-Unstable-Version:

- Overhauled commands into using cogs for ease of development.
- Added the /upload command to upload an image directly to the bot.
- Reworked config commands; added /clear_stats.
- Several QoL changes and bug fixes.
- added a lot of emojis.
- Revamped /help message.
- Added ;sync to sync slash commands into the tree.

- v0.3.1-beta:

- Added activity status.
- Renamed much of leaderboard to statistics.
- Statistics (previously leaderboard) are now available for every server and they're separate from each other.
- Removes admin.py in components and instead relies on app_commands.checks.has_permission() for permissions check.

- v0.3-beta:

- Rewritten using Rapptz's discord.py; this will make future development easier.
- Same as v0.2.2.1-beta feature-wise except for several QoL improvements and some slight renaming.

- v0.2.2-beta:

- Fixed the issues with several admin commands not working properly.
- Fixed the issue with the leaderboard not being able to display usernames and scores as intended.
- Removed /upload since it prompts some hurdles that I don't want to fix at the moment.
- The bot is now using discord.ext.commands instead of discord.ext.bridge for a temporary fix to hybrid commands that cannot pass arguments into options.

- v0.2.1-beta-Unstable-Build:

- Added several new features, including admin commands.
- Fixed the issue with how the bot listens to responses in /guess.
- Added /leaderboard command.
- Restructured PGComponents into smaller components for ease of use.

- v0.2-beta:

- Added easy, medium, and hard difficulty levels for /guess.
- Introduced /ping command to check the bot's latency.
- Implemented several quality-of-life improvements.
- Added the /bridge command.

- v0.1-beta:

- Initial commit, representing the most basic version of this bot.
5 changes: 2 additions & 3 deletions cogs/utility.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
import discord
from discord import app_commands
from discord.ext import commands
from components import buttons, const
from components import const


class Utility(commands.Cog):
Expand All @@ -26,7 +26,7 @@ async def ping(self, interaction: discord.Interaction):
async def help(self, interaction: discord.Interaction):
help_message_embed = discord.Embed(
title="About PortalGuessr",
description="PortalGuessr is a bot that challenges you to guess a Portal chamber from a random picture taken from various locations, similar to GeoGuessr, thus the name PortalGuessr.\n\nIntrested on contributing? Join our discord server: [invite link](https://discord.gg/hHYfnqa6zS).",
description="PortalGuessr is a bot that challenges you to guess a Portal chamber from a random picture taken from various locations, similar to GeoGuessr, thus the name PortalGuessr.\n\nIntrested on contributing? Join our [discord server](https://discord.gg/hHYfnqa6zS).",
color=const.BOT_COLOR,
url="https://github.com/XnonXte/PortalGuessr",
)
Expand All @@ -42,7 +42,6 @@ async def help(self, interaction: discord.Interaction):
await interaction.response.send_message(
file=discord.File("logo.jpg", filename="logo.jpg"),
embed=help_message_embed,
view=buttons.HelpButtons(),
)


Expand Down
20 changes: 0 additions & 20 deletions components/buttons.py

This file was deleted.

0 comments on commit a99a035

Please sign in to comment.