Skip to content

Commit 3a71b23

Browse files
Add full README
1 parent 1b47688 commit 3a71b23

File tree

1 file changed

+97
-2
lines changed

1 file changed

+97
-2
lines changed

README.md

Lines changed: 97 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,97 @@
1-
# timezone-bot-dotnet
2-
A Discord TimeZone Bot in .NET
1+
# TimeZone Bot
2+
3+
TimeZone Bot has 2 main features:
4+
5+
- Converting times between time zones for users in your Discord
6+
- Checking users birthdays (and a birthday post on their birthday)
7+
8+
## Links
9+
10+
[Invite TimeZone Bot to your Discord Server](https://discord.com/api/oauth2/authorize?client_id=736720417166721105&permissions=414464859200&scope=bot%20applications.commands)
11+
12+
[Discord Support Server](https://discord.gg/Za4NAtJJ9v)
13+
14+
![TimeZone Bot](https://github.com/rarDevelopment/timezone-bot-dotnet/assets/4060573/52f12fc5-6d37-4e6f-91a1-8493097d71cd)
15+
16+
## Getting Started
17+
18+
- Invite the bot to your server using the invite link above.
19+
- Each user will have to set up their time zone. To do this, it is recommended that you visit [the bot website](https://www.rardk64.com/) using the instructions below.
20+
- Each user can also set up their birthday. For birthday alerts to work, the user will have to set up their time zone as well.
21+
- **NOTE:** If your server is made up of users who are entirely in the same time zone, and you just wish to use this bot for birthday wishes, you can set a default time zone using the `/set-default-time-zone` command - for more on this command, see the [Commands section](#commands) below.
22+
23+
## Using the Website
24+
25+
- Browse to https://rardk64.com/
26+
- Click "Log in with Discord" and log in using your Discord account
27+
- In the TimeZone Bot section, tap the "Settings" button
28+
- Search for your time zone, and either click the "Set" button to set it immediately, or use the copy icon button to copy it and use it with either the `/set-time-zone` or `/set-default-time-zone` commands in Discord.
29+
30+
![image](https://github.com/rarDevelopment/timezone-bot-dotnet/assets/4060573/b5fc9202-a091-4adb-a197-29a653c67213)
31+
32+
## Time Reactions
33+
34+
When TimeZone Bot detects a valid time in a user's message, it will react with a "Time" emote reaction. If you tap that reaction, TimeZone Bot will respond with that time converted to your time. You must have your time zone set up for this to work.
35+
36+
![Time Reaction](https://github.com/rarDevelopment/timezone-bot-dotnet/assets/4060573/cb8686ce-49ca-430c-b99c-7be4d0a342a3)
37+
38+
## Commands
39+
40+
**Note:** Commands or descriptions below with * can only be used by the administrators.
41+
42+
### Time Commands
43+
44+
---
45+
46+
`/time`
47+
48+
Get the current time for the specified user in their time zone. Optionally, can also specify a time, and it will convert that time to the specified user's time zone.
49+
50+
---
51+
52+
`/time-all`
53+
54+
Get the current time for the all users in their respective time zones. Optionally, you can also specify a time, and it will convert that time to all other user's time zones.
55+
56+
---
57+
58+
`/set-time-zone`
59+
60+
Sets your time zone. NOTE: You must use a valid IANA Zone ID. You can [use our website](#using-the-website) to set it more easily.
61+
62+
---
63+
64+
`/set-default-time-zone`*
65+
66+
Set the default time zone for birthday checks when members have not set their time zone. NOTE: You must use a valid IANA Zone ID. You can [use our website](#using-the-website) to find a valid ID.
67+
68+
---
69+
70+
`/set-reactions`*
71+
72+
Set [time reactions](#time-reactions) on/off.
73+
74+
---
75+
76+
### Birthday Commands
77+
78+
---
79+
80+
`/birthday`
81+
82+
Get the birthday for the specified user.
83+
84+
---
85+
86+
`/birthday-all`
87+
88+
Get the birthdays for all users. You can also specify a method by which to sort the birthdays: Alphabetical (by username), Age, or Next Birthday.
89+
90+
---
91+
92+
`/set-birthday`
93+
94+
Set your birthday.
95+
96+
---
97+

0 commit comments

Comments
 (0)