Repository navigation
Revival v1: maintenance baseline #1
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| name: Quality | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| - "revival/**" | ||
| pull_request: | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| quality: | ||
| name: Python ${{ matrix.python-version }} | ||
| runs-on: ubuntu-latest | ||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| python-version: ["3.10", "3.11", "3.12"] | ||
|
|
||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Set up Python | ||
| uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: ${{ matrix.python-version }} | ||
| cache: pip | ||
|
|
||
| - name: Upgrade packaging tools | ||
| run: python -m pip install --upgrade pip setuptools wheel | ||
|
|
||
| - name: Install dependencies | ||
| run: python -m pip install -r requirements.txt | ||
|
|
||
| - name: Verify dependency graph | ||
| run: python -m pip check | ||
|
|
||
| - name: Compile Python sources | ||
| run: python -m compileall -q bot.py main.py cogs core cytechlink utils web | ||
|
|
||
| security-audit: | ||
| name: Dependency audit | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Set up Python | ||
| uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: "3.12" | ||
| cache: pip | ||
|
|
||
| - name: Install audit tooling | ||
| run: python -m pip install --upgrade pip pip-audit | ||
|
|
||
| - name: Audit dependencies | ||
| run: python -m pip_audit -r requirements.txt --desc |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,116 +1,136 @@ | ||
| # CytechMusic | ||
|
|
||
| Open-source Discord music bot powered by `discord.py`, Lavalink, MongoDB, and the bundled CytechLink audio client. | ||
|
|
||
| > [!IMPORTANT] | ||
| > **Project status: Revived / Maintenance Mode** | ||
| > | ||
| > CytechMusic has been reopened to keep the public release installable, compatible, secure, and maintainable. The revival focuses on bug fixes, dependency updates, code quality, documentation, and compatibility patches. Major new features are not planned here. | ||
| > | ||
| > **Cyori remains the active next-generation project.** CytechMusic is the public community edition and maintenance line. | ||
|
|
||
| [](https://github.com/Cytech-Team/CytechMusic/actions/workflows/quality.yml) | ||
| [](LICENSE) | ||
| [](https://www.python.org/) | ||
|
|
||
| ## Revival goals | ||
|
|
||
| - Keep the existing feature set working on supported Python and Discord/Lavalink stacks. | ||
| - Patch bugs, compatibility problems, and security issues. | ||
| - Clean technical debt where it can be done without changing expected behaviour. | ||
| - Improve automated checks and documentation. | ||
| - Keep self-hosting straightforward. | ||
| - Avoid feature creep and large rewrites; new product development belongs in Cyori. | ||
|
|
||
| ## Features | ||
|
|
||
| ### Music playback | ||
| - Lavalink-backed playback. | ||
| - YouTube, Spotify, SoundCloud, and other sources supported by the configured Lavalink node. | ||
| - Play, pause, skip, stop, seek, volume, loop, shuffle, and queue controls. | ||
| - Queue pagination, removal, and ordering tools. | ||
|
|
||
| ### Audio filters | ||
| - Nightcore, Vaporwave, and 8D presets. | ||
| - Speed, karaoke, tremolo, vibrato, rotation, distortion, low-pass, and channel-mix controls. | ||
|
|
||
| ### Server controls | ||
| - English and Thai language support. | ||
| - DJ role and DJ mode. | ||
| - Vote-gated features. | ||
| - 24/7 mode and autoplay. | ||
| - Dedicated music channel/controller setup. | ||
|
|
||
| ### Dashboard and utilities | ||
| - Embedded web dashboard/API. | ||
| - Uptime, CPU/RAM, latency, and Lavalink status information. | ||
| - Dynamic help and bot information commands. | ||
|
|
||
| ## Requirements | ||
|
|
||
| - Python 3.10+ | ||
| - MongoDB | ||
| - Lavalink v3 or v4 compatible with the bundled CytechLink implementation | ||
| - FFmpeg where required by your deployment | ||
|
|
||
| ## Installation | ||
|
|
||
| ```bash | ||
| git clone https://github.com/Cytech-Team/CytechMusic.git | ||
| cd CytechMusic | ||
| python -m venv .venv | ||
| ``` | ||
|
|
||
| Activate the virtual environment and install dependencies: | ||
|
|
||
| ```bash | ||
| python -m pip install --upgrade pip | ||
| python -m pip install -r requirements.txt | ||
| ``` | ||
|
|
||
| Copy the environment template: | ||
|
|
||
| ```bash | ||
| cp .env.example .env | ||
| ``` | ||
|
|
||
| Fill in at minimum your Discord bot token, MongoDB connection, and Lavalink connection details, then start the bot: | ||
|
There was a problem hiding this comment.
When a new operator follows this instruction literally and replaces only the token, MongoDB, and Lavalink values, Useful? React with 👍 / 👎. |
||
|
|
||
| ```bash | ||
| python main.py | ||
| ``` | ||
|
|
||
| > [!CAUTION] | ||
| > Never commit `.env`, bot tokens, API keys, database credentials, or webhook secrets. The provided `.gitignore` excludes common local environment files. | ||
|
|
||
| ## Configuration | ||
|
|
||
| The complete public configuration template is in [`.env.example`](.env.example). Optional integrations such as Spotify, Top.gg, Stripe, remote logging, and cross-server role synchronisation can be left unset when unused. | ||
|
|
||
| For cross-server role synchronisation, configure `SOURCE_GUILD_ID` and `SYNC_ROLE_ID` only if you intentionally use that feature. The public template leaves both disabled by default. | ||
|
|
||
| ## Tech stack | ||
|
|
||
| - `discord.py` | ||
| - MongoDB / Motor / PyMongo | ||
| - Lavalink + bundled CytechLink | ||
| - `aiohttp` web API/dashboard | ||
| - Optional Stripe, Spotify, Top.gg, and lyrics integrations | ||
|
|
||
| ## Commands | ||
|
|
||
| | Command | Description | | ||
| | --- | --- | | ||
| | `/play [query]` | Play a song or playlist from a URL or search. | | ||
| | `/stop` | Stop playback and clear the queue. | | ||
| | `/skip` | Skip the current song. | | ||
| | `/pause` | Pause or resume playback. | | ||
| | `/volume [1-200]` | Adjust playback volume. | | ||
|
There was a problem hiding this comment.
The revised command table advertises the full Useful? React with 👍 / 👎. |
||
| | `/queue` | Show the current queue. | | ||
| | `/loop` | Toggle track/queue looping. | | ||
| | `/seek [time]` | Seek to a timestamp such as `1:30`. | | ||
| | `/nowplaying` | Show current track information and controls. | | ||
|
|
||
| ## Maintenance policy | ||
|
|
||
| Accepted changes are primarily: | ||
|
|
||
| - bug fixes; | ||
| - compatibility patches; | ||
| - dependency/security updates; | ||
| - reliability and performance fixes; | ||
| - tests, CI, documentation, and safe refactors. | ||
|
|
||
| Large new features should target Cyori instead of expanding CytechMusic's scope again. | ||
|
|
||
| ## Contributing | ||
|
|
||
| Pull requests are welcome. Please keep changes focused and preserve existing behaviour unless the change fixes a documented bug or compatibility issue. | ||
|
|
||
| ## License | ||
|
|
||
| Distributed under the [MIT License](LICENSE). | ||
|
|
||
| --- | ||
|
|
||
| Developed and maintained by **Cytech Team Development**. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When Stripe is enabled with the copied template, successful and cancelled checkouts redirect to
/successand/premium, butDashboardSystem.setup_routesonly defines extensionless routes for/dashboardand/invite; the corresponding payment files are exposed by the static router as/success.htmland/premium.html. Both configured checkout destinations therefore return 404 unless an external proxy happens to rewrite them, so these defaults should use the actual.htmlpaths or the server should register matching routes.Useful? React with 👍 / 👎.