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
+45-26
Original file line number
Diff line number
Diff line change
@@ -1,32 +1,62 @@
1
-
#### Amelia, a Discord Bot of Waters.
2
-
1
+
# Amelia
3
2
Amelia is a simple Discord bot that is used to fetch RSS feeds, and updates users
4
3
about a certain author updating their stories.
5
4
6
-
#### Requirements
7
-
- Java 11.
8
-
- MongoDB.
9
-
- A server, naturally.
5
+
## Requirements
6
+
The specification requirements for Amelia are as of follows:
7
+
- OpenJDK 11 (or JDK 11)
8
+
- A MongoDB server.
9
+
- A server that is at least 1.5 gigabytes of memory and 2 vCPUs.
10
10
11
-
####How to install, public bot.
11
+
## How to install, public bot.
12
12
13
13
The Amelia bot is already hosted publicly on our servers, as such, you can add it to your own
14
-
discord server by inviting it from our website.
15
-
16
-
[Invite the bot now](https://paradoxium.xyz/amelia)
14
+
discord server by inviting it from our website. [Invite the bot now](https://discord.com/oauth2/authorize?client_id=786464598835986483&scope=bot&permissions=67488832)
17
15
18
-
19
-
#### How to install, self-hosting.
16
+
## How to install, self-hosting.
20
17
If you want to install this on your own server, first, create a Discord bot application on https://discordapp.com/developers,
21
18
after which, you need to have a MongoDB server installed on either a Windows or a Ubuntu server, I will not go into detail
22
19
over how to do this but if you need a good tutorial, then the official MongoDB website is the way to go.
Now, that you have both the MongoDB server and the Discord bot application, grab your token from the Discord App's Developer Portal,
27
-
then add it into your System Environmental Variables as `amelia_token` before adding the connection string of your MongoDB server
28
-
to the variables as `amelia_db`.
23
+
### Setting up Amelia Websocket.
24
+
Amelia Websocket, which is a new addition implemented on Amelia 2.0, is a separate process of Amelia which can be said as the heart or the brain
25
+
of the Discord bot. The websocket handles the checking for updates on RSS Feeds and also Trending Notifications.
26
+
27
+
### Installation of Amelia Websocket.
28
+
To install the websocket, you need to download the websocket jar from the [releases page](https://github.com/ManaNet/Amelia/releases) and then setup the following
29
+
environment variables.
30
+
```
31
+
amelia_auth=AUTHENTICATION
32
+
amelia_db=mongodb://user:pass@ip:port
33
+
(OPTIONAL) amelia_websocket=ws://ip:3201/
34
+
```
35
+
36
+
After the environment variables are set, you can now start up the websocket with no configuration via: `java -jar Amelia-Websocket.jar`.
29
37
38
+
### Setting up Amelia Client.
39
+
After the Websocket application is running, you can now start with the Client application.
40
+
41
+
#### Instructions
42
+
1. Retrieve your token from [Discord App's Developer Portal](https://discord.com/developers/)
43
+
2. Add the token onto your System Environmental Variables as `amelia_token`.
44
+
3. Check your Java Version whether it is JDK 11.
45
+
4. Download the Client jar file and run it via `java -jar Amelia.jar`
46
+
47
+
#### JDK Version Example
48
+
After all of that is done, make sure you have Java 11 by opening your terminal and using `java --version`, it should return something amongst the likes of this.
After all of that is done, make sure you have Java 11 by opening your terminal and using `java --version`, it should return something amongst the likes of this.
0 commit comments