You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+34-53Lines changed: 34 additions & 53 deletions
Original file line number
Diff line number
Diff line change
@@ -6,8 +6,7 @@
6
6
7
7
<palign="center">
8
8
<i>
9
-
Discord bot for managing <a href="https://warframe.fandom.com/wiki/Lunaro">Lunaro</a>
10
-
related ideas, targeted at the <a href="https://discord.gg/mUjGHEw">Lunaro Revival Discord Server</a>
9
+
Discord bot for managing everything <a href="https://warframe.fandom.com/wiki/Lunaro">Lunaro</a> for the <a href="https://discord.gg/rFBzmpEQxc">Academia Lunaris Discord Server</a>
while inserting your client ID and keeping the scopes. Remember that the bot is
40
-
designed to *only be active in 1 server at a time.*
41
-
42
-
Please also make sure the bot's personal role is ranked *above* the managed playing role!
43
-
44
-
---
45
-
46
25
## Usage
47
26
48
-
This section explains all functionality which Lunaro Manager offers. Every
49
-
action will be replied to with a (selectively ephemeral) message.
50
-
51
27
### `❓ /help`
52
28
53
-
Guides to the Discord command explorer to discover all commands, and also links
54
-
to this GitHub section.
29
+
Guides to the Discord command explorer to discover all commands, and also links to this GitHub section.
55
30
56
31
### `🏓 /ping`
57
32
58
-
Check if Lunaro Manager is online and how long it took to receive the ping. This
59
-
value is calculated from the system time, and may thus be inaccurate.
33
+
Check if Lunaro Manager is online and how long it took to receive the ping.
34
+
This value is calculated from the system time, and may thus be inaccurate.
60
35
61
36
### `🟢 /play now`
62
37
@@ -74,23 +49,21 @@ Lists the number of members with the playing role.
74
49
75
50
### `💤 /tracking pause`
76
51
77
-
Disables Lunaro tracking for your account. This is useful because the Lunaro
78
-
tracker will otherwise override your manually set playing status.
52
+
Disables Lunaro tracking for your account.
53
+
This is useful because the Lunaro tracker will otherwise override your manually set playing status.
79
54
80
55
### `👁️ /tracking resume`
81
56
82
-
Enables Lunaro tracking for your account. Now you don't have to manually set
83
-
your playing status anymore.
57
+
Enables Lunaro tracking for your account.
58
+
Now you don't have to manually set your playing status anymore!
84
59
85
60
### `💡 /about`
86
61
87
-
Displays details about Lunaro Manager, including amount of actively tracked
88
-
members as well as stats and metadata about the bot.
62
+
Displays details about Lunaro Manager, including amount of actively tracked members as well as stats and metadata about the bot.
89
63
90
64
### `🤝 /contribute`
91
65
92
-
Displays a link to this GitHub page, encouraging the creation of issues and
93
-
pull requests.
66
+
Displays a link to this GitHub page, encouraging the creation of issues and pull requests.
94
67
95
68
---
96
69
@@ -100,31 +73,45 @@ pull requests.
100
73
101
74
2. Enable `PRESENCE` & `SERVER MEMBERS` intents in the Bot section
102
75
103
-
3. Create a `.env` file following the example of [.env.example](.env.example)
76
+
3. Invite the bot to your server, giving the following permissions:
77
+
- Manage Roles
78
+
- Send Messages
104
79
105
-
4. Run the bot (see next sections)
80
+
4. Create a `.env` file following the schema in [.env.schema](.env.schema)
81
+
82
+
5. Run the bot using one of the methods below
106
83
107
84
## Running the bot
108
85
86
+
You can run the bot in several ways, depending on your preference and use case.
87
+
109
88
### Run locally
110
89
111
90
You need to have [Rust](https://rust-lang.org) installed.
91
+
This is the recommended way to run the bot during development.
112
92
113
93
```sh
114
94
$ cargo run
115
95
```
116
96
97
+
### Run in Docker
98
+
99
+
You need to have [Docker](https://docker.com) installed.
100
+
This is the recommended way to run the bot in production.
101
+
102
+
```sh
103
+
$ docker compose up --build -d
104
+
```
105
+
117
106
### Run using Nix
118
107
119
-
If you have the [Nix](https://nixos.org) package manager installed, and enabled
120
-
[Flakes](https://nixos.wiki/wiki/Flakes), you have several ways to build and run
121
-
this bot.
108
+
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.
122
109
123
110
As a reminder:
124
111
125
112
-`nix build` builds the package binary
113
+
-`nix shell` builds the package binary and makes it available in your `$PATH`
126
114
-`nix run` builds the package binary and immediately executes it
127
-
-`nix shell` builds the package binary and makes it available in your shell
128
115
129
116
I will use `nix run` as the example, but you can use any of the above.
0 commit comments