From 6e46dfa28b7838d256c75faad8ab76ab96cf5cba Mon Sep 17 00:00:00 2001
From: Ryno0224 <125075864+Ryno0224@users.noreply.github.com>
Date: Thu, 22 Aug 2024 21:56:07 +0800
Subject: [PATCH] Updated en-us readme and bot translations (#164)
* Update en_US.json
display.lyrics.not_found: made it more natural and clear that no lyrics is available for that song
plus few minor changes
* Update README.en-us.md
updated English readme since idk how long ago I last committed lmao
---
README.en-us.md | 144 ++++++++++++++++++++++++++++++++++++++++------
locale/en_US.json | 12 ++--
2 files changed, 131 insertions(+), 25 deletions(-)
diff --git a/README.en-us.md b/README.en-us.md
index c7072c9b..eb3bcbed 100644
--- a/README.en-us.md
+++ b/README.en-us.md
@@ -52,9 +52,11 @@
Requirements
- How to use
+ Usage
+ Configs
ToDo
License
+ Contributing
@@ -72,19 +74,78 @@
If you just want to experiment what the bot is like, you can join [Yeecord(Chinese)][yeecord] and use `Lava#8364` there
-Or
+### One click setup
-You can [click here][LavaLauncher] to get the instructions on how to setup **Lavalink** and **Discord bot**
+You can use this one click script [LavaLauncher][LavaLauncher], and follow the steps to setup Lavalink and the Discord bot
+### Docker
-### Spotify Support
+
+Docker compose
+
+Make sure that Docker is installed on your computer or server already then:
+
+1. Clone this Repository
+```bash
+git clone https://github.com/Nat1anWasTaken/Lava.git
+```
+
+2. cd to project directory
+```bash
+cd Lava
+```
+
+3. Rename `example.stack.env` to `stack.env`
+```bash
+mv example.stack.env stack.env
+```
+Fill out `stack.env`
+
+4. Launch
+```bash
+docker compose up
+```
+
-To use `Spotify` and `Autoplay` support, you need to fill in those ecorresponding environment variable explained aboved at step one.
+
+Docker CLI
+
+Make sure that Docker is installed on your computer or server already then:
+
+1. Pull the image
+```bash
+docker pull ghcr.io/nat1anwastaken/lava:latest
+```
+
+2. Setup Lavalink, then fill IP and Port into `configs/lavalink.json`, if you're lazy to setup Lavalink, please use Docker Compose instead
+```json
+{
+ "host": "Lavalink IP",
+ "port": "Lavalink Port"
+}
+```
+
+3. Create `stac.env` file, and fill in the following
+```env
+TOKEN=Bot Token
+SPOTIFY_CLIENT_ID=Spotify client id
+SPOTIFY_CLIENT_SECRET=Spotify client secret
+```
+
+4. Start to bot
+```bash
+docker run -it \
+ --name ghcr.io/nat1anwastaken/lava:latest \
+ --restart unless-stopped \
+ lava
+```
-### Requirements
-* [Python 3.10+][python]
+
-(Back to top)
+> If you need to skip Spotify auto setup (`Go to the following url: ...`), you can set `SKIP_SPOTIFY_SETUP` to `1`
+
+
+(back to top)
@@ -98,21 +159,57 @@ Every command usage is explained in command description, you can learn how to us
(Back to top)
+
+
+## Configs
+Lava provided a few simple customizble configs for you to custom your bot to your likings such as:
+
+### Progress bar
+You can modify `configs/icons.json` to set custom emoji for progress bar
+```json
+{
+ "empty": "⬛",
+ "progress": {
+ "start_point": "⬜",
+ "start_fill": "⬜",
+ "mid_point": "⬜",
+ "end_fill": "⬛",
+ "end_point": "⬛",
+ "end": "⬛"
+ },
+ "control": {
+ "rewind": "⏪",
+ "forward": "⏩",
+ "pause": "⏸️",
+ "resume": "▶️",
+ "stop": "⏹️",
+ "previous": "⏮️",
+ "next": "⏭️",
+ "shuffle": "🔀",
+ "repeat": "🔁",
+ "autoplay": "🔥"
+ }
+}
+```
+
+### Status
+You can modify `configs/activity.json` to set custom status
+```json
+{
+ "type": 0, // 0: Playing, 1: Streaming, 2: Listing, 3: Watching
+ "name": "Music", // Status text
+ "url": "" // Stream link (Only when using streaming staus)
+}
+```
+
+(Back to top)
+
+
## ToDo
-- [ ] Add more platform
- - [x] YouTube
- - [x] Spotify
- - [x] SoundCloud
- - [x] Bilibili
- - [x] YouTube-DL
- - [ ] Apple Music
- ...
-- [ ] Enhance stability
-
-If you find any issues, you're more then welcome to mention it in [Issues][issues]
+ToDo has been moved to [Projects][projects]
(Back to top)
@@ -125,6 +222,13 @@ This project is licensed under MIT License, check `LICENSE.txt` for more informa
(Back to top)
+
+
+## Contributing
+
+Head to [CONTRUBUTING.md](CONTRIBUTING.md) for detail
+
+
[contributors-shield]: https://img.shields.io/github/contributors/Nat1anWasTaken/Lava.svg?style=for-the-badge
@@ -155,6 +259,8 @@ This project is licensed under MIT License, check `LICENSE.txt` for more informa
[lavalink]: https://github.com/freyacodes/Lavalink
+[projects]: https://github.com/users/Nat1anWasTaken/projects/3
+
[LavaLauncher]: https://github.com/Nat1anWasTaken/LavaLauncher
[spotipy-authorization-flow]: https://spotipy.readthedocs.io/en/2.22.0/#authorization-code-flow
diff --git a/locale/en_US.json b/locale/en_US.json
index a5b05b0d..8cbcb74f 100644
--- a/locale/en_US.json
+++ b/locale/en_US.json
@@ -8,17 +8,17 @@
"command.info.embed.commit_hash": "Version Info",
"command.info.embed.cpu": "CPU",
"command.info.embed.ram": "RAM",
- "command.info.embed.guilds": "Number of Guilds",
- "command.info.embed.players": "Number of Players",
+ "command.info.embed.guilds": "Servers",
+ "command.info.embed.players": "Players",
"command.ping.name": "ping",
- "command.ping.description": "Check bot latency",
- "command.ping.title": "Bot Latency",
+ "command.ping.description": "Check bot's latency",
+ "command.ping.title": "Bot's Latency",
"command.nowplaying.name": "nowplaying",
"command.nowplaying.description": "Display current playing track",
"command.play.name": "play",
"command.play.description": "Play music",
"command.play.option.query": "Song name or URL, supports YouTube, YouTube Music, SoundCloud, Spotify",
- "command.play.option.index": "The queue index where track should be inserted to",
+ "command.play.option.index": "The position in queue where track should be inserted to",
"command.play.option.shuffle": "Whether to enable shuffle when playing",
"command.play.error.no_results.title": "No results found.:(",
"command.play.error.no_results.description": "If you want to search by keyword, please wait a few seconds after entering the keyword, and the search results will automatically display above",
@@ -126,7 +126,7 @@
"display.disable": "OFF",
"display.footer": "If you felt the quality of the music is kinda awful, maybe checking filters or switching region in voice channel setting will help",
"display.lyrics.title": "🎤 | Lyrics",
- "display.lyrics.not_found": "*You need to sing the lyrics of this song yourself*",
+ "display.lyrics.not_found": "Womp wmop can't found the lyrics for this song\n*Looks like you need to sing the lyrics of this song yourself*",
"display.lyrics.loading": "Loading lyrics...",
"display.control.pause": "Pause",
"display.control.resume": "Resume",