-
-
Notifications
You must be signed in to change notification settings - Fork 672
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update getting started, add faq & markdownextradata plugin
- Loading branch information
Showing
7 changed files
with
89 additions
and
33 deletions.
There are no files selected for viewing
This file contains 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 was deleted.
Oops, something went wrong.
This file contains 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,46 @@ | ||
--- | ||
description: Lavalink frequently asked questions. | ||
--- | ||
|
||
# FAQ | ||
|
||
## What is Lavalink? | ||
|
||
Lavalink is a standalone audio player node that is used to stream music to Discord voice servers. It is written in Java and is based on [lavaplayer](https://github.com/lavalink-devs/lavaplayer) and [koe](https://github.com/KyokoBot/koe). | ||
|
||
## What is Lavalink used for? | ||
|
||
Lavalink is used to stream music to Discord voice servers. It is used by many Discord music bots, including [FredBoat](https://fredboat.com) and many others. | ||
|
||
## How do I install Lavalink? | ||
|
||
See the [Getting Started](index.md) for instructions on how to install Lavalink. | ||
|
||
## How do I configure Lavalink? | ||
|
||
See the [Configuration](../configuration/index.md) page for instructions on how to configure Lavalink. | ||
|
||
## How do I connect to Lavalink? | ||
|
||
See the [Clients](../clients.md) page for a list of clients that can connect to Lavalink. Each client has its own instructions on how to connect to Lavalink. | ||
|
||
## How do I run Lavalink in the background? | ||
|
||
See the [Docker](../configuration/docker.md) or [Systemd](../configuration/systemd.md) configuration pages for instructions on how to run Lavalink in the background. | ||
|
||
## How do I update Lavalink? | ||
|
||
Updating Lavalink is as simple as downloading the latest `Lavalink.jar` from [GitHub](https://github.com/lavalink-devs/Lavalink/releases/latest) and replacing the old jar file with the new one. | ||
When using Docker, you can simply pull the latest image from [GitHub Container Registry](https://github.com/lavalink-devs/Lavalink/pkgs/container/lavalink). | ||
|
||
## How do I report a bug? | ||
|
||
Open an issue on the [issue tracker](https://github.com/lavalink-devs/Lavalink/issues/new?labels=bug&template=bug_report.md). | ||
|
||
## How do I get help? | ||
|
||
Join the [Lavalink support Discord]({{ discord_help }}) or open a [GitHub discussion](https://github.com/lavalink-devs/Lavalink/discussions/new?category=q-a). | ||
|
||
## How do I get support for a client? | ||
|
||
Open an issue on the client's GitHub repository or join the client's support Discord. The [Lavalink support Discord]({{ discord }}) also has a channel for each client where you can get support. |
This file contains 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,33 @@ | ||
--- | ||
description: Lavalink getting started guide. | ||
--- | ||
|
||
# Getting Started | ||
|
||
Welcome to the Lavalink Getting Started guide. If you're new to Lavalink, follow these steps to get started: | ||
|
||
1. Install Java 17 or higher. You can download it [here](https://www.azul.com/downloads/?package=jdk#zulu). | ||
2. Download the latest `Lavalink.jar` from [GitHub](https://github.com/lavalink-devs/Lavalink/releases/latest). | ||
3. Check out the [configuration](../configuration/index.md) page to learn how to configure Lavalink. | ||
4. Run Lavalink with `java -jar Lavalink.jar`. | ||
|
||
Now you can connect to Lavalink with your client. You can find a list of clients [here](../clients.md). | ||
|
||
If you want to run the Lavalink server without it closing when you close the terminal, you can see the [Docker](../configuration/docker.md) or [Systemd](../configuration/systemd.md) configuration pages. | ||
|
||
## Useful Links | ||
|
||
- [Features](https://github.com/lavalink-devs/Lavalink#features): Explore the rich feature set of Lavalink. | ||
- [Clients](../clients.md): Explore Lavalink clients. | ||
- [Plugins](../plugins.md): Explore Lavalink plugins. | ||
- [Changelog](../changelog.md): Stay updated with the latest changes and improvements. | ||
- [API Implementation Guidelines](../api/index.md): Learn about implementing the Lavalink API. | ||
- [Server Configuration](../configuration/index.md): Learn about configuring your Lavalink server. | ||
|
||
## Found a Bug? | ||
|
||
If you found a bug, please report it on the [issue tracker](https://github.com/lavalink-devs/Lavalink/issues/new?labels=bug&template=bug_report.md). | ||
|
||
## Need Help? | ||
|
||
Join the [Lavalink support Discord]({{ discord_help }}) or open a [GitHub discussion](https://github.com/lavalink-devs/Lavalink/discussions/new?category=q-a) for help or questions. |
This file contains 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 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 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