v6d3music/docs/source/usage.rst
2023-05-28 21:53:54 +00:00

61 lines
1.1 KiB
ReStructuredText

For Users
=========
:code:`?/play` command
----------------------
command syntax::
?/play url [- effects | + preset] [[[h] m] s] [ignore]* ...
examples::
?/play http://127.0.0.1/audio.mp3 + bassboost
?/play http://127.0.0.1/audio.mp3 - "bass=g=10" 23 59 59 ignore
?/play http://127.0.0.1/audio.mp3 http://127.0.0.1/audio.mp3
:code:`?/skip` command
----------------------
command syntax::
?/skip
?/skip at
?/skip start end
examples::
?/skip
?/skip 0
?/skip 0 0
:code:`?/queue` commands
------------------------
command syntax::
?/queue resume
?/queue pause
?/queue [limit]
?/queue tail limit
User data we store
==================
Audio URLs, effects, user IDs
-----------------------------
Those are required for bot's functionality.
This data is stored only for the tracks that are currently in queue.
Audio contents
--------------
Persistent storage of audio is performed only for caching.
URLs aren't stored in a reversible form (only represented as hashes).
Tokens (for the web app)
------------------------
Revokable as any other Discord app token.