SowinskiBraeden
7c2373e03e
Update the Installation in getting started to match the new .env.example file
85 lines
2.7 KiB
Markdown
85 lines
2.7 KiB
Markdown
# DayZ.R Bot
|
|
|
|
A general purpose Discord Bot to handle DayZ Killfeed, stats, alarms and factions' armbands and more using Nitrado Log files.
|
|
|
|
***Explore the docs »***
|
|
* [Technologies](#built-with)
|
|
* [About](#about)
|
|
* [Support](#support)
|
|
* [License](#license)
|
|
* [Contributing](#contributing)
|
|
* [Getting Started](#getting-started)
|
|
* [Prerequisites](#prerequisites)
|
|
* [Installation](#installation)
|
|
* [Contact](#contact)
|
|
|
|
### Built With
|
|
|
|
* [Node.js](https://nodejs.org/en)
|
|
* [Discord.js](https://discord.js.org/#/)
|
|
* [MongoDB](https://www.mongodb.com/)
|
|
|
|
## About The Project
|
|
|
|
Originally just a simple project to have factions select their armbands, and track that in the Discord. With the increasing difficulty of other DayZ killfeed bots, I
|
|
expanded this project to include the killfeed, alarms, banking, and much much more.
|
|
|
|
## Support
|
|
[» Community Support](https://discord.gg/KVFJCvvFtK)
|
|
|
|
## License
|
|
[» License](/LICENSE)
|
|
|
|
## Contributing
|
|
[» Contributing](/CONTRIBUTING.md)
|
|
|
|
## Getting Started
|
|
|
|
The bot requires minimal setup to get started.
|
|
|
|
### Prerequisites
|
|
|
|
1. [Create your Discord Bot and get the private token](https://github.com/reactiflux/discord-irc/wiki/Creating-a-discord-bot-&-getting-a-token) for later configuration. Invite this bot to your desired discord server.
|
|
|
|
2. You'll need some important private information from your Nitrado account for later configuration.
|
|
i. Your Nitrado user ID
|
|
ii. Your DayZ Nitrado server ID
|
|
iii. Create and Copy your Nitrado authentication token.
|
|
|
|
3. You'll need to setup an instance of MongoDB. You can use the cloud platform, MongoDB Atlas, or create your own instance locally.
|
|
i. [Create your MongoDB Altas instance.](https://www.mongodb.com/docs/manual/tutorial/getting-started/)
|
|
ii. [Create your local MongoDB server instance.](https://www.mongodb.com/docs/manual/administration/install-community/)
|
|
|
|
After this, you'll need to get your MongoURI from your database instance, as well as your database name for later configuration.
|
|
|
|
### Installation
|
|
|
|
1. Clone the repo
|
|
```
|
|
$ git clone https://github.com/SowinskiBraeden/dayz-reforger.git
|
|
$ cd dayz-reforger
|
|
```
|
|
2. Rename `.env.example` to `.env`
|
|
3. Enter desired values into `.env`
|
|
```
|
|
# Discord Bot Token
|
|
token='Your Discord Bot token'
|
|
|
|
# MongoDB Information
|
|
mongoURI='Your mongodb URI'
|
|
dbo='Your mongodb database'
|
|
|
|
# Encryption
|
|
key='Secret Encryption Key',
|
|
iv='Secret Initialization Vector',
|
|
|
|
# Other Bot Configuration
|
|
Dev=PROD. # or DEV.
|
|
```
|
|
|
|
## Contact
|
|
|
|
Braeden Sowinski - [@BraedenSowinski](https://twitter.com/BraedenSowinski) - sowinskibraeden@gmail.com - @mcdazzzled on Discord
|
|
|
|
Project Link: [https://github.com/SowinskiBraeden/dayz-reforger](https://github.com/SowinskiBraeden/dayz-reforger)
|