Skip to content

Commit

Permalink
📝 add guide for using obsidian
Browse files Browse the repository at this point in the history
  • Loading branch information
viztea authored Apr 26, 2021
1 parent 6079945 commit 16249ac
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,21 @@
- Uses [**Lavaplayer**](https://github.com/sedmelluq/lavaplayer)
- Performant, low memory and cpu footprint.

## Usage.

For obsidian to work correctly you must use **Java 11** or above.

- Goto the [releases page](/releases).
- Download the **Latest Jar File**
- Make an [`obsidian.yml`](/obsidian.yml) file in the same directory as the jar file
- Open a prompt in the same directory as the jar file.

```sh
java -jar Obsidian.jar
```

Now go make a bot with the language and client of your choice!

## Clients

> Clients are used to interface with Magma, Obsidian's WebSocket and REST API.
Expand Down

0 comments on commit 16249ac

Please sign in to comment.