goofball222 / factorio

Factorio headless server Docker container
Apache License 2.0
47 stars 14 forks source link

Adding more instructions to the README.md and a structure to the examples/ directory. #35

Closed nathan-hello closed 10 months ago

nathan-hello commented 1 year ago

This is my first PR, so sorry if my commit messages or whatever aren't proper.

Changes proposed in this pull request:

Here, I've made some changes to the README.md. I appreciate the work that got put into making this docker image, and I had to figure out how to use it without too much docker experience. This took me a couple hours, so I wrote a little guide in the readme, targeted at people who don't know as much about docker. It's a step-by-step guide on how to upload your save/scenario, mods, and config files to the image. I'm happy with how it turned out, and if this were here when I started trying to use this image, it would have saved a lot of time.

Also, in the examples folder, I added all of the config files someone might want to change, because for some reason that's somewhat difficult to get your hands on. I understand that these files are subject to change, but after a couple years since 1.0 release, I think it's safe to put as a reference.

I'd be open to better wording, especially because I didn't touch on much of the environment variable stuff (honestly, it's a little over my head what these things do, including RCON).

But really, I think the readme after this change is a lot more legible and it would help someone who might be considering self-hosting but doesn't quite understand the mechanics of docker or docker-compose.

@goofball222