Skip to content

Commit da4f7a7

Browse files
authored
Update readme.md
1 parent 5ad2964 commit da4f7a7

File tree

1 file changed

+45
-26
lines changed

1 file changed

+45
-26
lines changed

readme.md

+45-26
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,62 @@
1-
#### Amelia, a Discord Bot of Waters.
2-
1+
# Amelia
32
Amelia is a simple Discord bot that is used to fetch RSS feeds, and updates users
43
about a certain author updating their stories.
54

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.
1010

11-
#### How to install, public bot.
11+
## How to install, public bot.
1212

1313
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)
1715

18-
19-
#### How to install, self-hosting.
16+
## How to install, self-hosting.
2017
If you want to install this on your own server, first, create a Discord bot application on https://discordapp.com/developers,
2118
after which, you need to have a MongoDB server installed on either a Windows or a Ubuntu server, I will not go into detail
2219
over how to do this but if you need a good tutorial, then the official MongoDB website is the way to go.
2320

2421
https://docs.mongodb.com/manual/tutorial/install-mongodb-on-ubuntu/
2522

26-
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`.
2937

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.
49+
```
50+
openjdk 11.0.9.1 2020-11-04
51+
OpenJDK Runtime Environment (build 11.0.9.1+1-Ubuntu-0ubuntu1.18.04)
52+
OpenJDK 64-Bit Server VM (build 11.0.9.1+1-Ubuntu-0ubuntu1.18.04, mixed mode, sharing)
53+
```
54+
55+
## Output Image Examples
56+
![Amelia Websocket](https://media.discordapp.net/attachments/733025925683347596/851566821521227826/unknown-66.png?width=1373&height=533)
57+
![Amelia Client](https://media.discordapp.net/attachments/733025925683347596/851566821761089576/unknown-102.png)
58+
59+
## Extra Links
3060
For more details about connection strings, please head to the official MongoDB documentation site.
3161

3262
https://docs.mongodb.com/manual/reference/connection-string/
@@ -42,14 +72,3 @@ For information about setting environmental variables on Windows:
4272
https://docs.oracle.com/en/database/oracle/r-enterprise/1.5.1/oread/creating-and-modifying-environment-variables-on-windows.html
4373

4474
https://www.computerhope.com/issues/ch000549.htm
45-
46-
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.
47-
```
48-
openjdk 11.0.9.1 2020-11-04
49-
OpenJDK Runtime Environment (build 11.0.9.1+1-Ubuntu-0ubuntu1.18.04)
50-
OpenJDK 64-Bit Server VM (build 11.0.9.1+1-Ubuntu-0ubuntu1.18.04, mixed mode, sharing)
51-
```
52-
or it could be something higher the JDK 11, that is fine.
53-
54-
Now, that everything is done, simply head to the Releases section of this Github page and download the Fat .jar
55-
from there, and place it on a place where you can access then simply call `java -jar Amelia.jar` and it should be running.

0 commit comments

Comments
 (0)