diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..f7cc002 --- /dev/null +++ b/.env.example @@ -0,0 +1,8 @@ +token='Your Discord Bot token' +mongoURI='Your mongodb URI' +dbo='Your mongodb database' +SERVER_ID='Your Nitrado server ID' +USER_ID='Your Nitrado user ID' +AUTH_KEY='Your Nitrado Auth Token' +GuildID='Your Discord Guild ID' +Dev=PROD. # or DEV. \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..1fb210e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,19 @@ + +## Contributing + +Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. + +If you have a suggestion that would make this better, please create a pull request. You can also simply open an issue with the tag "enhancement". +Don't forget to give the project a star! Thanks again! + +1. Clone the Project +2. Create your Feature Branch (`git checkout -b update/AmazingFeature`) +3. Commit your Changes (`git commit -m 'update/your-update'`) please use the following for your commits: + i. `update/your-update` + ii. `fix/your-fix` + iii. `refactor/your-refactor` (Refactoring code, doesn't change behavior) + iv. `change/your-change` (Changing existing code behavior) +4. Push to the Branch (`git push origin update/AmazingFeature`) +5. Open a Pull Request + +Do keep in mind of the [package.json](/package.json) version. Version structure is as follows: `(major).(minor).(patch)` diff --git a/README.md b/README.md new file mode 100644 index 0000000..8fe924f --- /dev/null +++ b/README.md @@ -0,0 +1,71 @@ +# DayZ R. Bot [![Node.js](https://nodejs.org/static/images/logo.svg)](https://nodejs.org/en) + +A general purpose Discord Bot to handle DayZ Killfeed, stats, alarms and factions' armbands and more using Nitrado Log files. + +***Explore the docs ยป*** +* [Getting Started](#getting-started) +* [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. + +## 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` +``` + token='Your Discord Bot token' + mongoURI='Your mongodb URI' + dbo='Your mongodb database' + SERVER_ID='Your Nitrado server ID' + USER_ID='Your Nitrado user ID' + AUTH_KEY='Your Nitrado Auth Token' + GuildID='Your Discord Guild ID' +``` + +
+ + +## 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) diff --git a/config/config.js b/config/config.js index e079aeb..995e248 100644 --- a/config/config.js +++ b/config/config.js @@ -3,7 +3,7 @@ require('dotenv').config(); module.exports = { Dev: process.env.Dev || "DEV.", - Version: package.version, // (major).(feature).(patch) + Version: package.version, // (major).(minor).(patch) Admins: ["362791661274660874", "329371697570381824"], // Admins of the bot ServerID: "1050215624053374976", GuildID: process.env.GuildID || "",