https://github.com/imatpot/lunaro-manager
🥍 Discord bot for all things Lunaro
https://github.com/imatpot/lunaro-manager
conclave discord lunaro poise-rs serenity-rs warframe
Last synced: 11 months ago
JSON representation
🥍 Discord bot for all things Lunaro
- Host: GitHub
- URL: https://github.com/imatpot/lunaro-manager
- Owner: imatpot
- License: gpl-3.0
- Created: 2022-04-19T16:59:00.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-31T20:43:37.000Z (almost 2 years ago)
- Last Synced: 2025-04-13T17:41:46.407Z (about 1 year ago)
- Topics: conclave, discord, lunaro, poise-rs, serenity-rs, warframe
- Language: Rust
- Homepage:
- Size: 590 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Lunaro Manager
Discord bot for managing everything Lunaro for the Academia Lunaris Discord Server
## Usage
> [!NOTE]
> Lunaro tracking is **enabled** for every server member by default.
>
> Lunaro Manager will react to changes in your Discord rich presence.
> It will automatically set your playing status to "Playing Lunaro" when you are playing Lunaro, and remove it with a small delay when you are not.
>
> You can disable Lunaro tracking for your account at any time using the [`/tracking pause`](#-tracking-pause) command.
### `❓ /help`
Guides to the Discord command explorer to discover all commands, and also links to this GitHub section.
### `🏓 /ping`
Check if Lunaro Manager is online and how long it took to receive the ping.
This value is calculated from the system time, and may thus be inaccurate.
### `🟢 /play now`
Adds the playing role to your profile.
You can optionally disable Lunaro tracking for your account at the same time.
### `⭕ /play later`
Removes the playing role from your profile.
You can optionally re-enable Lunaro tracking for your account at the same time.
### `👀 /play info`
Lists the number of members playing Lunaro.
### `💤 /tracking pause`
Disables Lunaro tracking for your account.
The bot will no longer react to changes in your Discord rich presence.
This is useful because the Lunaro tracker will otherwise override your manually set playing status.
### `👁️ /tracking resume`
Enables Lunaro tracking for your account.
The bot will now react to changes in your Discord rich presence.
Now you don't have to manually set your playing status anymore, as the bot will automatically check if you are playing Lunaro.
### `💡 /about`
Displays details about Lunaro Manager, including amount of actively tracked members as well as stats and metadata about the bot.
### `🤝 /contribute`
Displays a link to this GitHub page, encouraging the creation of issues and pull requests.
## Development setup
1. Create a bot on https://discord.com/developers
2. Enable `PRESENCE` & `SERVER MEMBERS` intents in the Bot section
3. Invite the bot to your server, giving the following permissions:
- Manage Roles
- Send Messages
4. Create a `.env` file following the schema in [.env.schema](.env.schema)
5. Run the bot using one of the methods below
## Running the bot
You can run the bot in several ways, depending on your preference and use case.
### Run locally
You need to have [Rust](https://rust-lang.org) installed.
This is the recommended way to run the bot during development.
```sh
$ cargo run
```
### Run in Docker
You need to have [Docker](https://docker.com) installed.
This is the recommended way to run the bot in production.
```sh
$ docker compose up --build -d
```
### Run using Nix
If you have the [Nix](https://nixos.org) package manager installed with [Flakes](https://nixos.wiki/wiki/Flakes) enabled, you have several ways to build and run this bot.
As a reminder:
- `nix build` builds the package binary
- `nix shell` builds the package binary and makes it available in your `$PATH`
- `nix run` builds the package binary and immediately executes it
I will use `nix run` as the example, but you can use any of the above.
```sh
# run from local repository. make sure Cargo.lock is available!
$ nix run
# run latest using remote repository
$ nix run github:imatpot/lunaro-manager
# run specific version using remote repository
$ nix run github:imatpot/lunaro-manager/2.1.0
```