Skip to content

Commit

Permalink
DOCS: Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
KOOKIIEStudios authored Jan 12, 2021
1 parent f45fc38 commit 6260db9
Showing 1 changed file with 2 additions and 16 deletions.
18 changes: 2 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,29 +6,15 @@ Lapis is inspired by the [MapleDiscBot](https://github.com/Bratah123/MapleDiscBo
Lapis accesses character and inventory attributes in [AzureMSv316](https://github.com/SoulGirlJP/AzureV316)-based databases using the [Lazuli API](https://team-spirit-productions.github.io/Lazuli/reference/lazuli/).


#### Current Status: **Release Candidate 1 is out now!**
### TODO:
- [x] Working protoype - *Target goal for RC1*
- [ ] Unit Testing - *Target goal for RC2*
- [ ] Comprehensive Documentation - *Target goal for Release*
#### Current Status: **Released!**

## Gallery
![character](https://cdn.discordapp.com/attachments/631249406775132182/795031817891610644/c76d5804a42f63accb448e8a9e8bf157.png)

![help](https://cdn.discordapp.com/attachments/631249406775132182/795031808512098334/42b4365e6b819a088fc59d01d11ef27c.png)
## Documentation:
Kindly direct any problems or questions to the [Issues](https://github.com/TEAM-SPIRIT-Productions/Lapis/issues) page.
You will need to generate your `VENV` prior to use. Refer to [Lazuli's Wiki](https://github.com/TEAM-SPIRIT-Productions/Lazuli/wiki/Technical-Details#step-1-generate-the-virtual-environment) for details on how to do so.

## Configuration
![config](https://media.discordapp.net/attachments/746519006961336370/795472281840517120/d2df4b78e7ef657d8c0e07076c1781ab.png?width=1003&height=348)
- Prior to launching the bot, please navigate to config.json found in the `src` folder.
- Here you will find various settings you have to fill out
- First you MUST fill out the BOT_TOKEN section by obtaining a bot token from the [Discord Developer Portal](https://discord.com/developers/docs/intro).
- The rest of the settings do not need to be filled out for it to work, however feel free to make the changes related to your server
- If you do not know what you are doing keep `"USE_DEFAULT_DB"` to true.
- If it is false, the settings below it would be used for ALL database calls
- If you configure `ADD_ROLE` to true, you HAVE to fill out `ROLE_TO_ADD` which is the role id.
You may refer to the [wiki](https://github.com/TEAM-SPIRIT-Productions/Lapis/wiki) for a quick start guide.

## Technical Details
*Inherited from Lazuli*
Expand Down

0 comments on commit 6260db9

Please sign in to comment.