diff --git a/README.md b/README.md index b23cc9d..3e9f702 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # Farming Simulator 25 - Discord Bot -This bot periodically updates a Discord channel with stats from a Farming Simulator 25 server. -It posts the server name, password, time, and player count. Written in Node.js, it uses the -discord.js library to interact with Discord and fetches server stats via the XML feed +This bot periodically updates a Discord channel with stats from a Farming Simulator 25 server. +It posts the server name, password, time, and player count. Written in Node.js, it uses the +discord.js library to interact with Discord and fetches server stats via the XML feed (accessible through the server's web interface). The update interval is configurable. ## Screenshots @@ -10,21 +10,21 @@ discord.js library to interact with Discord and fetches server stats via the XML
Discord embed in english -![discord_en.png](misc%2Fimages%2Fdiscord_en.png) +![discord_en.png](misc%2Fimages%2Freadme%2Fdiscord_en.png)
Discord embed in german -![discord_de.png](misc%2Fimages%2Fdiscord_de.png) +![discord_de.png](misc%2Fimages%2Freadme%2Fdiscord_de.png)
Terminal output (NodeJS) -![bot_terminal.png](misc%2Fimages%2Fbot_terminal.png) +![bot_terminal.png](misc%2Fimages%2Freadme%2Fbot_terminal.png)
@@ -56,8 +56,8 @@ discord.js library to interact with Discord and fetches server stats via the XML 1. Clone the repository to your server 2. Locate the configuration files: - - Use either - - `config.example-de.json` (for German) + - Use either + - `config.example-de.json` (for German) - `config.example-en.json` (for English) - Rename the chosen file to `config.json`. 3. Open `config.json` and fill in the required fields: @@ -72,21 +72,27 @@ discord.js library to interact with Discord and fetches server stats via the XML 1. Navigate to the root directory of the cloned repository. 2. Build and start the container: + ```bash docker-compose up -d --build ``` + 3. The bot should now be running and posting server stats to the specified Discord channel. ### Option 2: Run Without Docker (Using Node.js) 1. Navigate to the root directory of the cloned repository. 2. Install dependencies: + ```bash npm install ``` + 3. Start the bot: + ```bash npm start ``` + 4. The bot should now be running and posting server stats to the specified Discord channel. - Note: Closing the terminal will stop the bot. Use a process manager like [PM2](https://pm2.io/) to keep it running. diff --git a/misc/images/bot_terminal.png b/misc/images/readme/bot_terminal.png similarity index 100% rename from misc/images/bot_terminal.png rename to misc/images/readme/bot_terminal.png diff --git a/misc/images/discord_de.png b/misc/images/readme/discord_de.png similarity index 100% rename from misc/images/discord_de.png rename to misc/images/readme/discord_de.png diff --git a/misc/images/discord_en.png b/misc/images/readme/discord_en.png similarity index 100% rename from misc/images/discord_en.png rename to misc/images/readme/discord_en.png diff --git a/misc/images/socials/GitHub Repository Header.afphoto b/misc/images/socials/GitHub Repository Header.afphoto new file mode 100644 index 0000000..098ff9b Binary files /dev/null and b/misc/images/socials/GitHub Repository Header.afphoto differ diff --git a/misc/images/socials/GitHub Repository Header.png b/misc/images/socials/GitHub Repository Header.png new file mode 100644 index 0000000..575fe37 Binary files /dev/null and b/misc/images/socials/GitHub Repository Header.png differ