testvoltricx 1.0.1__tar.gz

testvoltricx-1.0.1/.github/workflows/build_and_publish.yml

@@ -0,0 +1,93 @@
+name: Publish to PyPI
+run-name: Publishing to PyPI - ${{ github.ref_name }} by @${{ github.actor }}
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+  workflow_dispatch:
+
+jobs:
+  test:
+    name: Test on Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: 'pip'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .[dev]
+
+      - name: Run tests
+        run: pytest
+
+  build:
+    name: Build distribution
+    needs: [test]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - name: Install build tool
+        run: python -m pip install --upgrade build
+      - name: Build source and wheel
+        run: python -m build
+      - name: Store the distribution packages
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish-to-pypi:
+    name: Upload to PyPI
+    needs: [build]
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/testvoltricx
+    permissions:
+      id-token: write
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Publish distribution to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}
+          verbose: true
+
+  upload-to-github-release:
+    name: Upload to GitHub Release
+    needs: [build]
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/')
+    permissions:
+      contents: write
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Upload to GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*

testvoltricx-1.0.1/.github/workflows/deploy-docs.yml

@@ -0,0 +1,39 @@
+name: Deploy Docs
+run-name: Deploying docs - ${{ github.ref_name }} by @${{ github.actor }}
+
+on: 
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    name: Deploying Docs
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install mkdocs-material mkdocstrings[python] mike ruff mkdocs-minify-plugin
+          pip install -e .
+
+      - name: Configure Git
+        run: |
+          git config --global user.name "github-actions[bot]"
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+
+      - name: Deploy to GitHub Pages
+        run: |
+          mkdocs gh-deploy --config-file mkdocs.yml --force

testvoltricx-1.0.1/.github/workflows/sonar_Analysis.yml

@@ -0,0 +1,110 @@
+name: Sonar Analysis
+run-name: Sonar Analysis - ${{ github.ref_name }} by @${{ github.actor }}
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+    types: [opened, synchronize, reopened, labeled]
+    branches:
+      - main
+
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  build:
+    if: |
+      (github.event_name == 'push' && github.ref_name == 'main') ||
+      (github.event_name == 'pull_request' && (
+        contains(github.event.pull_request.labels.*.name, 'sonarcube') ||
+        contains(github.event.pull_request.labels.*.name, 'analyze&check')
+      )) ||
+      (github.event_name == 'workflow_dispatch')
+    name: Build and analyze
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install dependencies
+        run: |
+          pip install uv
+          uv pip install --system -e ".[dev]"
+      - name: Run tests with coverage
+        run: pytest --cov=voltricx --cov-report=xml --cov-report=term-missing
+      - uses: SonarSource/sonarqube-scan-action@v6
+        with:
+          args: >
+            -Dsonar.pullrequest.key=${{ github.event.pull_request.number }}
+            -Dsonar.pullrequest.branch=${{ github.head_ref }}
+            -Dsonar.pullrequest.base=${{ github.base_ref }}
+            -Dsonar.python.coverage.reportPaths=coverage.xml
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+          SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}
+      - name: SonarQube Quality Gate check
+        uses: sonarsource/sonarqube-quality-gate-action@v1
+        timeout-minutes: 5
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+          SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}
+
+      - name: Fetch and Generate SVG Badges
+        if: always()
+        run: |
+          # Fetch metrics from API
+          RESPONSE=$(curl -s -u "${{ secrets.SONAR_TOKEN }}:" "${{ secrets.SONAR_HOST_URL }}/api/measures/component?component=voltricx&metricKeys=coverage,alert_status,bugs,vulnerabilities,code_smells")
+
+          # Extract values
+          STATUS=$(echo "$RESPONSE" | jq -r '.component.measures[] | select(.metric=="alert_status") | .value' || echo "UNKNOWN")
+          COVERAGE=$(echo "$RESPONSE" | jq -r '.component.measures[] | select(.metric=="coverage") | .value' || echo "0")
+          BUGS=$(echo "$RESPONSE" | jq -r '.component.measures[] | select(.metric=="bugs") | .value' || echo "0")
+          VULN=$(echo "$RESPONSE" | jq -r '.component.measures[] | select(.metric=="vulnerabilities") | .value' || echo "0")
+          SMELLS=$(echo "$RESPONSE" | jq -r '.component.measures[] | select(.metric=="code_smells") | .value' || echo "0")
+
+          # Map status to color
+          [ "$STATUS" = "OK" ] && COLOR="brightgreen" || COLOR="red"
+
+          mkdir -p assets
+
+          # Generate SVGs via Shields.io static API and save locally
+          curl -s "https://img.shields.io/badge/quality%20gate-$STATUS-$COLOR?style=flat-square" > assets/quality_gate.svg
+          curl -s "https://img.shields.io/badge/coverage-$COVERAGE%25-brightgreen?style=flat-square" > assets/coverage.svg
+          curl -s "https://img.shields.io/badge/bugs-$BUGS-red?style=flat-square" > assets/bugs.svg
+          curl -s "https://img.shields.io/badge/vulnerabilities-$VULN-orange?style=flat-square" > assets/vulnerabilities.svg
+          curl -s "https://img.shields.io/badge/code%20smells-$SMELLS-yellow?style=flat-square" > assets/code_smells.svg
+
+          # Also keep the JSON for reference
+          echo "{\"status\": \"$STATUS\", \"coverage\": \"$COVERAGE\", \"bugs\": \"$BUGS\", \"vulnerabilities\": \"$VULN\", \"code_smells\": \"$SMELLS\", \"last_updated\": \"$(date -u +'%Y-%m-%dT%H:%M:%SZ')\"}" > assets/metrics.json
+
+      - name: Push Badges to shield-stats
+        if: always()
+        run: |
+          git config --global user.name "github-actions[bot]"
+          git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
+
+          # Clone the shield-stats branch into a separate directory to avoid messing with current source
+          git clone --branch shield-stats https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git shield_repo
+
+          # Copy only the badges we updated
+          mkdir -p shield_repo/assets
+          cp assets/*.svg shield_repo/assets/
+          cp assets/metrics.json shield_repo/assets/
+
+          cd shield_repo
+          git add assets/*.svg assets/metrics.json
+
+          if ! git diff --cached --quiet; then
+            git commit -m "docs: update stats badges [skip ci]"
+            git push origin shield-stats
+          fi

testvoltricx-1.0.1/.github/workflows/version_checks.yml

@@ -0,0 +1,50 @@
+name: Version Checks
+run-name: Py Version checks - ${{ github.ref_name }} by @${{ github.actor }}
+
+
+on:
+  push:
+    branches:
+      - main
+
+
+  pull_request:
+    types: [opened, synchronize, reopened, labeled]
+    branches:
+      - main
+
+  workflow_dispatch:
+
+
+jobs:
+  check:
+    if: |
+      (github.event_name == 'push' && github.ref_name == 'main') ||
+      (github.event_name == 'pull_request' && (
+        contains(github.event.pull_request.labels.*.name, 'versionchecks') ||
+        contains(github.event.pull_request.labels.*.name, 'analyze&check')
+      )) ||
+      (github.event_name == 'workflow_dispatch')
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          pip install uv
+          uv pip install --system -e ".[dev]"
+      - name: Ruff Check
+        run: ruff check .
+      - name: Ruff Format Check
+        run: ruff format --check .
+      - name: Pyright
+        run: pyright
+      - name: Run tests with coverage
+        run: pytest --cov

testvoltricx-1.0.1/.gitignore

@@ -0,0 +1,58 @@
+# System
+.DS_Store
+
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+.tox/
+.nox/
+
+# Environments
+env/
+venv/
+ENV/
+.env
+
+# Testing & Coverage
+.pytest_cache
+.ruff_cache
+.coverage
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis
+
+# Logs
+*.log
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# Project specific
+.gemini/
+Contexts/
+oldcode/
+clean_pycache.py
+site/

testvoltricx-1.0.1/.pre-commit-config.yaml

@@ -0,0 +1,35 @@
+# Pre-commit configuration for voltricx
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+        args: [ --unsafe ]
+    -   id: check-added-large-files
+
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.0
+    hooks:
+    -   id: ruff
+        args: [ --fix ]
+    -   id: ruff-format
+
+-   repo: local
+    hooks:
+    -   id: pyright
+        name: pyright
+        entry: pyright
+        language: system
+        types: [python]
+        pass_filenames: false
+    -   id: pytest
+        name: pytest
+        entry: pytest
+        language: system
+        types: [python]
+        pass_filenames: false
+        always_run: true

testvoltricx-1.0.1/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026-Present @JustNixx, @Dipendra-creator and RevvLabs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

testvoltricx-1.0.1/PKG-INFO

@@ -0,0 +1,206 @@
+Metadata-Version: 2.4
+Name: testvoltricx
+Version: 1.0.1
+Summary: A modern, simple, and powerful Lavalink wrapper for discord.py.
+Author: @JustNixx, @Dipendra-creator
+License: MIT
+Project-URL: Homepage, https://github.com/ded-lmfao/voltricx
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: discord.py>=2.0.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: aiohttp>=3.8.0
+Requires-Dist: yarl>=1.9.0
+Requires-Dist: python-dotenv>=1.0.0
+Provides-Extra: dev
+Requires-Dist: ruff>=0.3.0; extra == "dev"
+Requires-Dist: pyright>=1.1.300; extra == "dev"
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
+Dynamic: license-file
+
+<div align="center">
+  <img src="https://raw.githubusercontent.com/ded-lmfao/revvcore/refs/heads/main/assets/banner.svg" width="100%" alt="Voltricx Banner">
+  
+  <h3>The Next-Generation Lavalink Wrapper for Python</h3>
+
+  <p align="center">
+    <a href="https://pypi.org/project/voltricx/" style="text-decoration:none;"><img src="https://img.shields.io/badge/PyPI-v1.0.5-blue?style=for-the-badge&logo=pypi" alt="PyPI version"></a>
+    <a href="https://pypi.org/project/voltricx/" style="text-decoration:none;"><img src="https://img.shields.io/badge/python-3.12%2B-3776AB?style=for-the-badge&logo=python" alt="Python versions"></a>
+    <a href="LICENSE" style="text-decoration:none;"><img src="https://img.shields.io/badge/license-MIT-blue?style=for-the-badge" alt="License"></a>
+    <img src="https://img.shields.io/badge/Status-Stable-brightgreen?style=for-the-badge" alt="Status">
+  </p>
+
+  <p align="center">
+    <a href="https://lavalink.dev"><img src="https://img.shields.io/badge/Lavalink-v4.0%2B-FB7713?style=flat-square&logo=lavalink" alt="Lavalink version"></a>
+    <img src="https://img.shields.io/badge/Plugins-Native_Support-FB7713?style=flat-square" alt="Plugins Support">
+  </p>
+
+  <p align="center">
+    <a href="https://ded-lmfao.github.io/revvcore/"><img src="https://img.shields.io/github/actions/workflow/status/ded-lmfao/revvcore/deploy-docs.yml?branch=main&label=Docs&logo=readthedocs&style=flat-square" alt="Docs"></a>
+    <a href="https://github.com/ded-lmfao/revvcore/actions/workflows/version_checks.yml"><img src="https://img.shields.io/github/actions/workflow/status/ded-lmfao/revvcore/version_checks.yml?branch=main&label=Version%20Checks&logo=githubactions&style=flat-square" alt="Version Checks"></a>
+    <a href="https://github.com/ded-lmfao/revvcore/actions/workflows/version_checks.yml"><img src="https://img.shields.io/github/actions/workflow/status/ded-lmfao/revvcore/version_checks.yml?branch=main&label=Ruff&logo=ruff&style=flat-square" alt="Ruff Checks"></a>
+    <a href="https://github.com/ded-lmfao/revvcore/actions/workflows/version_checks.yml"><img src="https://img.shields.io/github/actions/workflow/status/ded-lmfao/revvcore/version_checks.yml?branch=main&label=Pyright&logo=python&style=flat-square" alt="Pyright"></a>
+    <a href="https://github.com/ded-lmfao/revvcore/actions/workflows/version_checks.yml"><img src="https://img.shields.io/github/actions/workflow/status/ded-lmfao/revvcore/version_checks.yml?branch=main&label=Pytest&logo=pytest&style=flat-square" alt="Pytest"></a>
+  </p>
+
+
+  <p align="center">
+    <a href="https://github.com/ded-lmfao/revvcore/actions/workflows/build_and_publish.yml"><img src="https://img.shields.io/github/actions/workflow/status/ded-lmfao/revvcore/build_and_publish.yml?label=Publish%20to%20PyPI&style=flat-square" alt="Publish to PyPI"></a>
+  </p>
+
+
+  <p align="center">
+    <img src="https://raw.githubusercontent.com/ded-lmfao/revvcore/shield-stats/assets/quality_gate.svg" alt="Quality Gate">
+    <img src="https://raw.githubusercontent.com/ded-lmfao/revvcore/shield-stats/assets/coverage.svg" alt="Coverage">
+    <img src="https://raw.githubusercontent.com/ded-lmfao/revvcore/shield-stats/assets/bugs.svg" alt="Bugs">
+    <img src="https://raw.githubusercontent.com/ded-lmfao/revvcore/shield-stats/assets/vulnerabilities.svg" alt="Vulnerabilities">
+    <img src="https://raw.githubusercontent.com/ded-lmfao/revvcore/shield-stats/assets/code_smells.svg" alt="Code Smells">
+  </p>
+</div>
+
+---
+
+**Voltricx** is a high-performance, feature-rich Lavalink wrapper built for modern Discord bot development in Python. Engineered for speed, reliability, and ease of use, Voltricx offers a professional-grade API that makes audio integration seamless and powerful.
+
+---
+
+## <img src="https://raw.githubusercontent.com/ded-lmfao/revvcore/refs/heads/main/assets/logo.svg" width="32" align="center" alt="Icon"> Table of Contents
+- [Why Voltricx?](#why-voltricx)
+- [Features](#features)
+- [Installation](#installation)
+- [Quickstart](#quickstart)
+- [Examples](#examples)
+- [Contributing](#contributing)
+- [License](#license)
+
+---
+
+### <img src="https://raw.githubusercontent.com/ded-lmfao/revvcore/refs/heads/main/assets/logo.svg" width="32" align="center" alt="Icon"> Why Voltricx?
+
+<table border="0">
+  <tr>
+    <td width="52" valign="middle"><img src="https://raw.githubusercontent.com/ded-lmfao/revvcore/refs/heads/main/assets/logo.svg" width="44" alt="Icon"></td>
+    <td valign="middle"><strong>Next-Gen Performance</strong>: Dual-tier caching (LRU/LFU) powered by <code>HyperCache</code> for lightning-fast data retrieval.</td>
+  </tr>
+  <tr>
+    <td width="52" valign="middle"><img src="https://raw.githubusercontent.com/ded-lmfao/revvcore/refs/heads/main/assets/logo.svg" width="44" alt="Icon"></td>
+    <td valign="middle"><strong>Strictly Typed</strong>: Comprehensive type hinting and Pydantic v2 validation ensure your code is robust and maintainable.</td>
+  </tr>
+  <tr>
+    <td width="52" valign="middle"><img src="https://raw.githubusercontent.com/ded-lmfao/revvcore/refs/heads/main/assets/logo.svg" width="44" alt="Icon"></td>
+    <td valign="middle"><strong>High-Fidelity Failover</strong>: Automated node shifting and silent reconnects ensure a seamless listening experience.</td>
+  </tr>
+  <tr>
+    <td width="52" valign="middle"><img src="https://raw.githubusercontent.com/ded-lmfao/revvcore/refs/heads/main/assets/logo.svg" width="44" alt="Icon"></td>
+    <td valign="middle"><strong>Modern Standards</strong>: Fully compatible with Lavalink v4.0+, including native support for the DAVE E2EE protocol and filters.</td>
+  </tr>
+  <tr>
+    <td width="52" valign="middle"><img src="https://raw.githubusercontent.com/ded-lmfao/revvcore/refs/heads/main/assets/logo.svg" width="44" alt="Icon"></td>
+    <td valign="middle"><strong>Smart Load Balancing</strong>: Advanced penalty-based node selection for optimal performance across multiple Lavalink nodes.</td>
+  </tr>
+</table>
+
+---
+
+### <img src="https://raw.githubusercontent.com/ded-lmfao/revvcore/refs/heads/main/assets/logo.svg" width="32" align="center" alt="Icon"> Features
+
+- 🚀 **Asynchronous Architecture**: Built from the ground up to be fully async and non-blocking.
+- 📡 **Websocket Management**: Efficient handling of Lavalink websocket connections with automatic retries.
+- 🎹 **Rich Audio Control**: Full support for filters including Equalizer, Timescale, Vibrato, and more.
+- 🌐 **DAVE Protocol**: Support for the latest Discord Audio Video Encryption standards.
+- ⚖️ **Regional Selection**: Intelligent node selection based on guild region and node latency.
+
+---
+
+### <img src="https://raw.githubusercontent.com/ded-lmfao/revvcore/refs/heads/main/assets/logo.svg" width="32" align="center" alt="Icon"> Installation
+
+Voltricx requires **Python 3.12+**.
+
+```bash
+# Stable version from PyPI
+pip install voltricx
+```
+
+For the latest development version:
+```bash
+pip install git+https://github.com/ded-lmfao/voltricx.git
+```
+
+---
+
+### <img src="https://raw.githubusercontent.com/ded-lmfao/revvcore/refs/heads/main/assets/logo.svg" width="32" align="center" alt="Icon"> Quickstart
+
+Here is a minimal example of how to get up and running with Voltricx.
+
+```python
+import discord
+from discord.ext import commands
+import voltricx
+
+class MyBot(commands.Bot):
+    def __init__(self):
+        super().__init__(command_prefix="!", intents=discord.Intents.all())
+
+    async def setup_hook(self):
+        # Configuration for your Lavalink Node
+        config = voltricx.NodeConfig(
+            uri="http://localhost:2333",
+            password="youshallnotpass",
+            identifier="MAIN-NODE"
+        )
+
+        # Initialize the Pool and add the node
+        node = voltricx.Node(config=config)
+        await voltricx.Pool.add_node(node)
+
+bot = MyBot()
+
+@bot.event
+async def on_voltricx_node_ready(node: voltricx.Node):
+    print(f"✅ Lavalink Node {node.identifier} is ready and connected!")
+
+@bot.command()
+async def play(ctx, *, query: str):
+    # Retrieve or create a player for the guild
+    player: voltricx.Player = ctx.voice_client or await ctx.author.voice.channel.connect(cls=voltricx.Player)
+
+    # Search for tracks
+    tracks = await voltricx.Pool.get_tracks(query)
+    if not tracks:
+        return await ctx.send("❌ No tracks found.")
+
+    track = tracks[0]
+    await player.play(track)
+    await ctx.send(f"🎶 **Now playing**: {track.title}")
+
+bot.run("YOUR_BOT_TOKEN")
+```
+
+---
+
+### <img src="https://raw.githubusercontent.com/ded-lmfao/revvcore/refs/heads/main/assets/logo.svg" width="32" align="center" alt="Icon"> Examples
+
+Check the [example](example/) directory for advanced usage, including:
+- [Basic Bot Implementation](example/main.py)
+- Custom Queue Handlers
+- Advanced Filters (Nightcore, etc.)
+
+---
+
+### <img src="https://raw.githubusercontent.com/ded-lmfao/revvcore/refs/heads/main/assets/logo.svg" width="32" align="center" alt="Icon"> Contributing
+
+We welcome contributions! If you'd like to help improve Voltricx:
+1. **Fork** the repository.
+2. **Clone** your fork and create a new feature branch (`git checkout -b feature/amazing-feature`).
+3. **Commit** your improvements (`git commit -m 'feat: add some amazing feature'`).
+4. **Push** the changes to your fork (`git push origin feature/amazing-feature`).
+5. **Open a Pull Request**.
+
+---
+
+### <img src="https://raw.githubusercontent.com/ded-lmfao/revvcore/refs/heads/main/assets/logo.svg" width="32" align="center" alt="Icon"> License
+
+Voltricx is released under the MIT License. See [LICENSE](LICENSE) for more information.