dennis.heinrich/FS25-Discord-Bot
1
0
Fork 0
mirror of https://github.com/cloudmaker97/FS25-Discord-Bot.git synced 2025-12-06 00:18:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Added Open-Source-License and formatted the README file

Browse source
This commit is contained in:
Dennis Heinrich 2024-11-18 18:18:41 +01:00
parent a5e1e06521
commit 6e20667118
2 changed files with 23 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
LICENSE.md Normal file
View file

@ -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.

13
README.md
View file

@ -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 -** |
|----------------------------------------------|---------------------------------------------------------------------------|