Skip to content

Commit a287967

Browse files
committed
Updated the README and uploaded the social banner for this repository (Affinity Photo)
1 parent 58451f6 commit a287967

File tree

6 files changed

+14
-8
lines changed

6 files changed

+14
-8
lines changed

README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
11
# Farming Simulator 25 - Discord Bot
22

3-
This bot periodically updates a Discord channel with stats from a Farming Simulator 25 server.
4-
It posts the server name, password, time, and player count. Written in Node.js, it uses the
5-
discord.js library to interact with Discord and fetches server stats via the XML feed
3+
This bot periodically updates a Discord channel with stats from a Farming Simulator 25 server.
4+
It posts the server name, password, time, and player count. Written in Node.js, it uses the
5+
discord.js library to interact with Discord and fetches server stats via the XML feed
66
(accessible through the server's web interface). The update interval is configurable.
77

88
## Screenshots
99

1010
<details>
1111
<summary>Discord embed in english</summary>
1212

13-
![discord_en.png](misc%2Fimages%2Fdiscord_en.png)
13+
![discord_en.png](misc%2Fimages%2Freadme%2Fdiscord_en.png)
1414

1515
</details>
1616

1717
<details>
1818
<summary>Discord embed in german</summary>
1919

20-
![discord_de.png](misc%2Fimages%2Fdiscord_de.png)
20+
![discord_de.png](misc%2Fimages%2Freadme%2Fdiscord_de.png)
2121

2222
</details>
2323

2424
<details>
2525
<summary>Terminal output (NodeJS)</summary>
2626

27-
![bot_terminal.png](misc%2Fimages%2Fbot_terminal.png)
27+
![bot_terminal.png](misc%2Fimages%2Freadme%2Fbot_terminal.png)
2828

2929
</details>
3030

@@ -56,8 +56,8 @@ discord.js library to interact with Discord and fetches server stats via the XML
5656

5757
1. Clone the repository to your server
5858
2. Locate the configuration files:
59-
- Use either
60-
- `config.example-de.json` (for German)
59+
- Use either
60+
- `config.example-de.json` (for German)
6161
- `config.example-en.json` (for English)
6262
- Rename the chosen file to `config.json`.
6363
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
7272

7373
1. Navigate to the root directory of the cloned repository.
7474
2. Build and start the container:
75+
7576
```bash
7677
docker-compose up -d --build
7778
```
79+
7880
3. The bot should now be running and posting server stats to the specified Discord channel.
7981

8082
### Option 2: Run Without Docker (Using Node.js)
8183

8284
1. Navigate to the root directory of the cloned repository.
8385
2. Install dependencies:
86+
8487
```bash
8588
npm install
8689
```
90+
8791
3. Start the bot:
92+
8893
```bash
8994
npm start
9095
```
96+
9197
4. The bot should now be running and posting server stats to the specified Discord channel.
9298
- Note: Closing the terminal will stop the bot. Use a process manager like [PM2](https://pm2.io/) to keep it running.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Binary file not shown.
Loading

0 commit comments

Comments
 (0)