diff --git a/docs/en/README.md b/docs/en/README.md index 4541297..bf810df 100644 --- a/docs/en/README.md +++ b/docs/en/README.md @@ -40,6 +40,7 @@ This container has also been tested and will work on both `x64` and `ARM64` base ## Official URL - [Longvinter](https://www.longvinter.com/) + - [Wiki](https://wiki.longvinter.com) - [X(Twitter)](https://twitter.com/longvinter) - [Reddit](https://www.reddit.com/r/Longvinter/) - [TicTok](https://www.tiktok.com/@longvinter) @@ -87,14 +88,11 @@ services: max-file: "3" ports: - "7777:7777/udp" - - "27016:27016/tcp" - - "27016:27016/udp" environment: TZ: "UTC" PUID: 1000 PGID: 1000 PORT: 7777 # Optional but recommended - QUERY_PORT: 27016 # Optional but recommended CFG_SERVER_NAME: "Unnamed Island" CFG_MAX_PLAYERS: 32 CFG_SERVER_MOTD: "Welcome to Longvinter Island!" @@ -129,8 +127,6 @@ services: max-file: "3" ports: - "7777:7777/udp" - - "27016:27016/tcp" - - "27016:27016/udp" env_file: - .env volumes: @@ -145,14 +141,11 @@ You can also use the command `docker run` instead of `docker compose`. the serve docker run -d \ --name longvinter-server \ -p 7777:7777/udp \ - -p 27016:27016/tcp \ - -p 27016:27016/udp \ -v ./data:/data/ \ -e TZ="UTC" \ -e PUID=1000 \ -e PGID=1000 \ -e PORT=7777 \ - -e QUERY_PORT=27016 \ -e CFG_SERVER_NAME="Unnamed Island" \ -e CFG_MAX_PLAYERS=32 \ -e CFG_SERVER_MOTD="Welcome to Longvinter Island!" \ @@ -178,8 +171,6 @@ Change your docker run command to this: docker run -d \ --name longvinter-server \ -p 7777:7777/udp \ - -p 27016:27016/tcp \ - -p 27016:27016/udp \ -v ./data:/data/ \ --env-file .env \ --restart unless-stopped \ @@ -238,12 +229,11 @@ It is highly recommended you set the following environment values before startin | PUID\* | The uid of the user the server should run as. | 1000 | !0 | 0.1.0 | | PGID\* | The gid of the user the server should run as. | 1000 | !0 | 0.1.0 | | PORT\* | Game port that the server will expose. | 7777 | 1024-65535 | 0.1.0 | -| QUERY_PORT | Query port used to communicate with Steam servers. | 27016 | 1024-65535 | 0.1.0 | | UPDATE_ON_BOOT\*\* | Update the server when the docker container starts. | true | true/false | 0.1.0 | | BACKUP_ENABLED | Enables automatic backups. | true | true/false | 0.1.1 | | BACKUP_CRON_EXPRESSION | Setting affects frequency of automatic backups. | 0 0 \* \* \* | Needs a Cron-Expression - See [Configuring Automatic Backups with Cron](#configuring-automatic-backups-with-cron) | 0.1.1 | | DELETE_OLD_BACKUPS | Delete backups after a certain number of days. | false | true/false | 0.1.1 | -| OLD_BACKUP_DAYS | How many days to keep backups. | 30 | any positive integer | 0.1.1 | +| OLD_BACKUP_DAYS | How many days to keep backups. | 30 | !0 | 0.1.1 | | AUTO_UPDATE_ENABLED | Enables automatic updates. | false | true/false | 0.1.4 | | AUTO_UPDATE_CRON_EXPRESSION | Setting affects frequency of automatic updates. | 0 \* \* \* \* | Needs a Cron-Expression - See [Configuring Automatic Updates with Cron](#configuring-automatic-updates-with-cron) | 0.1.4 | | AUTO_UPDATE_WARN_MINUTES | How long to wait to saved and update the server, after the player were informed. (This will be ignored, if no Players are connected) | 15 | !0 | 0.1.4 | @@ -357,10 +347,9 @@ For the Box64 configurations, please see the their official documentation for mo ### Game Ports -| Port | Info | -|-------|----------------------| -| 7777 | Game Port (TCP/UDP) | -| 27016 | Query Port (TCP/UDP) | +| Port | Info | +|------|-----------------| +| 7777 | Game Port (UDP) | ## Broadcast @@ -520,21 +509,31 @@ This is affected by the environment variable TZ value and the default is set to Used with [environment variables](#environment-variables). -| Variable | Info | Default Value | Allowed Values | -|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|------------------------------------------------------------------| -| CFG_SERVER_NAME | Setting the server name that is displayed in the server list. | Unnamed Island | "string" | -| CFG_MAX_PLAYERS | The maximum amount of players the server will allow at the same time. | 32 | 1-? | -| CFG_SERVER_MOTD | A Message Of The Day that will be displayed to the player. | Welcome to Longvinter Island! | "string" | -| CFG_PASSWORD | Use this setting to require a password to join the server. | _(empty)_ | "string" | -| CFG_COMMUNITY_WEBSITE | When the server or community has a website, enter it here to display it to the player. | www\.longvinter\.com | `example.com`, `http://example.com`, `https://example.com/path` | -| CFG_COOP_PLAY | When this setting is set to "true", Co-op Play will be enabled on the server. Set to "false" to disable PvP. | false | true/false | -| CFG_COOP_SPAWN | All players will spawn here. (It only works when "CFG_COOP_PLAY" is "true".) | 0 | 0(West), 1(South), 2(East). (I haven't checked it out) | -| CFG_SERVER_TAG | Server tag that can be used to search for the server. | None | "string" | -| CFG_SERVER_REGION | Display server in a list of specified country in the Unofficial Server List | _(empty)_ | AS, NA, SA, EU, OC, AF, AN or nothing | -| CFG_ADMIN_STEAM_ID | Add the SteamID64 values for the players that have admin rights to this setting. When there are multiple admins, add the SteamID64 values to this setting separated by a space. | _(empty)_ | 0-9, a-f, " "(Space) | -| CFG_ENABLE_PVP | When this setting is set to "true", PvP will be enabled on the server. Set to "false" to disable PvP. | true | true/false | -| CFG_TENT_DECAY | When this setting is set to "true", tents will decay and be destroyed after 48 hours unless they are upgraded to a house. | true | true/false | -| CFG_MAX_TENTS | Maximum number of tents/houses each player can have placed in the world at a time. | 2 | 1~? | +| Variable | Info | Default Value | Allowed Values | +|------------------------------------|---------------------------------------------------------------------------------------|-------------------------------|------------------------------------------------------------------| +| CFG_SERVER_NAME | Sets the name that appears in the server browser. | Unnamed Island | "string" | +| CFG_SERVER_MOTD | Sets the Message of the Day displayed on signs around the island. | Welcome to Longvinter Island! | "string" | +| CFG_MAX_PLAYERS | Sets the maximum number of players that can connect simultaneously. | 32 | 1~ | +| CFG_PASSWORD | Sets a password for the server. | _(empty)_ | "string" | +| CFG_COMMUNITY_WEBSITE | Promotes a website, displayed with the server message and openable in-game. | www\.longvinter\.com | `example.com`, `http://example.com`, `https://example.com/path` | +| CFG_SERVER_TAG | Adds a tag for easier server searching. | None | "string" | +| CFG_COOP_PLAY | Enables or disables cooperative play mode(CFG_ENABLE_PVP must be set to false) | false | true/false | +| CFG_COOP_SPAWN | Sets the cooperative spawn point on the island. | 0 | 0(West), 1(South), 2(East). (I haven't checked it out) | +| CFG_CHECK_VPN | Enables or disables VPN checking for connecting players. | true | true/false | +| CFG_CHEST_RESPAWN_TIME | Sets the maximum respawn time (in seconds) for loot chests. | 600 | ?~ | +| CFG_DISABLE_WANDERING_TRADERS | Disables wandering traders from spawning | false | true/false | +| CFG_SERVER_REGION | Display server in a list of specified country in the server browser | _(empty)_ | AS, NA, SA, EU, OC, AF, AN or nothing | +| CFG_ADMIN_STEAM_ID | Assigns admin privileges to specified EOS IDs. You can get EOS ID from game settings. | _(empty)_ | 0-9, a-f, " "(Space) | +| CFG_ENABLE_PVP | Enables or disables Player versus Player combat. | true | true/false | +| CFG_TENT_DECAY | Enables or disables tent decay to manage abandoned tents. | true | true/false | +| CFG_MAX_TENTS | Sets the maximum number of tents players can place on the server. | 2 | 1~ | +| CFG_HARDCORE | Enables or disables Hardcore mode | false | true/false | +| CFG_MONEY_DROP_MULTIPLIER\* | Sets MK drop multiplier on death | 0.0 | 0.0~1.0 | +| CFG_WEAPON_DAMAGE_MULTIPLIER\* | Sets weapon damage multiplier | 1.0 | 0.0~ | +| CFG_ENERGY_DRAIN_MULTIPLIER\* | Sets energy drain multiplier | 1.0 | 0.0~ | +| CFG_PRICE_FLUCTUATION_MULTIPLIER\* | Sets Items price fluctuation multiplier | 1.0 | 0.0~ | + +\* Applies only in hardcore mode ### Manually @@ -542,6 +541,8 @@ When the server starts, a `Game.ini` file will be created in the following locat By default, the `Game.ini` file consists of the [this environment variables](#with-environment-variables), but if the DISABLE_GENERATE_SETTINGS value is set to 'true', the file can be modified and set directly. +See [Official Wiki](https://wiki.longvinter.com/server/configuration#server-configuration) + > [!IMPORTANT] > Changes can only be made to `Game.ini` while the server is off. > diff --git a/docs/kr/README.md b/docs/kr/README.md index 35639cf..74cdad4 100644 --- a/docs/kr/README.md +++ b/docs/kr/README.md @@ -34,12 +34,13 @@ > 현재 롱빈터에서 RCON을 지원하지 않기 때문에 관련된 모든 기능이 교체 및 제거되었습니다. > > 따라서 서버를 저장하지 않은 채로 서버 종료, 복구 등의 작업을 진행할 경우 -> 최대 12분동안 플레이한 내역이 롤백될 수 있음을 알려드립니다. -> (10~12분마다 자동 저장됩니다.) +> 약 5분동안 플레이한 내역이 롤백될 수 있음을 알려드립니다. +> (약 5분마다 자동 저장됩니다.) ## 공식 사이트 및 커뮤니티 - [롱빈터](https://www.longvinter.com/) + - [위키](https://wiki.longvinter.com) - [X(트위터)](https://twitter.com/longvinter) - [레딧](https://www.reddit.com/r/Longvinter/) - [틱톡](https://www.tiktok.com/@longvinter) @@ -59,7 +60,7 @@ > - OS(운영체제): 최소 64비트 > - RAM(램): 최소 2GB -출처: +출처: ## 사용법 @@ -87,14 +88,11 @@ services: max-file: "3" ports: - "7777:7777/udp" - - "27016:27016/tcp" - - "27016:27016/udp" environment: TZ: "Asia/Seoul" PUID: 1000 PGID: 1000 PORT: 7777 # Optional but recommended - QUERY_PORT: 27016 # Optional but recommended CFG_SERVER_NAME: "Unnamed Island" CFG_MAX_PLAYERS: 32 CFG_SERVER_MOTD: "Welcome to Longvinter Island!" @@ -129,8 +127,6 @@ services: max-file: "3" ports: - "7777:7777/udp" - - "27016:27016/tcp" - - "27016:27016/udp" env_file: - .env volumes: @@ -145,14 +141,11 @@ services: docker run -d \ --name longvinter-server \ -p 7777:7777/udp \ - -p 27016:27016/tcp \ - -p 27016:27016/udp \ -v ./data:/data/ \ -e TZ="Asia/Seoul" \ -e PUID=1000 \ -e PGID=1000 \ -e PORT=7777 \ - -e QUERY_PORT=27016 \ -e CFG_SERVER_NAME="Unnamed Island" \ -e CFG_MAX_PLAYERS=32 \ -e CFG_SERVER_MOTD="Welcome to Longvinter Island!" \ @@ -178,8 +171,6 @@ docker run -d \ docker run -d \ --name longvinter-server \ -p 7777:7777/udp \ - -p 27016:27016/tcp \ - -p 27016:27016/udp \ -v ./data:/data/ \ --env-file .env \ --restart unless-stopped \ @@ -238,7 +229,6 @@ docker rmi $(docker images | grep -E ^"(ghcr.io\/)?kimzuni/longvinter-docker-ser | PUID\* | 지정한 값을 가진 UID로 서버 실행 | 1000 | !0 | 0.1.0 | | PGID\* | 지정한 값을 가진 GID로 서버 실행 | 1000 | !0 | 0.1.0 | | PORT\* | 서버 게임 포트 번호 | 7777 | 1024-65535 | 0.1.0 | -| QUERY_PORT | 스팀 서버와 통신하기 위한 쿼리 포트 번호 | 27016 | 1024-65535 | 0.1.0 | | UPDATE_ON_BOOT\*\* | 서버 시작 시 자동으로 서버 업데이트 진행 | true | true/false | 0.1.0 | | BACKUP_ENABLED | 자동 백업 할성화 | true | true/false | 0.1.1 | | BACKUP_CRON_EXPRESSION | 자동 백업 빈도 설정 | 0 0 \* \* \* | 크론식 표현 - [Cron으로 자동 백업 설정하는 방법](#cron으로-자동-백업-설정하는-방법) 참고 바람 | 0.1.1 | @@ -357,10 +347,9 @@ Box64 구성에 대한 자세한 내용은 해당 공식 문서를 참조해 주 ### 게임 포트 -| 포트 | 설명 | -|-------|-------------------| -| 7777 | 게입 포트 (TCP/UDP) | -| 27016 | 쿼리 포트 (TCP/UDP) | +| 포트 | 설명 | +|------|---------------| +| 7777 | 게입 포트 (UDP) | ## 브로드캐스트 @@ -520,21 +509,31 @@ AUTO_REBOOT_CRON_EXPRESSION는 크론식으로, 작업을 실행할 시간 또 [환경 변수](#환경-변수)와 함께 사용되는 설정입니다. -| 변수 | 설명 | 기본값 | 설정 가능한 값 | -|-----------------------|--------------------------------------------------------------------------------|-------------------------------|-----------------------------------------------------------------| -| CFG_SERVER_NAME | 비공식 서버 목록에 표시되는 서버명 | Unnamed Island | "string" | -| CFG_MAX_PLAYERS | 동시 접속 최대 인원 | 32 | 1-? | -| CFG_SERVER_MOTD | 플레이어가 스폰되는 항구 앞 표지판에 표시되는 오늘의 메시지(Message of the Day) | Welcome to Longvinter Island! | "string" | -| CFG_PASSWORD | 서버 접속을 위한 비밀번호 | _(empty)_ | "string" | -| CFG_COMMUNITY_WEBSITE | 게임 내 서버 정보에 표시되는 커뮤니티 및 웹사이트 URL | www\.longvinter\.com | `example.com`, `http://example.com`, `https://example.com/path` | -| CFG_COOP_PLAY | 협동 플레이 여부 (PvP를 활성화한 경우 이 설정은 무시) | false | true/false | -| CFG_COOP_SPAWN | 협동 플레이 활성화 시 스폰 장소 지정 (모두 같은 곳에서 스폰) | 0 | 0(West), 1(South), 2(East). (확인 필요) | -| CFG_SERVER_TAG | 서버 검색에 사용되는 태그 | none | "string" | -| CFG_SERVER_REGION | 비공식 서버 목록 내 지정한 국가 목록에 서버 표시 | _(empty)_ | AS, NA, SA, EU, OC, AF, AN or nothing | -| CFG_ADMIN_STEAM_ID | 해당 EOSID(SteamID64) 값을 가진 플레이어를 관리자로 설정 (공백으로 구분하여 여러명 설정 가능) | _(empty)_ | 0-9, a-f, " "(Space) | -| CFG_ENABLE_PVP | PvP 활성화 여부 | true | true/false | -| CFG_TENT_DECAY | 텐트 자동 철거 활성화 여부 | true | true/false | -| CFG_MAX_TENTS | 플레이어당 최대로 설치할 수 있는 텐트 및 집의 개수 설정 | 2 | 1~? | +| 변수 | 설명 | 기본값 | 설정 가능한 값 | +|------------------------------------|-----------------------------------------------------------|-------------------------------|-----------------------------------------------------------------| +| CFG_SERVER_NAME | 비공식 서버 목록에 표시할 이름 설정 | Unnamed Island | "string" | +| CFG_SERVER_MOTD | 섬 곳곳의 표지판에 표시되는 오늘의 메시지 설정 | Welcome to Longvinter Island! | "string" | +| CFG_MAX_PLAYERS | 동시에 접속할 수 있는 최대 플레이어 수 설정 | 32 | 1~ | +| CFG_PASSWORD | 서버 비밀번호 설정 | _(empty)_ | "string" | +| CFG_COMMUNITY_WEBSITE | 서버 목록 및 게임 내에서 표시되는 URL | www\.longvinter\.com | `example.com`, `http://example.com`, `https://example.com/path` | +| CFG_SERVER_TAG | 서버 검색을 위한 태그 추가 | none | "string" | +| CFG_COOP_PLAY | 협동 플레이 활성화 (CFG_ENABLE_PVP가 false로 설정되어 있어야 함) | false | true/false | +| CFG_COOP_SPAWN | 협동 플레이 스폰 지점 설정 | 0 | 0(West), 1(South), 2(East). (확인 필요) | +| CFG_CHECK_VPN | VPN 연결 차단 | true | true/false | +| CFG_CHEST_RESPAWN_TIME | 전리품 상자의 최대 리스폰 시간(초) 설정 | 600 | ?~ | +| CFG_DISABLE_WANDERING_TRADERS | 떠돌이 상인 스폰 비활성화 | false | true/false | +| CFG_SERVER_REGION | 서버 브라우저 내 지정한 국가 목록에 서버 표시 | _(empty)_ | AS, NA, SA, EU, OC, AF, AN or nothing | +| CFG_ADMIN_STEAM_ID | 해당 EOSID 값을 가진 플레이어를 관리자로 설정 (인게임에서 확인 가능) | _(empty)_ | 0-9, a-f, " "(Space) | +| CFG_ENABLE_PVP | PvP 활성화 | true | true/false | +| CFG_TENT_DECAY | 텐트 자동 철거 활성화 | true | true/false | +| CFG_MAX_TENTS | 플레이어가 서버에 설치할 수 있는 최대 텐트 수 설정 | 2 | 1~ | +| CFG_HARDCORE | 하드코어 모드 활성화 | false | true/false | +| CFG_MONEY_DROP_MULTIPLIER\* | 사망 시 MK 드랍률 | 0.0 | 0.0~1.0 | +| CFG_WEAPON_DAMAGE_MULTIPLIER\* | 무기 데미지 비율 | 1.0 | 0.0~ | +| CFG_ENERGY_DRAIN_MULTIPLIER\* | 에너지 소비율 | 1.0 | 0.0~ | +| CFG_PRICE_FLUCTUATION_MULTIPLIER\* | 아이템 가격 변동률 | 1.0 | 0.0~ | + +\* 하드코어 모드에서만 적용됨 ### 수동 설정 diff --git a/scripts/variables.sh b/scripts/variables.sh index 93f8d3f..592d1ae 100644 --- a/scripts/variables.sh +++ b/scripts/variables.sh @@ -20,7 +20,6 @@ export ARCHITECTURE PAGESIZE export PORT=${PORT:-7777} -export QUERY_PORT=${QUERY_PORT:-27016} export CFG_SERVER_NAME=${CFG_SERVER_NAME:-"Unnamed Island"} export CFG_SERVER_MOTD=${CFG_SERVER_MOTD:-"Welcome to Longvinter Island!"} @@ -40,7 +39,7 @@ export CFG_ENABLE_PVP=${CFG_ENABLE_PVP:-true} export CFG_TENT_DECAY=${CFG_TENT_DECAY:-true} export CFG_MAX_TENTS=${CFG_MAX_TENTS:-2} export CFG_RESTART_TIME_24H=${CFG_RESTART_TIME_24H} -export FCG_SAVE_BACKUPS=${FCG_SAVE_BACKUPS:-false} +export CFG_SAVE_BACKUPS=${CFG_SAVE_BACKUPS:-false} export CFG_HARDCORE=${CFG_HARDCORE:-false} export CFG_MONEY_DROP_MULTIPLIER=${CFG_MONEY_DROP_MULTIPLIER:-"0.0"} export CFG_WEAPON_DAMAGE_MULTIPLIER=${CFG_WEAPON_DAMAGE_MULTIPLIER:-"1.0"}