factorio/README.md

# Factorio

## Introduction

This repository is a Docker Compose setup based on the work
from [factoriotools/factorio-docker](https://github.com/factoriotools/factorio-docker). Please consult their repository
for the full source and documentation.

[Factorio](https://www.factorio.com) is a game where you build and maintain factories. You will mine resources, research
technologies, build infrastructure, automate production, and fight enemies. Use your imagination to design your factory,
combine simple elements into ingenious structures, apply management skills to keep it working, and protect it from
creatures who don't really like you.

The game is stable and optimized for building massive factories. You can create your own maps, write mods in Lua, or
play with friends via multiplayer.

## Table of Contents

- [Introduction](#introduction)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [License](#license)

## Prerequisites

- **Docker**: Ensure Docker is installed and running on your system.
- **Docker Compose**: Docker Compose is required to orchestrate the container setup.

## Installation

1. Clone the repository:
    ```bash
    git clone https://git.van-hemmen.com/GuillaumeHemmen-DockerCompose-Infra/factorio.git
    cd factorio
    ```

2. Ensure that the data folder has the proper ownership (use sudo if needed):
    ```bash
    sudo chown 845:845 ./data
    ```

3. Run the server once:
    ```bash
    docker compose up
    ```

4. Stop the server:
    ```bash
    docker compose down
    ```

5. Customize the server via the `server-settings.json` file that appeared in the data folder.

## Usage

Start the Factorio service with Docker Compose:

```bash
docker compose up -d
```

## License

This project is licensed under the terms of the MIT license. See the [LICENSE](LICENSE) file for details.