Skip to content

Commit 73c1c80

Browse files
committed
Fix README formatting
1 parent d84302a commit 73c1c80

File tree

1 file changed

+7
-16
lines changed

1 file changed

+7
-16
lines changed

README.md

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,26 +9,20 @@ This is a Dockerized version of the [Satisfactory](https://store.steampowered.co
99

1010
## Setup
1111

12-
According to [the official
13-
wiki](https://satisfactory.fandom.com/wiki/Dedicated_servers), expect to
14-
need 12GB - 16GB of RAM.
12+
According to [the official wiki](https://satisfactory.fandom.com/wiki/Dedicated_servers), expect to need 12GB - 16GB of RAM.
1513

1614
You'll need to bind a local directory to the Docker container's `/config` directory. This directory will hold the following directories:
1715

1816
- `/backups` - the server will automatically backup your saves when the container first starts
19-
- `/gamefiles` - this is for the game's files. They're stored outside of the container to avoid needing to redownload 8GB+ every time you want to rebuild
20-
the container
17+
- `/gamefiles` - this is for the game's files. They're stored outside of the container to avoid needing to redownload 8GB+ every time you want to rebuild the container
2118
- `/saved` - this contains the game's blueprints, saves, and server configuration
2219

23-
Before running the server image, you should find your user ID that will be running the container. This isn't necessary in most cases, but it's good to find
24-
out regardless. If you're seeing `permission denied` errors, then this is probably why. Find your ID in `Linux` by running the `id` command. Then grab the
25-
user ID (usually something like `1000`) and pass it into the `-e PGID=1000` and `-e PUID=1000` environment variables.
20+
Before running the server image, you should find your user ID that will be running the container. This isn't necessary in most cases, but it's good to find out regardless. If you're seeing `permission denied` errors, then this is probably why. Find your ID in `Linux` by running the `id` command. Then grab the user ID (usually something like `1000`) and pass it into the `-e PGID=1000` and `-e PUID=1000` environment variables.
2621

2722
Run the Satisfactory server image like this:
2823

2924
```bash
30-
docker run -d --name=satisfactory-server -h satisfactory-server -e MAXPLAYERS=4 -e PGID=1000 -e PUID=1000 -e STEAMBETA=false -v /path/to/config:/config -m 16G
31-
--memory-reservation=12G -p 7777:7777/udp -p 15000:15000/udp -p 15777:15777/udp wolveix/satisfactory-server:latest
25+
docker run -d --name=satisfactory-server -h satisfactory-server -e MAXPLAYERS=4 -e PGID=1000 -e PUID=1000 -e STEAMBETA=false -v /path/to/config:/config -m 16G --memory-reservation=12G -p 7777:7777/udp -p 15000:15000/udp -p 15777:15777/udp wolveix/satisfactory-server:latest
3226
```
3327

3428
### Docker Compose
@@ -142,8 +136,7 @@ If you want to run a server for the Experimental version of the game, set the `S
142136

143137
## How to Improve the Multiplayer Experience
144138

145-
The [Satisfactory Wiki](https://satisfactory.fandom.com/wiki/Multiplayer#Engine.ini) recommends a few config tweaks to really get the best out of multiplayer.
146-
These changes are already applied to the server, but they need to be applied to your local config too:
139+
The [Satisfactory Wiki](https://satisfactory.fandom.com/wiki/Multiplayer#Engine.ini) recommends a few config tweaks to really get the best out of multiplayer. These changes are already applied to the server, but they need to be applied to your local config too:
147140

148141
- Press `WIN + R`
149142
- Enter `%localappdata%/FactoryGame/Saved/Config/WindowsNoEditor`
@@ -153,7 +146,5 @@ These changes are already applied to the server, but they need to be applied to
153146

154147
## Known Issues
155148

156-
- The container is run as `root`. This is pretty common for Docker images, but is bad practice for security reasons. This change was made to address
157-
[permissions issues](https://github.com/wolveix/satisfactory-server/issues/44)
158-
- The server log will show various errors; most of which can be safely ignored. As long as the container continues to run and your log looks similar to the
159-
example log, the server should be functioning just fine: [example log](https://github.com/wolveix/satisfactory-server/blob/main/server.log)
149+
- The container is run as `root`. This is pretty common for Docker images, but is bad practice for security reasons. This change was made to address [permissions issues](https://github.com/wolveix/satisfactory-server/issues/44)
150+
- The server log will show various errors; most of which can be safely ignored. As long as the container continues to run and your log looks similar to the example log, the server should be functioning just fine: [example log](https://github.com/wolveix/satisfactory-server/blob/main/server.log)

0 commit comments

Comments
 (0)