Skip to content
This repository was archived by the owner on Jun 9, 2020. It is now read-only.

Commit 9b1227b

Browse files
author
Nightlife
committed
chore: cleanup README a little
1 parent 5794600 commit 9b1227b

File tree

2 files changed

+23
-17
lines changed

2 files changed

+23
-17
lines changed

README.md

+22-16
Original file line numberDiff line numberDiff line change
@@ -18,55 +18,61 @@
1818
</a>
1919
</div>
2020

21-
A Discord bot that does ~~all~~ most of the things - [atlasbot.xyz](https://atlasbot.xyz)
21+
Yet another Discord bot that tries to do everything - [atlasbot.xyz](https://atlasbot.xyz)
2222

2323
This is all the code that runs the bot portion of Atlas. The dashboard, API and other secret sauce will remain closed source for now. Contributions are welcome.
2424

2525
## Prerequisites
2626

2727
- [Docker](https://docker.com/)
2828
- [docker-compose](https://docs.docker.com/compose/)
29-
- [Node.js](https://nodejs.org/en/) >=10.0.0 (not required for self-hosting)
29+
- [Node.js](https://nodejs.org/en/) >=10.0.0 \*
30+
31+
\* Required for development. If you're self-hosting, you can skip these requirements.
3032

3133
## Installation
3234

33-
### Self-hosting
35+
Linux is recommended, but Docker means macOS, Windows and more or less anything that runs Docker will work. For development, anything that runs Node.js and Docker will work.
36+
37+
#### Self-hosting
3438

3539
1. Install [Docker](https://docs.docker.com/install/) and [docker-compose](https://docs.docker.com/compose/install/)
3640

37-
2. Clone this repo
41+
1. Clone this repo
3842

3943
```bash
4044
git clone https://github.com/atlasbot/bot.git
4145
```
4246

43-
3. Open a terminal in the cloned folder
47+
1. Open a terminal in the cloned folder
48+
49+
1. Copy `.env.example` to `.env` and fill in the required env variables. See below for what most do. Google is your friend.
4450

45-
4. Copy `.env.example` to `.env` and fill in the required env variables. See below for what most do. Google is your friend.
51+
1. Start the bot with `docker-compose up -d`. If you did everything right, then congratulations - you now have your own instance of Atlas.
4652

47-
5. Start the bot with `docker-compose up -d`. If you did everything right, then congratulations - you now have your own instance of Atlas.
53+
#### Development
4854

49-
### Development
55+
1. Install [Docker](https://docs.docker.com/install/), [docker-compose](https://docs.docker.com/compose/install/) and [Node.js](https://nodejs.org/en/)
5056

5157
1. Clone this repo
5258

5359
```bash
5460
git clone https://github.com/atlasbot/bot.git
5561
```
5662

57-
2. Open a terminal in the cloned folder
63+
1. Open a terminal in the cloned folder
5864

59-
3. Run `npm i` to install dependencies
65+
1. Run `npm install` to install dependencies
6066

61-
4. Copy `.env.example` to `.env` and replace any variables you would like. Setting `NODE_ENV` to `development` will enable extra features and help debugging things. Setting `DEBUG=*` may also help if you dont mind reading logs. `DEBUG=package:*` is also acceptable, e.g `DEBUG=monk:*` to listen to database debug messages.
67+
1. Copy `.env.example` to `.env` and replace any variables you would like. Setting `NODE_ENV` to `development` will enable extra features and help debugging things. Setting `DEBUG=*` may also help if you dont mind reading logs. `DEBUG=package:*` enables debug for specific packages, e.g `DEBUG=monk:*` to listen to database debug messages.
6268

63-
5. Start Lavalink, Redis and Mongo via `docker-compose up -d mongo lavalink redis`
69+
1. Start Lavalink, Redis and Mongo via `docker-compose up -d mongo lavalink redis`
6470

6571
If you are using docker-compose to host these services, you can leave the defaults in `.env.example` for those services and it should be gucci.
6672

67-
6. Start the bot with `npm run dev`
73+
1. Start the bot with `npm run dev`
6874

69-
7. Start breaking things. Once you save a file change, the bot will restart with the changes. Do `npm run start` to start the bot without watching files.
75+
1. Start breaking things. Once you save a file change, the bot will restart with the changes. Do `npm run start` to start the bot without watching files.
7076

7177
## Environment Variables
7278

@@ -100,11 +106,11 @@ _\* Optional, but some features may not work without them._
100106

101107
The `NODE_ENV` environment variable must be set to `development` for these to work.
102108

103-
- To run a filter without it being enabled, include `Atlas:forceFilter:filter` with whatever you want to test. E.g, `Atlas:forceFilter:invites discord.gg/AXXBPM7` will force run the "invites" filter.
109+
- To run a filter without it being enabled, include `Atlas:forceFilter:filter` with whatever you want to test. E.g, `Atlas:forceFilter:invites discord.gg/AXXBPM7` will the "invites" filter to execute even when it's action type is `0`.
104110

105111
## Disclaimer / Warning
106112

107-
At the time of writing this, there will be no support if you break anything. We are not responsible for anything you break, and won't help you if you do. If you don't know what you're doing, just use the public instance.
113+
If you're going to self-host Atlas, you won't get help with setting it up. We may refuse to support you with general issues. You are responsible if you break anything. Seriously, if you don't know what you're doing, just use the public instance.
108114

109115
## Acknowledgements
110116

src/util.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -731,7 +731,7 @@ module.exports = class Util {
731731
// we ain't adding more then two roles at once
732732
.slice(0, 2);
733733
} else {
734-
// get the reward closest to <= current level
734+
// get the reward closest to <= current level
735735
shouldHave = [rewards.reduce((prev, curr) => {
736736
if (curr.level > currentLevel) {
737737
return prev;

0 commit comments

Comments
 (0)