From 6e2066711827737061f759fa6ef68b0b4d0b2d36 Mon Sep 17 00:00:00 2001 From: Dennis Heinrich Date: Mon, 18 Nov 2024 18:18:41 +0100 Subject: [PATCH] Added Open-Source-License and formatted the README file --- LICENSE.md | 14 ++++++++++++++ README.md | 13 +++++++++---- 2 files changed, 23 insertions(+), 4 deletions(-) create mode 100644 LICENSE.md diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..9bf6e2a --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,14 @@ +Copyright 2024 - Dennis Heinrich + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated +documentation files (the “Software”), to deal in the Software without restriction, including without limitation the +rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit +persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the +Software. + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE +WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR +OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index e58f77c..fa61ae8 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,15 @@ # Farming Simulator 25 - Discord Bot -This bot will post the server stats of a Farming Simulator 25 server to a Discord channel. The bot will post the server name, server password, server time, and the player count. The bot will update the server stats every x seconds (configurable). +This bot will post the server stats of a Farming Simulator 25 server to a Discord channel. The bot will post the server +name, server password, server time, and the player count. The bot will update the server stats every x seconds ( +configurable). ![discord_embed.png](misc%2Fimages%2Fdiscord_embed.png) -The bot is written in Node.js and uses the [discord.js](https://discord.js.org/) library to interact with the Discord API. It -uses the XML-Feed from the Farming Simulator 25 server to get the server stats (you can find the feed URL in the web interface of the server). +The bot is written in Node.js and uses the [discord.js](https://discord.js.org/) library to interact with the Discord +API. It +uses the XML-Feed from the Farming Simulator 25 server to get the server stats (you can find the feed URL in the web +interface of the server). ![bot_terminal.png](misc%2Fimages%2Fbot_terminal.png) @@ -34,7 +38,8 @@ uses the XML-Feed from the Farming Simulator 25 server to get the server stats ( 1. Clone the repository to your server 2. Move the `config.example.json` to `config.json` 3. Fill in the required fields in the `config.json` file, do not delete fields, just leave them empty for default values -4. All fields with a `(*)` are required fields for the bot to work. The other fields are optional and can be left by default +4. All fields with a `(*)` are required fields for the bot to work. The other fields are optional and can be left by + default | **- Key -** | **- Description -** | |----------------------------------------------|---------------------------------------------------------------------------|