https://github.com/boshyxd/templebot
TempleBot is a simple Discord bot that provides information about Terry Davis, the creator of TempleOS, and his unique operating system, TempleOS. This bot aims to educate and inspire users about Terry Davis's remarkable journey, his accomplishments, and the fascinating world of TempleOS.
https://github.com/boshyxd/templebot
beginner-friendly contribution contributions-welcome discord discord-bot discord-py first-issue great-first-issues help-wanted json python
Last synced: 5 months ago
JSON representation
TempleBot is a simple Discord bot that provides information about Terry Davis, the creator of TempleOS, and his unique operating system, TempleOS. This bot aims to educate and inspire users about Terry Davis's remarkable journey, his accomplishments, and the fascinating world of TempleOS.
- Host: GitHub
- URL: https://github.com/boshyxd/templebot
- Owner: boshyxd
- Created: 2024-03-27T09:44:47.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-26T02:48:08.000Z (almost 2 years ago)
- Last Synced: 2025-04-15T03:39:39.479Z (about 1 year ago)
- Topics: beginner-friendly, contribution, contributions-welcome, discord, discord-bot, discord-py, first-issue, great-first-issues, help-wanted, json, python
- Language: Python
- Homepage: https://discord.com/oauth2/authorize?client_id=1222510257503473717&permissions=8&scope=bot
- Size: 13.7 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
TempleBot
A Discord bot dedicated to Terry Davis and TempleOS.
TempleBot is a simple python Discord bot that provides useful information about [Terry Davis](https://en.wikipedia.org/wiki/Terry_A._Davis), the creator of [TempleOS](https://en.wikipedia.org/wiki/TempleOS), and his unique operating system, TempleOS. This bot aims to educate and inspire users about Terry Davis's remarkable journey, his accomplishments, and the fascinating world of TempleOS.
## Purpose
- Display biographical information about Terry Davis
- Explain the purpose, features, and creation of TempleOS
- Share interesting facts and quotes related to Terry Davis and TempleOS
- Provide links to relevant resources and documentation
## Setup
### Prerequisites
- Python 3.6 or higher
- `discord.py` library
### Installation
1. Clone the repo:
```bash
git clone https://github.com/your-username/TempleBot.git
```
2. Install the required dependencies:
```bash
cd TempleBot
pip install -r requirements.txt
```
3. Create a new Discord bot and obtain its token from the Discord Developer Portal.
4. Set the bot token as an environment variable named ``DISCORD_BOT_TOKEN``.
5. Run the bot:
```bash
python main.py
```
## Usage
Once the bot is running, you can interact with it using the following commands:
- `!terry`: Get biographical information about Terry Davis.
- `!templeos`: Learn about the TempleOS operating system.
- `!fact`: Receive an interesting fact or quote about Terry Davis or TempleOS.
- `!gif`: Receive a random Terry Davis or TempleOS related GIF, some GIFs are more rare to occur than others.
- `!resources`: Get links to relevant resources and documentation.
- `!colors`: Display the 16-color palette used in TempleOS with color names and hex codes.
## Contributing
> [!NOTE]
> Contributions are welcome! If you find any issues or want to add new features, feel free to open an issue or submit a pull request.
Here's how you can contribute:
1. Fork the repository
2. Create a new branch:
```bash
git checkout -b my-new-feature
```
3. Make your changes and then add them:
```bash
git add --all
```
4. Make your changes and commit them:
```bash
git commit -am 'Add some feature'
```
5. Push to the branch:
```bash
git push origin my-new-feature
```
5. Submit a pull request
## JSON File Structure
The bot uses JSON files to store quotes and GIFs. Here's an explanation of the structure:
### Quotes
The ``quotes.json`` file contains an array of ``quotes``. Each quote is a ``string``. Here's an example:
```json
{
"quotes": [
"This is a quote!"
]
}
```
> [!IMPORTANT]
> To add a new quote, simply append it to the ``quotes`` array.
### GIFs
The ``gifs.json`` file contains an array of GIF objects. Each object has two properties: ``url`` (the URL of the GIF) and ``probability`` (an integer representing the probability of displaying the GIF). Here's an example:
```json
{
"gifs": [
{
"url": "https://example.com/gif1.gif",
"probability": 90
},
{
"url": "https://example.com/gif2.gif",
"probability": 90
},
{
"url": "https://example.com/gif3.gif",
"probability": 15
}
]
}
```
> [!IMPORTANT]
> To add a new GIF, append a new object to the ``gifs`` array with the appropriate ``url`` and ``probability`` values.
## License
This project is licensed under the [MIT License](LICENSE).
## Acknowledgments
- [Terry Davis](https://en.wikipedia.org/wiki/Terry_A._Davis) for his remarkable work on TempleOS.
- The Discord.py library and its contributors for providing a powerful Python API for building Discord bots.
## Show Your Support
If you find this project valuable, please consider giving it a ⭐️ on GitHub!