Skip to content

Commit

Permalink
Split Modules Documentation
Browse files Browse the repository at this point in the history
- Corrected errors on the main docs page and the README.
- Splits the commands page into multiple pages.
  • Loading branch information
CriticalFlaw committed Apr 17, 2021
1 parent eeaec4d commit 80b6c78
Show file tree
Hide file tree
Showing 10 changed files with 1,177 additions and 1,086 deletions.
12 changes: 6 additions & 6 deletions .github/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[![banner][banner-image]]
[![version][version-badge]]
[![build][build-badge][build-link]]
[![quality][quality-badge][quality-link]]
![banner][banner-image]
![version][version-badge]
[![build][build-badge]][build-link]
[![quality][quality-badge]][quality-link]

A Discord bot written in C# using the [DSharpPlus][dsharp-link] library. This bot is not being hosted online, however you're welcome to fork this repository and host it yourself or reuse the code for your own bot, as long as you credit it properly.

Expand All @@ -12,14 +12,14 @@ A Discord bot written in C# using the [DSharpPlus][dsharp-link] library. This bo
To run your own instance of FlawBOT, [clone this repository][clone-link] or [download the release package][release-link] and modify the provided **config.json** file, adding the API tokens. If you're cloning the repository, use [Visual Studio 2019][vs-link] to compile the project.

## Running FlawBOT
As of version 3.0, FlawBOT requires a [Lavalink][lava-link] node to be running in order to play music and not display lavalink-related errors in console. `lavalink.jar` and `application.yml` are included in the project directory, so all you have to do is open the command prompt and launch lavalink with the command `java -jar Lavalink.jar` (be sure to install [Java 13 or later][java-link].
As of version 3.0, FlawBOT requires a [Lavalink][lava-link] node to be running in order to play music and not display lavalink-related errors in console. `lavalink.jar` and `application.yml` are included in the project directory, so all you have to do is open the command prompt and launch lavalink with the command `java -jar Lavalink.jar` (be sure to install [Java 13 or later][java-link]).

## Documentation
For more information on the project, including the complete list of commands can be found [here][docs-link].

## API Tokens
* [Discord][api-discord] (*required*)
* [Steam](
* [Steam][api-steam]
* [Imgur][api-imgur]
* [OMDB][api-omdb]
* [Twitch][api-twitch]
Expand Down
Loading

0 comments on commit 80b6c78

Please sign in to comment.