Skip to content

Commit

Permalink
Clean-up README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ShindouMihou authored Jan 15, 2021
1 parent 0d9ae46 commit 4231ccc
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,50 +6,51 @@ about a certain author updating their stories.
#### Requirements
- Java 11.
- MongoDB.
- A server, naturally.
- A server (at least 1 GB of RAM, 2 vCPU)
##### 1 GB is recommended due to the overall combined size of MongoDB + the bot. (The bot itself takes up only 64-128 MB)

#### How to install, public bot.

The Amelia bot is already hosted publicly on our servers, as such, you can add it to your own
discord server by inviting it from our website.

[Invite the bot now](https://paradoxium.xyz/amelia)
[Invite the bot now](https://manabot.fun/amelia)


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

https://docs.mongodb.com/manual/tutorial/install-mongodb-on-ubuntu/
[Install MongoDB](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-ubuntu/)

Now, that you have both the MongoDB server and the Discord bot application, grab your token from the Discord App's Developer Portal,
then add it into your System Environmental Variables as `amelia_token` before adding the connection string of your MongoDB server
to the variables as `amelia_db`.

For more details about connection strings, please head to the official MongoDB documentation site.

https://docs.mongodb.com/manual/reference/connection-string/
[Connection String](https://docs.mongodb.com/manual/reference/connection-string/)

For information about setting environmental variables on Ubuntu:

https://mkyong.com/linux/how-to-set-environment-variable-in-ubuntu
[Environment Variables (1)](https://mkyong.com/linux/how-to-set-environment-variable-in-ubuntu)

https://help.ubuntu.com/community/EnvironmentVariables
[Environment Variables (2)](https://help.ubuntu.com/community/EnvironmentVariables)

For information about setting environmental variables on Windows:

https://docs.oracle.com/en/database/oracle/r-enterprise/1.5.1/oread/creating-and-modifying-environment-variables-on-windows.html
[Environment Variables (1)](https://docs.oracle.com/en/database/oracle/r-enterprise/1.5.1/oread/creating-and-modifying-environment-variables-on-windows.html)

https://www.computerhope.com/issues/ch000549.htm
[Environment Variables (2)](https://www.computerhope.com/issues/ch000549.htm)

After all of that is done, make sure you have at least JDK 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.
```
openjdk 11.0.9.1 2020-11-04
OpenJDK Runtime Environment (build 11.0.9.1+1-Ubuntu-0ubuntu1.18.04)
OpenJDK 64-Bit Server VM (build 11.0.9.1+1-Ubuntu-0ubuntu1.18.04, mixed mode, sharing)
```
or it could be something higher the JDK 11, that is fine.

Now, that everything is done, simply head to the Releases section of this Github page and download the Fat .jar
Now, that everything is done, simply head to the Releases section of this GitHub page and download the Fat .jar
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 comments on commit 4231ccc

Please sign in to comment.