rouhim/beammp-server

BeamMP服务器容器镜像

镜像概述

本项目提供了BeamMP游戏服务器的容器镜像，旨在解决现有BeamMP服务器容器镜像文档不足的问题，方便用户快速部署和管理BeamMP游戏服务器。该镜像支持Docker和Docker Compose部署，提供丰富的环境变量配置，并支持客户端/服务器模组扩展。

核心功能与特性

• 多版本支持：提供latest（稳定版）和prerelease（开发版）两个标签
• 多架构兼容：支持amd64和arm64架构
• 灵活配置：通过环境变量自定义服务器名称、玩家数量、地图等参数
• 模组支持：支持客户端模组（client-mods）和服务器模组（server-mods）
• 交互式控制台：可通过docker attach连接服务器控制台
• 安全保障：使用trivy进行安全防护
• 权限优化：提供模组文件夹权限配置建议，避免权限问题

使用场景与适用范围

适用于希望快速搭建BeamMP游戏服务器的个人玩家或小型社区，支持以下场景：

• 搭建私人服务器（不公开到服务器浏览器）
• 创建自定义地图和模组的专用服务器
• 管理玩家数量、车辆限制等服务器规则
• 需要频繁调整服务器配置的场景

使用方法

Docker快速启动

bash
docker run --name beammp-server \
           -p 30814:30814/tcp -p 30814:30814/udp \
           -e BEAMMP_NAME='我的第一个服务器' \
           -e BEAMMP_AUTH_KEY='<输入认证密钥>' \
           rouhim/beammp-server

若需与服务器控制台交互，在docker run命令中添加-it参数。

Docker Compose部署

1. 克隆仓库并查看docker-compose.yml（可选）

2. 复制环境变量示例文件并创建模组文件夹：

   bash
   cp .env.example .env 
   mkdir client-mods/ server-mods/
   chmod 777 client-mods/ server-mods/
   

   建议执行chmod命令避免权限问题，容器内用户与主机用户通常不同。

3. 编辑.env文件配置服务器参数（如服务器名称、玩家数量等）

4. 启动服务：

   bash
   docker compose pull && docker compose up -d
   

服务器交互

若服务器以 detached 模式（-d参数）运行，可通过以下命令连接到交互式控制台：

bash
docker attach <容器名称>

环境变量配置

认证密钥获取：需通过BeamMP仪表板获取（需***账号）。注意：网站提示的IP输入无关紧要，详细说明见官方文档。

客户端模组

基本说明

建议先阅读官方模组指南。模组可从BeamNG资源网站下载，将ZIP文件直接放入client-mods文件夹即可。

自定义地图

1. 将地图ZIP文件放入client-mods文件夹
2. 获取地图路径（如/levels/car_jump_arena/info.json）：

   shell
   unzip -l PATH/TO/MAP.zip \
     | grep 'levels/.*/info.json' \
     | awk '{split($0,a," "); print "/"a[4]}'
   

3. 在.env文件中设置：BEAMMP_MAP=/levels/[地图名]/info.json（例如BEAMMP_MAP=/levels/car_jump_arena/info.json）

模组自动更新

可使用工具https://github.com/RouHim/beammp-server-beiwagen%E8%87%AA%E5%8A%A8%E6%9B%B4%E6%96%B0%60client-mods%60%E6%96%87%E4%BB%B6%E5%A4%B9%E4%B8%AD%E7%9A%84%E6%A8%A1%E7%BB%84%E3%80%82

服务器模组

服务器模组可在BeamMP论坛获取，安装和配置方法见各模组说明。

自定义ServerConfig.toml

如需使用自定义配置文件，创建ServerConfig.toml（配置示例见官方文档），并通过卷挂载到容器：

Docker示例：

bash
docker run --name beammp-server \
           -p 30814:30814/tcp -p 30814:30814/udp \
           -v ./ServerConfig.toml:/beammp/ServerConfig.toml \
           rouhim/beammp-server

Docker Compose示例：

yaml
volumes:
  - ./ServerConfig.toml:/beammp/ServerConfig.toml

注意：环境变量（.env文件）会覆盖ServerConfig.toml中的值，若使用自定义配置文件，建议确保.env文件不存在。

权限提示：若出现权限错误，可执行chmod 777 ServerConfig.toml修复。

相关资源

• BeamMP服务器仓库：https://github.com/BeamMP/BeamMP-Server
• 官方服务器维护指南：[***]
• 官方服务器安装指南：[***]
• 项目灵感来源：https://github.com/mastamic-ian/BeamMP_docker
• 项目源码：https://github.com/RouHim/beammp-container-image
• Docker镜像地址：https://hub.docker.com/r/rouhim/beammp-server