Update README.md
All checks were successful
CI/CD Pipeline / Unit Tests (Python 3.10) (push) Successful in 22s
CI/CD Pipeline / Unit Tests (Python 3.11) (push) Successful in 22s
CI/CD Pipeline / Unit Tests (Python 3.9) (push) Successful in 22s
CI/CD Pipeline / Security Scanning (push) Successful in 19s
CI/CD Pipeline / Integration Tests (push) Successful in 16s
CI/CD Pipeline / Code Quality & Linting (push) Successful in 44s
CI/CD Pipeline / Generate Test Report (push) Successful in 4s
CI/CD Pipeline / Build Docker Image (push) Successful in 37s
CI/CD Pipeline / CI/CD Pipeline Status (push) Successful in 2s
All checks were successful
CI/CD Pipeline / Unit Tests (Python 3.10) (push) Successful in 22s
CI/CD Pipeline / Unit Tests (Python 3.11) (push) Successful in 22s
CI/CD Pipeline / Unit Tests (Python 3.9) (push) Successful in 22s
CI/CD Pipeline / Security Scanning (push) Successful in 19s
CI/CD Pipeline / Integration Tests (push) Successful in 16s
CI/CD Pipeline / Code Quality & Linting (push) Successful in 44s
CI/CD Pipeline / Generate Test Report (push) Successful in 4s
CI/CD Pipeline / Build Docker Image (push) Successful in 37s
CI/CD Pipeline / CI/CD Pipeline Status (push) Successful in 2s
Simplifying main README in preparation for full wiki documentation of project
This commit is contained in:
61
README.md
61
README.md
@@ -6,7 +6,6 @@ A feature-rich Discord bot for monitoring and managing Pterodactyl game servers
|
||||
|
||||
## Table of Contents
|
||||
- [Features](#features)
|
||||
- [Architecture Overview](#architecture-overview)
|
||||
- [Installation](#installation)
|
||||
- [Traditional Installation](#traditional-installation)
|
||||
- [Docker Installation](#docker-installation)
|
||||
@@ -20,8 +19,6 @@ A feature-rich Discord bot for monitoring and managing Pterodactyl game servers
|
||||
- [Permissions](#permissions)
|
||||
- [Logging System](#logging-system)
|
||||
- [Troubleshooting](#troubleshooting)
|
||||
- [Development](#development)
|
||||
- [Contributing](#contributing)
|
||||
- [License](#license)
|
||||
|
||||
## Features
|
||||
@@ -47,18 +44,6 @@ A feature-rich Discord bot for monitoring and managing Pterodactyl game servers
|
||||
- **Error Handling**: Comprehensive error recovery and logging
|
||||
- **Rate Limit Protection**: Built-in delays between API calls
|
||||
|
||||
## Architecture Overview
|
||||
|
||||
The bot is built with several key components:
|
||||
|
||||
1. **PterodactylAPI Class**: Handles all communication with the Pterodactyl Panel API
|
||||
2. **ServerStatusView Class**: Manages the interactive Discord UI with control buttons
|
||||
3. **PterodactylBot Class**: Main bot class that orchestrates all operations
|
||||
4. **Background Task**: Regularly checks server status and updates embeds when needed
|
||||
5. **Configuration System**: Validates and manages all settings from config.ini
|
||||
|
||||
The system uses aiohttp for asynchronous HTTP requests and discord.py for Discord interactions.
|
||||
|
||||
## Installation
|
||||
|
||||
### Prerequisites
|
||||
@@ -269,52 +254,6 @@ For real-time log monitoring:
|
||||
tail -f pterodactyl_bot.log
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
### Requirements
|
||||
- Python 3.8+
|
||||
- Poetry (recommended) or pip
|
||||
|
||||
### Setup
|
||||
1. Clone the repository
|
||||
2. Install dependencies:
|
||||
```bash
|
||||
poetry install
|
||||
```
|
||||
or
|
||||
```bash
|
||||
pip install -r requirements.txt -r requirements-dev.txt
|
||||
```
|
||||
|
||||
3. Create a `.env` file with your development environment variables
|
||||
|
||||
4. Run in development mode:
|
||||
```bash
|
||||
python pterodisbot.py
|
||||
```
|
||||
|
||||
### Testing
|
||||
The project includes unit tests (to be expanded). Run with:
|
||||
```bash
|
||||
pytest
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions are welcome! Please follow these guidelines:
|
||||
|
||||
1. Fork the repository
|
||||
2. Create a feature branch (`git checkout -b feature/your-feature`)
|
||||
3. Commit your changes (`git commit -am 'Add some feature'`)
|
||||
4. Push to the branch (`git push origin feature/your-feature`)
|
||||
5. Open a pull request
|
||||
|
||||
### Coding Standards
|
||||
- Follow PEP 8 style guidelines
|
||||
- Include type hints for all function signatures
|
||||
- Document public methods with docstrings
|
||||
- Write tests for new functionality
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the GPL-3.0 License - see the [LICENSE](LICENSE) file for details.
|
||||
|
||||
Reference in New Issue
Block a user