Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Clem-Fern authored Feb 4, 2023
1 parent 62d6a18 commit c10448e
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# LuckSecure
*This is a bungeecord plugin. Depends on [LuckPerms](https://github.com/LuckPerms/LuckPerms)*

#### This plugin aims to increase security by adding a custom luckperms context named `lucksecure` . A user with a group/permission in need of the `authenticated` context will have to authenticate himself with a time-based one-time password (Google Authenticator/Microsoft Authenticator & etc...) .
#### This plugin aims to increase security by adding a custom luckperms context named `lucksecure` . A user with a group/permission in need of the `authenticated` context will have to authenticate himself with a time-based one-time password (Google Authenticator/Microsoft Authenticator & etc...).

---

Expand All @@ -26,3 +26,15 @@ lsauth | none | On the first use, it will generate a totp key and qrcode
lsauth {code} | none | Use this command to authenticate yourself with your TOTP code
lsauth-status {player} | lsauth.cmd | Display the authentication status
lsauth-reset {player/uuid} | none | Reset the totp key of a player (Usable in the bungeecord console only)


### How to build :
```
git clone https://github.com/PumpMyKins/LuckSecure.git
cd LuckSecure
mvn package
```

### TODO
- kick timer on join
- custom totp key length

0 comments on commit c10448e

Please sign in to comment.