From 8f464ca3bba532dc35bb41963e6958887d19aecc Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 13 Feb 2024 19:19:19 +0000 Subject: [PATCH] deploy: 59f7f69fe1c5feee4031afee7376d2b487f8cd15 --- 404.html | 2 +- advanced/kubernetes/index.html | 2 +- advanced/palworld-directory/index.html | 2 +- assets/js/7a181475.aaeb1e69.js | 1 + assets/js/7a181475.cc93f103.js | 1 - assets/js/8482a3f6.a5a9b831.js | 1 + assets/js/8482a3f6.a943e2dd.js | 1 - assets/js/8a6a27d2.b979a34c.js | 1 - assets/js/8a6a27d2.c2cc6629.js | 1 + ...f2afb.46d74570.js => 935f2afb.7f727e0d.js} | 2 +- assets/js/c3826a0d.6d2b5b24.js | 1 + assets/js/c3826a0d.b461f91c.js | 1 - assets/js/d506b4f4.b1c58929.js | 1 + assets/js/d506b4f4.efb31684.js | 1 - assets/js/e2835484.0d597990.js | 1 - assets/js/e2835484.87af890a.js | 1 + assets/js/runtime~main.062fb50f.js | 1 + assets/js/runtime~main.fde9c975.js | 1 - category/advanced/index.html | 2 +- category/backup/index.html | 2 +- category/configuration/index.html | 4 +-- category/discord-integration/index.html | 2 +- category/getting-started/index.html | 2 +- category/guides/index.html | 2 +- .../configuration/game-settings/index.html | 5 +-- .../configuration/server-commands/index.html | 2 +- .../configuration/server-settings/index.html | 6 ++-- guides/automatic-reboots/index.html | 10 +++--- guides/automatic-updates/index.html | 5 ++- guides/backup/automated-backup/index.html | 2 +- guides/backup/creating-backup/index.html | 2 +- guides/backup/restoring-backup/index.html | 2 +- guides/discord/discord-webhooks/index.html | 2 +- index.html | 36 +++++++++++-------- known-issues/index.html | 5 +-- search/index.html | 2 +- versions/index.html | 2 +- 37 files changed, 64 insertions(+), 53 deletions(-) create mode 100644 assets/js/7a181475.aaeb1e69.js delete mode 100644 assets/js/7a181475.cc93f103.js create mode 100644 assets/js/8482a3f6.a5a9b831.js delete mode 100644 assets/js/8482a3f6.a943e2dd.js delete mode 100644 assets/js/8a6a27d2.b979a34c.js create mode 100644 assets/js/8a6a27d2.c2cc6629.js rename assets/js/{935f2afb.46d74570.js => 935f2afb.7f727e0d.js} (59%) create mode 100644 assets/js/c3826a0d.6d2b5b24.js delete mode 100644 assets/js/c3826a0d.b461f91c.js create mode 100644 assets/js/d506b4f4.b1c58929.js delete mode 100644 assets/js/d506b4f4.efb31684.js delete mode 100644 assets/js/e2835484.0d597990.js create mode 100644 assets/js/e2835484.87af890a.js create mode 100644 assets/js/runtime~main.062fb50f.js delete mode 100644 assets/js/runtime~main.fde9c975.js diff --git a/404.html b/404.html index 5fb5370e5..cb773341d 100644 --- a/404.html +++ b/404.html @@ -10,7 +10,7 @@ - + diff --git a/advanced/kubernetes/index.html b/advanced/kubernetes/index.html index 6c76add8d..b860565fd 100644 --- a/advanced/kubernetes/index.html +++ b/advanced/kubernetes/index.html @@ -10,7 +10,7 @@ - + diff --git a/advanced/palworld-directory/index.html b/advanced/palworld-directory/index.html index 0fce20400..73e111714 100644 --- a/advanced/palworld-directory/index.html +++ b/advanced/palworld-directory/index.html @@ -10,7 +10,7 @@ - + diff --git a/assets/js/7a181475.aaeb1e69.js b/assets/js/7a181475.aaeb1e69.js new file mode 100644 index 000000000..106802915 --- /dev/null +++ b/assets/js/7a181475.aaeb1e69.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocusaurus=self.webpackChunkdocusaurus||[]).push([[160],{7588:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>d,toc:()=>c});var r=n(7624),s=n(2172);const i={sidebar_position:5},o="Automatic Updates",d={id:"guides/automatic-updates",title:"Automatic Updates",description:"Configuring Automatic Updates with Cron",source:"@site/docs/guides/automatic-updates.md",sourceDirName:"guides",slug:"/guides/automatic-updates",permalink:"/guides/automatic-updates",draft:!1,unlisted:!1,editUrl:"https://github.com/thijsvanloef/palworld-server-docker/tree/main/docusaurus/docs/guides/automatic-updates.md",tags:[],version:"current",sidebarPosition:5,frontMatter:{sidebar_position:5},sidebar:"tutorialSidebar",previous:{title:"Automatic Reboots",permalink:"/guides/automatic-reboots"},next:{title:"Advanced",permalink:"/category/advanced"}},a={},c=[{value:"Configuring Automatic Updates with Cron",id:"configuring-automatic-updates-with-cron",level:2}];function l(e){const t={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",li:"li",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,s.M)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"automatic-updates",children:"Automatic Updates"}),"\n",(0,r.jsx)(t.h2,{id:"configuring-automatic-updates-with-cron",children:"Configuring Automatic Updates with Cron"}),"\n",(0,r.jsxs)(t.p,{children:["To be able to use automatic Updates with this Server the following environment variables ",(0,r.jsx)(t.strong,{children:"have"})," to be set to ",(0,r.jsx)(t.code,{children:"true"}),":"]}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.code,{children:"RCON_ENABLED"})}),"\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.code,{children:"UPDATE_ON_BOOT"})}),"\n"]}),"\n",(0,r.jsxs)(t.admonition,{type:"warning",children:[(0,r.jsxs)(t.p,{children:["If docker restart is not set to policy ",(0,r.jsx)(t.code,{children:"always"})," or ",(0,r.jsx)(t.code,{children:"unless-stopped"}),"\nthen the server will shutdown and will need to be manually restarted."]}),(0,r.jsxs)(t.p,{children:["The example docker run command and docker compose file in ",(0,r.jsx)(t.a,{href:"https://palworld-server-docker.loef.dev/",children:"the Quicksetup"}),"\nalready use the needed policy"]})]}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Variable"}),(0,r.jsx)(t.th,{children:"Info"}),(0,r.jsx)(t.th,{children:"Default Values"}),(0,r.jsx)(t.th,{children:"Allowed Values"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"AUTO_UPDATE_CRON_EXPRESSION"}),(0,r.jsx)(t.td,{children:"Setting affects frequency of automatic updates."}),(0,r.jsx)(t.td,{children:"0 * * * *"}),(0,r.jsxs)(t.td,{children:["Needs a Cron-Expression - See ",(0,r.jsx)(t.a,{href:"https://palworld-server-docker.loef.dev/guides/backup/automated-backup",children:"Configuring Automatic Backups with Cron"})]})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"AUTO_UPDATE_ENABLED"}),(0,r.jsx)(t.td,{children:"Enables automatic updates"}),(0,r.jsx)(t.td,{children:"false"}),(0,r.jsx)(t.td,{children:"true/false"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"AUTO_UPDATE_WARN_MINUTES"}),(0,r.jsx)(t.td,{children:"How long to wait to update the server, after the player were informed. (This will be ignored, if no Players are connected)"}),(0,r.jsx)(t.td,{children:"30"}),(0,r.jsx)(t.td,{children:"!0"})]})]})]}),"\n",(0,r.jsx)(t.admonition,{type:"tip",children:(0,r.jsxs)(t.p,{children:["This image uses Supercronic for crons\nsee ",(0,r.jsx)(t.a,{href:"https://github.com/aptible/supercronic#crontab-format",children:"supercronic"}),"\nor ",(0,r.jsx)(t.a,{href:"https://crontab-generator.org",children:"Crontab Generator"}),"."]})}),"\n",(0,r.jsxs)(t.p,{children:["Set ",(0,r.jsx)(t.code,{children:"AUTO_UPDATE_CRON_EXPRESSION"})," to change the default schedule."]})]})}function u(e={}){const{wrapper:t}={...(0,s.M)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},2172:(e,t,n)=>{n.d(t,{I:()=>d,M:()=>o});var r=n(1504);const s={},i=r.createContext(s);function o(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function d(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7a181475.cc93f103.js b/assets/js/7a181475.cc93f103.js deleted file mode 100644 index 7f45e5f8a..000000000 --- a/assets/js/7a181475.cc93f103.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocusaurus=self.webpackChunkdocusaurus||[]).push([[160],{7588:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>l,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var o=n(7624),i=n(2172);const s={sidebar_position:5},r="Automatic Updates",a={id:"guides/automatic-updates",title:"Automatic Updates",description:"Configuring Automatic Updates with Cron",source:"@site/docs/guides/automatic-updates.md",sourceDirName:"guides",slug:"/guides/automatic-updates",permalink:"/guides/automatic-updates",draft:!1,unlisted:!1,editUrl:"https://github.com/thijsvanloef/palworld-server-docker/tree/main/docusaurus/docs/guides/automatic-updates.md",tags:[],version:"current",sidebarPosition:5,frontMatter:{sidebar_position:5},sidebar:"tutorialSidebar",previous:{title:"Automatic Reboots",permalink:"/guides/automatic-reboots"},next:{title:"Advanced",permalink:"/category/advanced"}},c={},d=[{value:"Configuring Automatic Updates with Cron",id:"configuring-automatic-updates-with-cron",level:2}];function u(e){const t={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",li:"li",p:"p",strong:"strong",ul:"ul",...(0,i.M)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.h1,{id:"automatic-updates",children:"Automatic Updates"}),"\n",(0,o.jsx)(t.h2,{id:"configuring-automatic-updates-with-cron",children:"Configuring Automatic Updates with Cron"}),"\n",(0,o.jsxs)(t.p,{children:["To be able to use automatic Updates with this Server the following environment variables ",(0,o.jsx)(t.strong,{children:"have"})," to be set to ",(0,o.jsx)(t.code,{children:"true"}),":"]}),"\n",(0,o.jsxs)(t.ul,{children:["\n",(0,o.jsx)(t.li,{children:(0,o.jsx)(t.code,{children:"RCON_ENABLED"})}),"\n",(0,o.jsx)(t.li,{children:(0,o.jsx)(t.code,{children:"UPDATE_ON_BOOT"})}),"\n"]}),"\n",(0,o.jsxs)(t.admonition,{type:"warning",children:[(0,o.jsxs)(t.p,{children:["If docker restart is not set to policy ",(0,o.jsx)(t.code,{children:"always"})," or ",(0,o.jsx)(t.code,{children:"unless-stopped"}),"\nthen the server will shutdown and will need to be manually restarted."]}),(0,o.jsxs)(t.p,{children:["The example docker run command and docker compose file in ",(0,o.jsx)(t.a,{href:"https://palworld-server-docker.loef.dev/",children:"the Quicksetup"}),"\nalready use the needed policy"]})]}),"\n",(0,o.jsxs)(t.p,{children:["Set ",(0,o.jsx)(t.code,{children:"AUTO_UPDATE_ENABLED"})," enable or disable automatic updates (Default is disabled)"]}),"\n",(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.code,{children:"AUTO_UPDATE_CRON_EXPRESSION"})," is a cron expression, in a Cron-Expression you define an interval for when to run jobs."]}),"\n",(0,o.jsx)(t.admonition,{type:"tip",children:(0,o.jsxs)(t.p,{children:["This image uses Supercronic for crons\nsee ",(0,o.jsx)(t.a,{href:"https://github.com/aptible/supercronic#crontab-format",children:"supercronic"}),"\nor ",(0,o.jsx)(t.a,{href:"https://crontab-generator.org",children:"Crontab Generator"}),"."]})}),"\n",(0,o.jsxs)(t.p,{children:["Set ",(0,o.jsx)(t.code,{children:"AUTO_UPDATE_CRON_EXPRESSION"})," to change the default schedule."]})]})}function l(e={}){const{wrapper:t}={...(0,i.M)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(u,{...e})}):u(e)}},2172:(e,t,n)=>{n.d(t,{I:()=>a,M:()=>r});var o=n(1504);const i={},s=o.createContext(i);function r(e){const t=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),o.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8482a3f6.a5a9b831.js b/assets/js/8482a3f6.a5a9b831.js new file mode 100644 index 000000000..23790ba46 --- /dev/null +++ b/assets/js/8482a3f6.a5a9b831.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocusaurus=self.webpackChunkdocusaurus||[]).push([[540],{8520:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>a,frontMatter:()=>d,metadata:()=>l,toc:()=>h});var s=r(7624),n=r(2172);const d={sidebar_position:1},i="Server Settings",l={id:"getting-started/configuration/server-settings",title:"Server Settings",description:"Changing Server Settings using environment variables.",source:"@site/docs/getting-started/configuration/server-settings.md",sourceDirName:"getting-started/configuration",slug:"/getting-started/configuration/server-settings",permalink:"/getting-started/configuration/server-settings",draft:!1,unlisted:!1,editUrl:"https://github.com/thijsvanloef/palworld-server-docker/tree/main/docusaurus/docs/getting-started/configuration/server-settings.md",tags:[],version:"current",sidebarPosition:1,frontMatter:{sidebar_position:1},sidebar:"tutorialSidebar",previous:{title:"Configuration",permalink:"/category/configuration"},next:{title:"Game Settings",permalink:"/getting-started/configuration/game-settings"}},c={},h=[{value:"Environment variables",id:"environment-variables",level:2},{value:"Game Ports",id:"game-ports",level:3}];function o(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",li:"li",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,n.M)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"server-settings",children:"Server Settings"}),"\n",(0,s.jsx)(t.p,{children:"Changing Server Settings using environment variables."}),"\n",(0,s.jsx)(t.h2,{id:"environment-variables",children:"Environment variables"}),"\n",(0,s.jsx)(t.p,{children:"You can use the following values to change the settings of the server on boot.\nIt is highly recommended you set the following environment values before starting the server:"}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsx)(t.li,{children:"PLAYERS"}),"\n",(0,s.jsx)(t.li,{children:"PORT"}),"\n",(0,s.jsx)(t.li,{children:"PUID"}),"\n",(0,s.jsx)(t.li,{children:"PGID"}),"\n"]}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"Variable"}),(0,s.jsx)(t.th,{children:"Info"}),(0,s.jsx)(t.th,{children:"Default Values"}),(0,s.jsx)(t.th,{children:"Allowed Values"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"TZ"}),(0,s.jsx)(t.td,{children:"Timezone used for time stamping backup server"}),(0,s.jsx)(t.td,{children:"UTC"}),(0,s.jsxs)(t.td,{children:["See ",(0,s.jsx)(t.a,{href:"https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#Time_Zone_abbreviations",children:"TZ Identifiers"})]})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"PLAYERS*"}),(0,s.jsx)(t.td,{children:"Max amount of players that are able to join the server"}),(0,s.jsx)(t.td,{children:"16"}),(0,s.jsx)(t.td,{children:"1-32"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"PORT*"}),(0,s.jsx)(t.td,{children:"UDP port that the server will expose"}),(0,s.jsx)(t.td,{children:"8211"}),(0,s.jsx)(t.td,{children:"1024-65535"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"PUID*"}),(0,s.jsx)(t.td,{children:"The uid of the user the server should run as"}),(0,s.jsx)(t.td,{children:"1000"}),(0,s.jsx)(t.td,{children:"!0"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"PGID*"}),(0,s.jsx)(t.td,{children:"The gid of the group the server should run as"}),(0,s.jsx)(t.td,{children:"1000"}),(0,s.jsx)(t.td,{children:"!0"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"MULTITHREADING**"}),(0,s.jsx)(t.td,{children:"Improves performance in multi-threaded CPU environments. It is effective up to a maximum of about 4 threads, and allocating more than this number of threads does not make much sense."}),(0,s.jsx)(t.td,{children:"false"}),(0,s.jsx)(t.td,{children:"true/false"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"COMMUNITY"}),(0,s.jsx)(t.td,{children:"Whether or not the server shows up in the community server browser (USE WITH SERVER_PASSWORD)"}),(0,s.jsx)(t.td,{children:"false"}),(0,s.jsx)(t.td,{children:"true/false"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"PUBLIC_IP"}),(0,s.jsx)(t.td,{children:"You can manually specify the global IP address of the network on which the server running. If not specified, it will be detected automatically. If it does not work well, try manual configuration."}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{children:"x.x.x.x"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"PUBLIC_PORT"}),(0,s.jsx)(t.td,{children:"You can manually specify the port number of the network on which the server running. If not specified, it will be detected automatically. If it does not work well, try manual configuration."}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{children:"1024-65535"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"SERVER_NAME"}),(0,s.jsx)(t.td,{children:"A name for your server"}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{children:'"string"'})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"SERVER_DESCRIPTION"}),(0,s.jsx)(t.td,{children:"Your server Description"}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{children:'"string"'})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"SERVER_PASSWORD"}),(0,s.jsx)(t.td,{children:"Secure your community server with a password"}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{children:'"string"'})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"ADMIN_PASSWORD"}),(0,s.jsx)(t.td,{children:"Secure administration access in the server with a password"}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{children:'"string"'})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"UPDATE_ON_BOOT**"}),(0,s.jsx)(t.td,{children:"Update/Install the server when the docker container starts (THIS HAS TO BE ENABLED THE FIRST TIME YOU RUN THE CONTAINER)"}),(0,s.jsx)(t.td,{children:"true"}),(0,s.jsx)(t.td,{children:"true/false"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"RCON_ENABLED***"}),(0,s.jsx)(t.td,{children:"Enable RCON for the Palworld server"}),(0,s.jsx)(t.td,{children:"true"}),(0,s.jsx)(t.td,{children:"true/false"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"RCON_PORT"}),(0,s.jsx)(t.td,{children:"RCON port to connect to"}),(0,s.jsx)(t.td,{children:"25575"}),(0,s.jsx)(t.td,{children:"1024-65535"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"QUERY_PORT"}),(0,s.jsx)(t.td,{children:"Query port used to communicate with Steam servers"}),(0,s.jsx)(t.td,{children:"27015"}),(0,s.jsx)(t.td,{children:"1024-65535"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"BACKUP_CRON_EXPRESSION"}),(0,s.jsx)(t.td,{children:"Setting affects frequency of automatic backups."}),(0,s.jsx)(t.td,{children:"0 0 * * *"}),(0,s.jsxs)(t.td,{children:["Needs a Cron-Expression - See ",(0,s.jsx)(t.a,{href:"https://palworld-server-docker.loef.dev/guides/backup/automated-backup",children:"Configuring Automatic Backups with Cron"})]})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"BACKUP_ENABLED"}),(0,s.jsx)(t.td,{children:"Enables automatic backups"}),(0,s.jsx)(t.td,{children:"true"}),(0,s.jsx)(t.td,{children:"true/false"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"DELETE_OLD_BACKUPS"}),(0,s.jsx)(t.td,{children:"Delete backups after a certain number of days"}),(0,s.jsx)(t.td,{children:"false"}),(0,s.jsx)(t.td,{children:"true/false"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"OLD_BACKUP_DAYS"}),(0,s.jsx)(t.td,{children:"How many days to keep backups"}),(0,s.jsx)(t.td,{children:"30"}),(0,s.jsx)(t.td,{children:"any positive integer"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"AUTO_UPDATE_CRON_EXPRESSION"}),(0,s.jsx)(t.td,{children:"Setting affects frequency of automatic updates."}),(0,s.jsx)(t.td,{children:"0 * * * *"}),(0,s.jsxs)(t.td,{children:["Needs a Cron-Expression - See ",(0,s.jsx)(t.a,{href:"https://palworld-server-docker.loef.dev/guides/automatic-reboots",children:"Configuring Automatic Updates with Cron"})]})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"AUTO_UPDATE_ENABLED"}),(0,s.jsx)(t.td,{children:"Enables automatic updates"}),(0,s.jsx)(t.td,{children:"false"}),(0,s.jsx)(t.td,{children:"true/false"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"AUTO_UPDATE_WARN_MINUTES"}),(0,s.jsx)(t.td,{children:"How long to wait to update the server, after the player were informed."}),(0,s.jsx)(t.td,{children:"30"}),(0,s.jsx)(t.td,{children:"!0"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"AUTO_REBOOT_CRON_EXPRESSION"}),(0,s.jsx)(t.td,{children:"Setting affects frequency of automatic updates."}),(0,s.jsx)(t.td,{children:"0 0 * * *"}),(0,s.jsxs)(t.td,{children:["Needs a Cron-Expression - See ",(0,s.jsx)(t.a,{href:"https://palworld-server-docker.loef.dev/guides/automatic-updates",children:"Configuring Automatic Reboots with Cron"})]})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"AUTO_REBOOT_ENABLED"}),(0,s.jsx)(t.td,{children:"Enables automatic reboots"}),(0,s.jsx)(t.td,{children:"false"}),(0,s.jsx)(t.td,{children:"true/false"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"AUTO_REBOOT_WARN_MINUTES"}),(0,s.jsx)(t.td,{children:"How long to wait to reboot the server, after the player were informed."}),(0,s.jsx)(t.td,{children:"5"}),(0,s.jsx)(t.td,{children:"!0"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"AUTO_REBOOT_EVEN_IF_PLAYERS_ONLINE"}),(0,s.jsx)(t.td,{children:"Restart the Server even if there are players online."}),(0,s.jsx)(t.td,{children:"false"}),(0,s.jsx)(t.td,{children:"true/false"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"DISCORD_WEBHOOK_URL"}),(0,s.jsx)(t.td,{children:"Discord webhook url found after creating a webhook on a discord server"}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.code,{children:"https://discord.com/api/webhooks/"})})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"DISCORD_CONNECT_TIMEOUT"}),(0,s.jsx)(t.td,{children:"Discord command initial connection timeout"}),(0,s.jsx)(t.td,{children:"30"}),(0,s.jsx)(t.td,{children:"!0"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"DISCORD_MAX_TIMEOUT"}),(0,s.jsx)(t.td,{children:"Discord total hook timeout"}),(0,s.jsx)(t.td,{children:"30"}),(0,s.jsx)(t.td,{children:"!0"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"DISCORD_PRE_UPDATE_BOOT_MESSAGE"}),(0,s.jsx)(t.td,{children:"Discord message sent when server begins updating"}),(0,s.jsx)(t.td,{children:"Server is updating..."}),(0,s.jsx)(t.td,{children:'"string"'})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"DISCORD_POST_UPDATE_BOOT_MESSAGE"}),(0,s.jsx)(t.td,{children:"Discord message sent when server completes updating"}),(0,s.jsx)(t.td,{children:"Server update complete!"}),(0,s.jsx)(t.td,{children:'"string"'})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"DISCORD_PRE_START_MESSAGE"}),(0,s.jsx)(t.td,{children:"Discord message sent when server begins to start"}),(0,s.jsx)(t.td,{children:"Server is started!"}),(0,s.jsx)(t.td,{children:'"string"'})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"DISCORD_PRE_SHUTDOWN_MESSAGE"}),(0,s.jsx)(t.td,{children:"Discord message sent when server begins to shutdown"}),(0,s.jsx)(t.td,{children:"Server is shutting down..."}),(0,s.jsx)(t.td,{children:'"string"'})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"DISCORD_POST_SHUTDOWN_MESSAGE"}),(0,s.jsx)(t.td,{children:"Discord message sent when server has stopped"}),(0,s.jsx)(t.td,{children:"Server is stopped!"}),(0,s.jsx)(t.td,{children:'"string"'})]})]})]}),"\n",(0,s.jsx)(t.p,{children:"*highly recommended to set"}),"\n",(0,s.jsx)(t.p,{children:"** Make sure you know what you are doing when running this option enabled"}),"\n",(0,s.jsx)(t.p,{children:"*** Required for docker stop to save and gracefully close the server"}),"\n",(0,s.jsx)(t.h3,{id:"game-ports",children:"Game Ports"}),"\n",(0,s.jsx)(t.p,{children:"The server needs the following ports by default."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"Port"}),(0,s.jsx)(t.th,{children:"Info"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"8211"}),(0,s.jsx)(t.td,{children:"Game Port (UDP)"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"27015"}),(0,s.jsx)(t.td,{children:"Query Port (UDP)"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"25575"}),(0,s.jsx)(t.td,{children:"RCON Port (TCP)"})]})]})]})]})}function a(e={}){const{wrapper:t}={...(0,n.M)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},2172:(e,t,r)=>{r.d(t,{I:()=>l,M:()=>i});var s=r(1504);const n={},d=s.createContext(n);function i(e){const t=s.useContext(d);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:i(e.components),s.createElement(d.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8482a3f6.a943e2dd.js b/assets/js/8482a3f6.a943e2dd.js deleted file mode 100644 index 717cb3c3b..000000000 --- a/assets/js/8482a3f6.a943e2dd.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocusaurus=self.webpackChunkdocusaurus||[]).push([[540],{8520:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>a,frontMatter:()=>n,metadata:()=>l,toc:()=>h});var s=r(7624),d=r(2172);const n={sidebar_position:1},i="Server Settings",l={id:"getting-started/configuration/server-settings",title:"Server Settings",description:"This part will explain how to configure the server.",source:"@site/docs/getting-started/configuration/server-settings.md",sourceDirName:"getting-started/configuration",slug:"/getting-started/configuration/server-settings",permalink:"/getting-started/configuration/server-settings",draft:!1,unlisted:!1,editUrl:"https://github.com/thijsvanloef/palworld-server-docker/tree/main/docusaurus/docs/getting-started/configuration/server-settings.md",tags:[],version:"current",sidebarPosition:1,frontMatter:{sidebar_position:1},sidebar:"tutorialSidebar",previous:{title:"Configuration",permalink:"/category/configuration"},next:{title:"Game Settings",permalink:"/getting-started/configuration/game-settings"}},c={},h=[{value:"Environment variables",id:"environment-variables",level:2},{value:"Game Ports",id:"game-ports",level:3}];function o(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",li:"li",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,d.M)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"server-settings",children:"Server Settings"}),"\n",(0,s.jsx)(t.p,{children:"This part will explain how to configure the server."}),"\n",(0,s.jsx)(t.h2,{id:"environment-variables",children:"Environment variables"}),"\n",(0,s.jsx)(t.p,{children:"You can use the following values to change the settings of the server on boot.\nIt is highly recommended you set the following environment values before starting the server:"}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsx)(t.li,{children:"PLAYERS"}),"\n",(0,s.jsx)(t.li,{children:"PORT"}),"\n",(0,s.jsx)(t.li,{children:"PUID"}),"\n",(0,s.jsx)(t.li,{children:"PGID"}),"\n"]}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"Variable"}),(0,s.jsx)(t.th,{children:"Info"}),(0,s.jsx)(t.th,{children:"Default Values"}),(0,s.jsx)(t.th,{children:"Allowed Values"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"TZ"}),(0,s.jsx)(t.td,{children:"Timezone used for time stamping backup server"}),(0,s.jsx)(t.td,{children:"UTC"}),(0,s.jsxs)(t.td,{children:["See ",(0,s.jsx)(t.a,{href:"https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#Time_Zone_abbreviations",children:"TZ Identifiers"})]})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"PLAYERS*"}),(0,s.jsx)(t.td,{children:"Max amount of players that are able to join the server"}),(0,s.jsx)(t.td,{children:"16"}),(0,s.jsx)(t.td,{children:"1-32"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"PORT*"}),(0,s.jsx)(t.td,{children:"UDP port that the server will expose"}),(0,s.jsx)(t.td,{children:"8211"}),(0,s.jsx)(t.td,{children:"1024-65535"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"PUID*"}),(0,s.jsx)(t.td,{children:"The uid of the user the server should run as"}),(0,s.jsx)(t.td,{children:"1000"}),(0,s.jsx)(t.td,{children:"!0"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"PGID*"}),(0,s.jsx)(t.td,{children:"The gid of the group the server should run as"}),(0,s.jsx)(t.td,{children:"1000"}),(0,s.jsx)(t.td,{children:"!0"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"MULTITHREADING**"}),(0,s.jsx)(t.td,{children:"Improves performance in multi-threaded CPU environments. It is effective up to a maximum of about 4 threads, and allocating more than this number of threads does not make much sense."}),(0,s.jsx)(t.td,{children:"false"}),(0,s.jsx)(t.td,{children:"true/false"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"COMMUNITY"}),(0,s.jsx)(t.td,{children:"Whether or not the server shows up in the community server browser (USE WITH SERVER_PASSWORD)"}),(0,s.jsx)(t.td,{children:"false"}),(0,s.jsx)(t.td,{children:"true/false"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"PUBLIC_IP"}),(0,s.jsx)(t.td,{children:"You can manually specify the global IP address of the network on which the server running. If not specified, it will be detected automatically. If it does not work well, try manual configuration."}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{children:"x.x.x.x"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"PUBLIC_PORT"}),(0,s.jsx)(t.td,{children:"You can manually specify the port number of the network on which the server running. If not specified, it will be detected automatically. If it does not work well, try manual configuration."}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{children:"1024-65535"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"SERVER_NAME"}),(0,s.jsx)(t.td,{children:"A name for your server"}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{children:'"string"'})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"SERVER_DESCRIPTION"}),(0,s.jsx)(t.td,{children:"Your server Description"}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{children:'"string"'})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"SERVER_PASSWORD"}),(0,s.jsx)(t.td,{children:"Secure your community server with a password"}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{children:'"string"'})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"ADMIN_PASSWORD"}),(0,s.jsx)(t.td,{children:"Secure administration access in the server with a password"}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{children:'"string"'})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"UPDATE_ON_BOOT**"}),(0,s.jsx)(t.td,{children:"Update/Install the server when the docker container starts (THIS HAS TO BE ENABLED THE FIRST TIME YOU RUN THE CONTAINER)"}),(0,s.jsx)(t.td,{children:"true"}),(0,s.jsx)(t.td,{children:"true/false"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"RCON_ENABLED***"}),(0,s.jsx)(t.td,{children:"Enable RCON for the Palworld server"}),(0,s.jsx)(t.td,{children:"true"}),(0,s.jsx)(t.td,{children:"true/false"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"RCON_PORT"}),(0,s.jsx)(t.td,{children:"RCON port to connect to"}),(0,s.jsx)(t.td,{children:"25575"}),(0,s.jsx)(t.td,{children:"1024-65535"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"QUERY_PORT"}),(0,s.jsx)(t.td,{children:"Query port used to communicate with Steam servers"}),(0,s.jsx)(t.td,{children:"27015"}),(0,s.jsx)(t.td,{children:"1024-65535"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"BACKUP_CRON_EXPRESSION"}),(0,s.jsx)(t.td,{children:"Setting affects frequency of automatic backups."}),(0,s.jsx)(t.td,{children:"0 0 * * *"}),(0,s.jsxs)(t.td,{children:["Needs a Cron-Expression - See ",(0,s.jsx)(t.a,{href:"https://palworld-server-docker.loef.dev/guides/backup/automated-backup",children:"Configuring Automatic Backups with Cron"})]})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"BACKUP_ENABLED"}),(0,s.jsx)(t.td,{children:"Enables automatic backups"}),(0,s.jsx)(t.td,{children:"true"}),(0,s.jsx)(t.td,{children:"true/false"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"DELETE_OLD_BACKUPS"}),(0,s.jsx)(t.td,{children:"Delete backups after a certain number of days"}),(0,s.jsx)(t.td,{children:"false"}),(0,s.jsx)(t.td,{children:"true/false"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"OLD_BACKUP_DAYS"}),(0,s.jsx)(t.td,{children:"How many days to keep backups"}),(0,s.jsx)(t.td,{children:"30"}),(0,s.jsx)(t.td,{children:"any positive integer"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"AUTO_UPDATE_CRON_EXPRESSION"}),(0,s.jsx)(t.td,{children:"Setting affects frequency of automatic updates."}),(0,s.jsx)(t.td,{children:"0 * * * *"}),(0,s.jsxs)(t.td,{children:["Needs a Cron-Expression - See ",(0,s.jsx)(t.a,{href:"https://palworld-server-docker.loef.dev/guides/automatic-reboots",children:"Configuring Automatic Updates with Cron"})]})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"AUTO_UPDATE_ENABLED"}),(0,s.jsx)(t.td,{children:"Enables automatic updates"}),(0,s.jsx)(t.td,{children:"false"}),(0,s.jsx)(t.td,{children:"true/false"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"AUTO_UPDATE_WARN_MINUTES"}),(0,s.jsx)(t.td,{children:"How long to wait to update the server, after the player were informed."}),(0,s.jsx)(t.td,{children:"30"}),(0,s.jsx)(t.td,{children:"!0"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"AUTO_REBOOT_CRON_EXPRESSION"}),(0,s.jsx)(t.td,{children:"Setting affects frequency of automatic updates."}),(0,s.jsx)(t.td,{children:"0 0 * * *"}),(0,s.jsxs)(t.td,{children:["Needs a Cron-Expression - See ",(0,s.jsx)(t.a,{href:"https://palworld-server-docker.loef.dev/guides/automatic-updates",children:"Configuring Automatic Reboots with Cron"})]})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"AUTO_REBOOT_ENABLED"}),(0,s.jsx)(t.td,{children:"Enables automatic reboots"}),(0,s.jsx)(t.td,{children:"false"}),(0,s.jsx)(t.td,{children:"true/false"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"AUTO_REBOOT_WARN_MINUTES"}),(0,s.jsx)(t.td,{children:"How long to wait to reboot the server, after the player were informed."}),(0,s.jsx)(t.td,{children:"5"}),(0,s.jsx)(t.td,{children:"!0"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"AUTO_REBOOT_EVEN_IF_PLAYERS_ONLINE"}),(0,s.jsx)(t.td,{children:"Restart the Server even if there are players online."}),(0,s.jsx)(t.td,{children:"false"}),(0,s.jsx)(t.td,{children:"true/false"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"DISCORD_WEBHOOK_URL"}),(0,s.jsx)(t.td,{children:"Discord webhook url found after creating a webhook on a discord server"}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.code,{children:"https://discord.com/api/webhooks/"})})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"DISCORD_CONNECT_TIMEOUT"}),(0,s.jsx)(t.td,{children:"Discord command initial connection timeout"}),(0,s.jsx)(t.td,{children:"30"}),(0,s.jsx)(t.td,{children:"!0"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"DISCORD_MAX_TIMEOUT"}),(0,s.jsx)(t.td,{children:"Discord total hook timeout"}),(0,s.jsx)(t.td,{children:"30"}),(0,s.jsx)(t.td,{children:"!0"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"DISCORD_PRE_UPDATE_BOOT_MESSAGE"}),(0,s.jsx)(t.td,{children:"Discord message sent when server begins updating"}),(0,s.jsx)(t.td,{children:"Server is updating..."}),(0,s.jsx)(t.td,{children:'"string"'})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"DISCORD_POST_UPDATE_BOOT_MESSAGE"}),(0,s.jsx)(t.td,{children:"Discord message sent when server completes updating"}),(0,s.jsx)(t.td,{children:"Server update complete!"}),(0,s.jsx)(t.td,{children:'"string"'})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"DISCORD_PRE_START_MESSAGE"}),(0,s.jsx)(t.td,{children:"Discord message sent when server begins to start"}),(0,s.jsx)(t.td,{children:"Server is started!"}),(0,s.jsx)(t.td,{children:'"string"'})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"DISCORD_PRE_SHUTDOWN_MESSAGE"}),(0,s.jsx)(t.td,{children:"Discord message sent when server begins to shutdown"}),(0,s.jsx)(t.td,{children:"Server is shutting down..."}),(0,s.jsx)(t.td,{children:'"string"'})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"DISCORD_POST_SHUTDOWN_MESSAGE"}),(0,s.jsx)(t.td,{children:"Discord message sent when server has stopped"}),(0,s.jsx)(t.td,{children:"Server is stopped!"}),(0,s.jsx)(t.td,{children:'"string"'})]})]})]}),"\n",(0,s.jsx)(t.p,{children:"*highly recommended to set"}),"\n",(0,s.jsx)(t.p,{children:"** Make sure you know what you are doing when running this option enabled"}),"\n",(0,s.jsx)(t.p,{children:"*** Required for docker stop to save and gracefully close the server"}),"\n",(0,s.jsx)(t.h3,{id:"game-ports",children:"Game Ports"}),"\n",(0,s.jsx)(t.p,{children:"The server needs the following ports by default."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"Port"}),(0,s.jsx)(t.th,{children:"Info"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"8211"}),(0,s.jsx)(t.td,{children:"Game Port (UDP)"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"27015"}),(0,s.jsx)(t.td,{children:"Query Port (UDP)"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"25575"}),(0,s.jsx)(t.td,{children:"RCON Port (TCP)"})]})]})]})]})}function a(e={}){const{wrapper:t}={...(0,d.M)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},2172:(e,t,r)=>{r.d(t,{I:()=>l,M:()=>i});var s=r(1504);const d={},n=s.createContext(d);function i(e){const t=s.useContext(n);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(d):e.components||d:i(e.components),s.createElement(n.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8a6a27d2.b979a34c.js b/assets/js/8a6a27d2.b979a34c.js deleted file mode 100644 index 7dd001dbe..000000000 --- a/assets/js/8a6a27d2.b979a34c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocusaurus=self.webpackChunkdocusaurus||[]).push([[384],{6692:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>a,contentTitle:()=>l,default:()=>h,frontMatter:()=>s,metadata:()=>i,toc:()=>d});var t=n(7624),o=n(2172);const s={sidebar_position:1,slug:"/"},l="Quick Setup",i={id:"getting-started/quick-setup",title:"Quick Setup",description:"Let's get you on your way with the Palworld Dedicated server!",source:"@site/docs/getting-started/quick-setup.md",sourceDirName:"getting-started",slug:"/",permalink:"/",draft:!1,unlisted:!1,editUrl:"https://github.com/thijsvanloef/palworld-server-docker/tree/main/docusaurus/docs/getting-started/quick-setup.md",tags:[],version:"current",sidebarPosition:1,frontMatter:{sidebar_position:1,slug:"/"},sidebar:"tutorialSidebar",previous:{title:"Getting Started",permalink:"/category/getting-started"},next:{title:"Configuration",permalink:"/category/configuration"}},a={},d=[{value:"Server Requirements",id:"server-requirements",level:2},{value:"Docker Compose",id:"docker-compose",level:2},{value:"Docker Run",id:"docker-run",level:3},{value:"Starting the server",id:"starting-the-server",level:2},{value:"Stopping the server",id:"stopping-the-server",level:2}];function c(e){const r={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,o.M)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h1,{id:"quick-setup",children:"Quick Setup"}),"\n",(0,t.jsx)(r.p,{children:"Let's get you on your way with the Palworld Dedicated server!"}),"\n",(0,t.jsxs)(r.admonition,{type:"warning",children:[(0,t.jsx)(r.p,{children:"At the moment, Xbox Gamepass/Xbox Console players will not be able to join a dedicated server."}),(0,t.jsx)(r.p,{children:"They will need to join players using the invite code and are limited to sessions of 4 players max."})]}),"\n",(0,t.jsx)(r.h2,{id:"server-requirements",children:"Server Requirements"}),"\n",(0,t.jsxs)(r.table,{children:[(0,t.jsx)(r.thead,{children:(0,t.jsxs)(r.tr,{children:[(0,t.jsx)(r.th,{children:"Resource"}),(0,t.jsx)(r.th,{children:"Minimum"}),(0,t.jsx)(r.th,{children:"Recommended"})]})}),(0,t.jsxs)(r.tbody,{children:[(0,t.jsxs)(r.tr,{children:[(0,t.jsx)(r.td,{children:"CPU"}),(0,t.jsx)(r.td,{children:"4 cores"}),(0,t.jsx)(r.td,{children:"4+ cores"})]}),(0,t.jsxs)(r.tr,{children:[(0,t.jsx)(r.td,{children:"RAM"}),(0,t.jsx)(r.td,{children:"16GB"}),(0,t.jsx)(r.td,{children:"Recommend over 32GB for stable operation"})]}),(0,t.jsxs)(r.tr,{children:[(0,t.jsx)(r.td,{children:"Storage"}),(0,t.jsx)(r.td,{children:"8GB"}),(0,t.jsx)(r.td,{children:"20GB"})]})]})]}),"\n",(0,t.jsx)(r.h2,{id:"docker-compose",children:"Docker Compose"}),"\n",(0,t.jsxs)(r.p,{children:["This repository includes an example\n",(0,t.jsx)(r.a,{href:"https://github.com/thijsvanloef/palworld-server-docker/blob/main/docker-compose.yml",children:"docker-compose.yml"}),"\nfile you can use to set up your server."]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yml",children:'services:\n palworld:\n image: thijsvanloef/palworld-server-docker:latest # Use the latest-arm64 tag for arm64 hosts\n restart: unless-stopped\n container_name: palworld-server\n stop_grace_period: 30s # Set to however long you are willing to wait for the container to gracefully stop\n ports:\n - 8211:8211/udp\n - 27015:27015/udp\n environment:\n PUID: 1000\n PGID: 1000\n PORT: 8211 # Optional but recommended\n PLAYERS: 16 # Optional but recommended\n SERVER_PASSWORD: "worldofpals" # Optional but recommended\n MULTITHREADING: true\n RCON_ENABLED: true\n RCON_PORT: 25575\n TZ: "UTC"\n ADMIN_PASSWORD: "adminPasswordHere"\n COMMUNITY: false # Enable this if you want your server to show up in the community servers tab, USE WITH SERVER_PASSWORD!\n SERVER_NAME: "World of Pals"\n SERVER_DESCRIPTION: "palworld-server-docker by Thijs van Loef"\n volumes:\n - ./palworld:/palworld/\n'})}),"\n",(0,t.jsxs)(r.p,{children:["As an alternative, you can copy the ",(0,t.jsx)(r.a,{href:"https://github.com/thijsvanloef/palworld-server-docker/blob/main/.env.example",children:".env.example"})," file to a new file called ",(0,t.jsx)(r.strong,{children:".env"})," file.\nModify it to your needs, check out the ",(0,t.jsx)(r.a,{href:"https://palworld-server-docker.loef.dev/getting-started/configuration/server-settings#environment-variables",children:"environment variables"})," section to check the correct\nvalues. Modify your ",(0,t.jsx)(r.a,{href:"https://github.com/thijsvanloef/palworld-server-docker/blob/main/docker-compose.yml",children:"docker-compose.yml"})," to this:"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yml",children:"services:\n palworld:\n image: thijsvanloef/palworld-server-docker:latest # Use the latest-arm64 tag for arm64 hosts\n restart: unless-stopped\n container_name: palworld-server\n stop_grace_period: 30s # Set to however long you are willing to wait for the container to gracefully stop\n ports:\n - 8211:8211/udp\n - 27015:27015/udp\n env_file:\n - .env\n volumes:\n - ./palworld:/palworld/\n"})}),"\n",(0,t.jsx)(r.h3,{id:"docker-run",children:"Docker Run"}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-bash",children:'docker run -d \\\n --name palworld-server \\\n -p 8211:8211/udp \\\n -p 27015:27015/udp \\\n -v ./palworld:/palworld/ \\\n -e PUID=1000 \\\n -e PGID=1000 \\\n -e PORT=8211 \\\n -e PLAYERS=16 \\\n -e MULTITHREADING=true \\\n -e RCON_ENABLED=true \\\n -e RCON_PORT=25575 \\\n -e TZ=UTC \\\n -e ADMIN_PASSWORD="adminPasswordHere" \\\n -e SERVER_PASSWORD="worldofpals" \\\n -e COMMUNITY=false \\\n -e SERVER_NAME="World of Pals" \\\n -e SERVER_DESCRIPTION="palworld-server-docker by Thijs van Loef" \\\n --restart unless-stopped \\\n --stop-timeout 30 \\\n thijsvanloef/palworld-server-docker:latest # Use the latest-arm64 tag for arm64 hosts\n'})}),"\n",(0,t.jsxs)(r.p,{children:["As an alternative, you can copy the ",(0,t.jsx)(r.a,{href:"https://github.com/thijsvanloef/palworld-server-docker/blob/main/.env.example",children:".env.example"})," file to a new file called ",(0,t.jsx)(r.strong,{children:".env"})," file.\nModify it to your needs, check out the ",(0,t.jsx)(r.a,{href:"https://palworld-server-docker.loef.dev/getting-started/configuration/server-settings#environment-variables",children:"environment variables"})," section to check the\ncorrect values. Change your docker run command to this:"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-bash",children:"docker run -d \\\n --name palworld-server \\\n -p 8211:8211/udp \\\n -p 27015:27015/udp \\\n -v ./palworld:/palworld/ \\\n --env-file .env \\\n --restart unless-stopped \\\n --stop-timeout 30 \\\n thijsvanloef/palworld-server-docker:latest # Use the latest-arm64 tag for arm64 hosts\n"})}),"\n",(0,t.jsx)(r.h2,{id:"starting-the-server",children:"Starting the server"}),"\n",(0,t.jsxs)(r.p,{children:["Use ",(0,t.jsx)(r.code,{children:"docker compose up -d"})," to start the server in the background"]}),"\n",(0,t.jsx)(r.h2,{id:"stopping-the-server",children:"Stopping the server"}),"\n",(0,t.jsxs)(r.p,{children:["Use ",(0,t.jsx)(r.code,{children:"docker compose stop"})," to stop the server"]}),"\n",(0,t.jsxs)(r.p,{children:["Use ",(0,t.jsx)(r.code,{children:"docker compose down --rmi all"})," to stop and remove the server and remove the docker image from your computer"]})]})}function h(e={}){const{wrapper:r}={...(0,o.M)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(c,{...e})}):c(e)}},2172:(e,r,n)=>{n.d(r,{I:()=>i,M:()=>l});var t=n(1504);const o={},s=t.createContext(o);function l(e){const r=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:l(e.components),t.createElement(s.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8a6a27d2.c2cc6629.js b/assets/js/8a6a27d2.c2cc6629.js new file mode 100644 index 000000000..96e099d9c --- /dev/null +++ b/assets/js/8a6a27d2.c2cc6629.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocusaurus=self.webpackChunkdocusaurus||[]).push([[384],{6692:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>d,contentTitle:()=>l,default:()=>h,frontMatter:()=>o,metadata:()=>i,toc:()=>a});var t=n(7624),s=n(2172);const o={sidebar_position:1,slug:"/"},l="Quick Setup",i={id:"getting-started/quick-setup",title:"Quick Setup",description:"Let's get you on your way with the Palworld Dedicated server!",source:"@site/docs/getting-started/quick-setup.md",sourceDirName:"getting-started",slug:"/",permalink:"/",draft:!1,unlisted:!1,editUrl:"https://github.com/thijsvanloef/palworld-server-docker/tree/main/docusaurus/docs/getting-started/quick-setup.md",tags:[],version:"current",sidebarPosition:1,frontMatter:{sidebar_position:1,slug:"/"},sidebar:"tutorialSidebar",previous:{title:"Getting Started",permalink:"/category/getting-started"},next:{title:"Configuration",permalink:"/category/configuration"}},d={},a=[{value:"Prerequisites",id:"prerequisites",level:2},{value:"Server Requirements",id:"server-requirements",level:2},{value:"Docker Compose",id:"docker-compose",level:2},{value:"Starting the server",id:"starting-the-server",level:3},{value:"Stopping the server",id:"stopping-the-server",level:3},{value:"Docker Run",id:"docker-run",level:2}];function c(e){const r={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",h3:"h3",li:"li",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,s.M)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h1,{id:"quick-setup",children:"Quick Setup"}),"\n",(0,t.jsx)(r.p,{children:"Let's get you on your way with the Palworld Dedicated server!"}),"\n",(0,t.jsxs)(r.admonition,{type:"warning",children:[(0,t.jsx)(r.p,{children:"At the moment, Xbox Gamepass/Xbox Console players will not be able to join a dedicated server."}),(0,t.jsx)(r.p,{children:"They will need to join players using the invite code and are limited to sessions of 4 players max."})]}),"\n",(0,t.jsx)(r.h2,{id:"prerequisites",children:"Prerequisites"}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Virtualization enabled in the BIOS/UEFI"}),"\n",(0,t.jsxs)(r.li,{children:["Must have ",(0,t.jsx)(r.a,{href:"https://docs.docker.com/engine/install/",children:"Docker"})," installed"]}),"\n"]}),"\n",(0,t.jsx)(r.h2,{id:"server-requirements",children:"Server Requirements"}),"\n",(0,t.jsxs)(r.table,{children:[(0,t.jsx)(r.thead,{children:(0,t.jsxs)(r.tr,{children:[(0,t.jsx)(r.th,{children:"Resource"}),(0,t.jsx)(r.th,{children:"Minimum"}),(0,t.jsx)(r.th,{children:"Recommended"})]})}),(0,t.jsxs)(r.tbody,{children:[(0,t.jsxs)(r.tr,{children:[(0,t.jsx)(r.td,{children:"CPU"}),(0,t.jsx)(r.td,{children:"4 cores"}),(0,t.jsx)(r.td,{children:"4+ cores"})]}),(0,t.jsxs)(r.tr,{children:[(0,t.jsx)(r.td,{children:"RAM"}),(0,t.jsx)(r.td,{children:"16GB"}),(0,t.jsx)(r.td,{children:"Recommend over 32GB for stable operation"})]}),(0,t.jsxs)(r.tr,{children:[(0,t.jsx)(r.td,{children:"Storage"}),(0,t.jsx)(r.td,{children:"8GB"}),(0,t.jsx)(r.td,{children:"20GB"})]})]})]}),"\n",(0,t.jsx)(r.h2,{id:"docker-compose",children:"Docker Compose"}),"\n",(0,t.jsxs)(r.p,{children:["This repository includes an example\n",(0,t.jsx)(r.a,{href:"https://github.com/thijsvanloef/palworld-server-docker/blob/main/docker-compose.yml",children:"docker-compose.yml"}),"\nfile you can use to set up your server."]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yml",children:'services:\n palworld:\n image: thijsvanloef/palworld-server-docker:latest # Use the latest-arm64 tag for arm64 hosts\n restart: unless-stopped\n container_name: palworld-server\n stop_grace_period: 30s # Set to however long you are willing to wait for the container to gracefully stop\n ports:\n - 8211:8211/udp\n - 27015:27015/udp\n environment:\n PUID: 1000\n PGID: 1000\n PORT: 8211 # Optional but recommended\n PLAYERS: 16 # Optional but recommended\n SERVER_PASSWORD: "worldofpals" # Optional but recommended\n MULTITHREADING: true\n RCON_ENABLED: true\n RCON_PORT: 25575\n TZ: "UTC"\n ADMIN_PASSWORD: "adminPasswordHere"\n COMMUNITY: false # Enable this if you want your server to show up in the community servers tab, USE WITH SERVER_PASSWORD!\n SERVER_NAME: "World of Pals"\n SERVER_DESCRIPTION: "palworld-server-docker by Thijs van Loef"\n volumes:\n - ./palworld:/palworld/\n'})}),"\n",(0,t.jsxs)(r.p,{children:["As an alternative, you can copy the ",(0,t.jsx)(r.a,{href:"https://github.com/thijsvanloef/palworld-server-docker/blob/main/.env.example",children:".env.example"})," file to a new file called ",(0,t.jsx)(r.strong,{children:".env"})," file."]}),"\n",(0,t.jsxs)(r.p,{children:["Modify it to your needs, check out the ",(0,t.jsx)(r.a,{href:"https://palworld-server-docker.loef.dev/getting-started/configuration/server-settings#environment-variables",children:"environment variables"})," section to check the correct\nvalues."]}),"\n",(0,t.jsxs)(r.p,{children:["Modify your ",(0,t.jsx)(r.a,{href:"https://github.com/thijsvanloef/palworld-server-docker/blob/main/docker-compose.yml",children:"docker-compose.yml"})," to this:"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yml",children:"services:\n palworld:\n image: thijsvanloef/palworld-server-docker:latest # Use the latest-arm64 tag for arm64 hosts\n restart: unless-stopped\n container_name: palworld-server\n stop_grace_period: 30s # Set to however long you are willing to wait for the container to gracefully stop\n ports:\n - 8211:8211/udp\n - 27015:27015/udp\n env_file:\n - .env\n volumes:\n - ./palworld:/palworld/\n"})}),"\n",(0,t.jsx)(r.h3,{id:"starting-the-server",children:"Starting the server"}),"\n",(0,t.jsxs)(r.p,{children:["Use ",(0,t.jsx)(r.code,{children:"docker compose up -d"})," in the same folder as the ",(0,t.jsx)(r.code,{children:"docker-compose.yml"})," to start the server in the background"]}),"\n",(0,t.jsx)(r.h3,{id:"stopping-the-server",children:"Stopping the server"}),"\n",(0,t.jsxs)(r.p,{children:["Use ",(0,t.jsx)(r.code,{children:"docker compose stop"})," in the same folder as the ",(0,t.jsx)(r.code,{children:"docker-compose.yml"})," to stop the server"]}),"\n",(0,t.jsxs)(r.p,{children:["Use ",(0,t.jsx)(r.code,{children:"docker compose down --rmi all"})," in the same folder as the ",(0,t.jsx)(r.code,{children:"docker-compose.yml"}),"\nto stop and remove the server and remove the docker image from your computer"]}),"\n",(0,t.jsx)(r.h2,{id:"docker-run",children:"Docker Run"}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-bash",children:'docker run -d \\\n --name palworld-server \\\n -p 8211:8211/udp \\\n -p 27015:27015/udp \\\n -v ./palworld:/palworld/ \\\n -e PUID=1000 \\\n -e PGID=1000 \\\n -e PORT=8211 \\\n -e PLAYERS=16 \\\n -e MULTITHREADING=true \\\n -e RCON_ENABLED=true \\\n -e RCON_PORT=25575 \\\n -e TZ=UTC \\\n -e ADMIN_PASSWORD="adminPasswordHere" \\\n -e SERVER_PASSWORD="worldofpals" \\\n -e COMMUNITY=false \\\n -e SERVER_NAME="World of Pals" \\\n -e SERVER_DESCRIPTION="palworld-server-docker by Thijs van Loef" \\\n --restart unless-stopped \\\n --stop-timeout 30 \\\n thijsvanloef/palworld-server-docker:latest # Use the latest-arm64 tag for arm64 hosts\n'})}),"\n",(0,t.jsxs)(r.p,{children:["As an alternative, you can copy the ",(0,t.jsx)(r.a,{href:"https://github.com/thijsvanloef/palworld-server-docker/blob/main/.env.example",children:".env.example"})," file to a new file called ",(0,t.jsx)(r.strong,{children:".env"})," file."]}),"\n",(0,t.jsxs)(r.p,{children:["Modify it to your needs, check out the ",(0,t.jsx)(r.a,{href:"https://palworld-server-docker.loef.dev/getting-started/configuration/server-settings#environment-variables",children:"environment variables"})," section to check the\ncorrect values."]}),"\n",(0,t.jsx)(r.p,{children:"Change your docker run command to this:"}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-bash",children:"docker run -d \\\n --name palworld-server \\\n -p 8211:8211/udp \\\n -p 27015:27015/udp \\\n -v ./palworld:/palworld/ \\\n --env-file .env \\\n --restart unless-stopped \\\n --stop-timeout 30 \\\n thijsvanloef/palworld-server-docker:latest # Use the latest-arm64 tag for arm64 hosts\n"})})]})}function h(e={}){const{wrapper:r}={...(0,s.M)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(c,{...e})}):c(e)}},2172:(e,r,n)=>{n.d(r,{I:()=>i,M:()=>l});var t=n(1504);const s={},o=t.createContext(s);function l(e){const r=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),t.createElement(o.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/935f2afb.46d74570.js b/assets/js/935f2afb.7f727e0d.js similarity index 59% rename from assets/js/935f2afb.46d74570.js rename to assets/js/935f2afb.7f727e0d.js index fa1cc1e01..12fec9fe4 100644 --- a/assets/js/935f2afb.46d74570.js +++ b/assets/js/935f2afb.7f727e0d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocusaurus=self.webpackChunkdocusaurus||[]).push([[696],{5988:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"category","label":"Getting Started","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Quick Setup","href":"/","docId":"getting-started/quick-setup","unlisted":false},{"type":"category","label":"Configuration","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Server Settings","href":"/getting-started/configuration/server-settings","docId":"getting-started/configuration/server-settings","unlisted":false},{"type":"link","label":"Game Settings","href":"/getting-started/configuration/game-settings","docId":"getting-started/configuration/game-settings","unlisted":false},{"type":"link","label":"Server Commands (RCON)","href":"/getting-started/configuration/server-commands","docId":"getting-started/configuration/server-commands","unlisted":false}],"href":"/category/configuration"}],"href":"/category/getting-started"},{"type":"category","label":"Guides","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"Backup","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Creating a backup","href":"/guides/backup/creating-backup","docId":"guides/backup/creating-backup","unlisted":false},{"type":"link","label":"Restoring a backup","href":"/guides/backup/restoring-backup","docId":"guides/backup/restoring-backup","unlisted":false},{"type":"link","label":"Configure automated backups","href":"/guides/backup/automated-backup","docId":"guides/backup/automated-backup","unlisted":false}],"href":"/category/backup"},{"type":"category","label":"Discord integration","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Using discord webhooks","href":"/guides/discord/discord-webhooks","docId":"guides/discord/discord-webhooks","unlisted":false}],"href":"/category/discord-integration"},{"type":"link","label":"Automatic Reboots","href":"/guides/automatic-reboots","docId":"guides/automatic-reboots","unlisted":false},{"type":"link","label":"Automatic Updates","href":"/guides/automatic-updates","docId":"guides/automatic-updates","unlisted":false}],"href":"/category/guides"},{"type":"category","label":"Advanced","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Palworld Directory","href":"/advanced/palworld-directory","docId":"advanced/palworld-directory","unlisted":false},{"type":"link","label":"Kubernetes","href":"/advanced/kubernetes","docId":"advanced/kubernetes","unlisted":false}],"href":"/category/advanced"},{"type":"link","label":"Versions","href":"/versions/","docId":"versions/versions","unlisted":false},{"type":"link","label":"Known Issues","href":"/known-issues/","docId":"known-issues/known-issues","unlisted":false}]},"docs":{"advanced/kubernetes":{"id":"advanced/kubernetes","title":"Kubernetes","description":"All files you will need to deploy this container to kubernetes are located in the k8s folder.","sidebar":"tutorialSidebar"},"advanced/palworld-directory":{"id":"advanced/palworld-directory","title":"Palworld Directory","description":"Everything related to the Palworld data is inside the /palworld folder inside the container","sidebar":"tutorialSidebar"},"getting-started/configuration/game-settings":{"id":"getting-started/configuration/game-settings","title":"Game Settings","description":"With Environment Variables","sidebar":"tutorialSidebar"},"getting-started/configuration/server-commands":{"id":"getting-started/configuration/server-commands","title":"Server Commands (RCON)","description":"How to use RCON to interact with the server.","sidebar":"tutorialSidebar"},"getting-started/configuration/server-settings":{"id":"getting-started/configuration/server-settings","title":"Server Settings","description":"This part will explain how to configure the server.","sidebar":"tutorialSidebar"},"getting-started/quick-setup":{"id":"getting-started/quick-setup","title":"Quick Setup","description":"Let\'s get you on your way with the Palworld Dedicated server!","sidebar":"tutorialSidebar"},"guides/automatic-reboots":{"id":"guides/automatic-reboots","title":"Automatic Reboots","description":"Configuring Automatic Reboots with Cron","sidebar":"tutorialSidebar"},"guides/automatic-updates":{"id":"guides/automatic-updates","title":"Automatic Updates","description":"Configuring Automatic Updates with Cron","sidebar":"tutorialSidebar"},"guides/backup/automated-backup":{"id":"guides/backup/automated-backup","title":"Configure automated backups","description":"The server is automatically backed up everynight at midnight according to the timezone set with TZ","sidebar":"tutorialSidebar"},"guides/backup/creating-backup":{"id":"guides/backup/creating-backup","title":"Creating a backup","description":"To create a backup of the game\'s save at the current point in time, use the command:","sidebar":"tutorialSidebar"},"guides/backup/restoring-backup":{"id":"guides/backup/restoring-backup","title":"Restoring a backup","description":"Interactively restore from a backup","sidebar":"tutorialSidebar"},"guides/discord/discord-webhooks":{"id":"guides/discord/discord-webhooks","title":"Using discord webhooks","description":"1. Generate a webhook url for your discord server in your discord\'s server settings.","sidebar":"tutorialSidebar"},"known-issues/known-issues":{"id":"known-issues/known-issues","title":"Known Issues","description":"Broadcast command can only send 1 word","sidebar":"tutorialSidebar"},"versions/versions":{"id":"versions/versions","title":"Versions","description":"This page shows how the Docker images tags are versioned.","sidebar":"tutorialSidebar"}}}')}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocusaurus=self.webpackChunkdocusaurus||[]).push([[696],{5988:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"category","label":"Getting Started","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Quick Setup","href":"/","docId":"getting-started/quick-setup","unlisted":false},{"type":"category","label":"Configuration","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Server Settings","href":"/getting-started/configuration/server-settings","docId":"getting-started/configuration/server-settings","unlisted":false},{"type":"link","label":"Game Settings","href":"/getting-started/configuration/game-settings","docId":"getting-started/configuration/game-settings","unlisted":false},{"type":"link","label":"Server Commands (RCON)","href":"/getting-started/configuration/server-commands","docId":"getting-started/configuration/server-commands","unlisted":false}],"href":"/category/configuration"}],"href":"/category/getting-started"},{"type":"category","label":"Guides","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"Backup","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Creating a backup","href":"/guides/backup/creating-backup","docId":"guides/backup/creating-backup","unlisted":false},{"type":"link","label":"Restoring a backup","href":"/guides/backup/restoring-backup","docId":"guides/backup/restoring-backup","unlisted":false},{"type":"link","label":"Configure automated backups","href":"/guides/backup/automated-backup","docId":"guides/backup/automated-backup","unlisted":false}],"href":"/category/backup"},{"type":"category","label":"Discord integration","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Using discord webhooks","href":"/guides/discord/discord-webhooks","docId":"guides/discord/discord-webhooks","unlisted":false}],"href":"/category/discord-integration"},{"type":"link","label":"Automatic Reboots","href":"/guides/automatic-reboots","docId":"guides/automatic-reboots","unlisted":false},{"type":"link","label":"Automatic Updates","href":"/guides/automatic-updates","docId":"guides/automatic-updates","unlisted":false}],"href":"/category/guides"},{"type":"category","label":"Advanced","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Palworld Directory","href":"/advanced/palworld-directory","docId":"advanced/palworld-directory","unlisted":false},{"type":"link","label":"Kubernetes","href":"/advanced/kubernetes","docId":"advanced/kubernetes","unlisted":false}],"href":"/category/advanced"},{"type":"link","label":"Versions","href":"/versions/","docId":"versions/versions","unlisted":false},{"type":"link","label":"Known Issues","href":"/known-issues/","docId":"known-issues/known-issues","unlisted":false}]},"docs":{"advanced/kubernetes":{"id":"advanced/kubernetes","title":"Kubernetes","description":"All files you will need to deploy this container to kubernetes are located in the k8s folder.","sidebar":"tutorialSidebar"},"advanced/palworld-directory":{"id":"advanced/palworld-directory","title":"Palworld Directory","description":"Everything related to the Palworld data is inside the /palworld folder inside the container","sidebar":"tutorialSidebar"},"getting-started/configuration/game-settings":{"id":"getting-started/configuration/game-settings","title":"Game Settings","description":"Changing Game Settings with Environment variables.","sidebar":"tutorialSidebar"},"getting-started/configuration/server-commands":{"id":"getting-started/configuration/server-commands","title":"Server Commands (RCON)","description":"How to use RCON to interact with the server.","sidebar":"tutorialSidebar"},"getting-started/configuration/server-settings":{"id":"getting-started/configuration/server-settings","title":"Server Settings","description":"Changing Server Settings using environment variables.","sidebar":"tutorialSidebar"},"getting-started/quick-setup":{"id":"getting-started/quick-setup","title":"Quick Setup","description":"Let\'s get you on your way with the Palworld Dedicated server!","sidebar":"tutorialSidebar"},"guides/automatic-reboots":{"id":"guides/automatic-reboots","title":"Automatic Reboots","description":"Configuring Automatic Reboots with Cron","sidebar":"tutorialSidebar"},"guides/automatic-updates":{"id":"guides/automatic-updates","title":"Automatic Updates","description":"Configuring Automatic Updates with Cron","sidebar":"tutorialSidebar"},"guides/backup/automated-backup":{"id":"guides/backup/automated-backup","title":"Configure automated backups","description":"The server is automatically backed up everynight at midnight according to the timezone set with TZ","sidebar":"tutorialSidebar"},"guides/backup/creating-backup":{"id":"guides/backup/creating-backup","title":"Creating a backup","description":"To create a backup of the game\'s save at the current point in time, use the command:","sidebar":"tutorialSidebar"},"guides/backup/restoring-backup":{"id":"guides/backup/restoring-backup","title":"Restoring a backup","description":"Interactively restore from a backup","sidebar":"tutorialSidebar"},"guides/discord/discord-webhooks":{"id":"guides/discord/discord-webhooks","title":"Using discord webhooks","description":"1. Generate a webhook url for your discord server in your discord\'s server settings.","sidebar":"tutorialSidebar"},"known-issues/known-issues":{"id":"known-issues/known-issues","title":"Known Issues","description":"Known issues of using this Docker image.","sidebar":"tutorialSidebar"},"versions/versions":{"id":"versions/versions","title":"Versions","description":"This page shows how the Docker images tags are versioned.","sidebar":"tutorialSidebar"}}}')}}]); \ No newline at end of file diff --git a/assets/js/c3826a0d.6d2b5b24.js b/assets/js/c3826a0d.6d2b5b24.js new file mode 100644 index 000000000..19b731d2d --- /dev/null +++ b/assets/js/c3826a0d.6d2b5b24.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocusaurus=self.webpackChunkdocusaurus||[]).push([[528],{2268:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>h,contentTitle:()=>l,default:()=>x,frontMatter:()=>s,metadata:()=>i,toc:()=>c});var d=r(7624),n=r(2172);const s={sidebar_position:2},l="Game Settings",i={id:"getting-started/configuration/game-settings",title:"Game Settings",description:"Changing Game Settings with Environment variables.",source:"@site/docs/getting-started/configuration/game-settings.md",sourceDirName:"getting-started/configuration",slug:"/getting-started/configuration/game-settings",permalink:"/getting-started/configuration/game-settings",draft:!1,unlisted:!1,editUrl:"https://github.com/thijsvanloef/palworld-server-docker/tree/main/docusaurus/docs/getting-started/configuration/game-settings.md",tags:[],version:"current",sidebarPosition:2,frontMatter:{sidebar_position:2},sidebar:"tutorialSidebar",previous:{title:"Server Settings",permalink:"/getting-started/configuration/server-settings"},next:{title:"Server Commands (RCON)",permalink:"/getting-started/configuration/server-commands"}},h={},c=[{value:"With Environment Variables",id:"with-environment-variables",level:2},{value:"Manually",id:"manually",level:3}];function a(e){const t={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",h3:"h3",li:"li",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,n.M)(),...e.components};return(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(t.h1,{id:"game-settings",children:"Game Settings"}),"\n",(0,d.jsx)(t.p,{children:"Changing Game Settings with Environment variables."}),"\n",(0,d.jsx)(t.h2,{id:"with-environment-variables",children:"With Environment Variables"}),"\n",(0,d.jsxs)(t.admonition,{type:"warning",children:[(0,d.jsx)(t.p,{children:"These Environment Variables and Settings are subject to change since the game is still in beta."}),(0,d.jsxs)(t.p,{children:["Check out the ",(0,d.jsx)(t.a,{href:"https://tech.palworldgame.com/optimize-game-balance",children:"official webpage for the supported parameters."})]})]}),"\n",(0,d.jsx)(t.p,{children:"Converting server settings to environment variables follow the same principles (with some exceptions):"}),"\n",(0,d.jsxs)(t.ul,{children:["\n",(0,d.jsx)(t.li,{children:"all capital letters"}),"\n",(0,d.jsx)(t.li,{children:"split words by inserting an underscore"}),"\n",(0,d.jsx)(t.li,{children:"remove the single letter if the setting starts with one (like 'b')"}),"\n"]}),"\n",(0,d.jsx)(t.p,{children:"For example:"}),"\n",(0,d.jsxs)(t.ul,{children:["\n",(0,d.jsx)(t.li,{children:"Difficulty -> DIFFICULTY"}),"\n",(0,d.jsx)(t.li,{children:"PalSpawnNumRate -> PAL_SPAWN_NUM_RATE"}),"\n",(0,d.jsx)(t.li,{children:"bIsPvP -> IS_PVP"}),"\n"]}),"\n",(0,d.jsxs)(t.table,{children:[(0,d.jsx)(t.thead,{children:(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.th,{children:"Variable"}),(0,d.jsx)(t.th,{children:"Description"}),(0,d.jsx)(t.th,{children:"Default Value"}),(0,d.jsx)(t.th,{children:"Allowed Value"})]})}),(0,d.jsxs)(t.tbody,{children:[(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"DIFFICULTY"}),(0,d.jsx)(t.td,{children:"Game Difficulty"}),(0,d.jsx)(t.td,{children:"None"}),(0,d.jsxs)(t.td,{children:[(0,d.jsx)(t.code,{children:"None"}),",",(0,d.jsx)(t.code,{children:"Normal"}),",",(0,d.jsx)(t.code,{children:"Difficult"})]})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"DAYTIME_SPEEDRATE"}),(0,d.jsx)(t.td,{children:"Day time speed - Smaller number means shorter days"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"NIGHTTIME_SPEEDRATE"}),(0,d.jsx)(t.td,{children:"Night time speed - Smaller number means shorter nights"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"EXP_RATE"}),(0,d.jsx)(t.td,{children:"EXP earn rate"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"PAL_CAPTURE_RATE"}),(0,d.jsx)(t.td,{children:"Pal capture rate"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"PAL_SPAWN_NUM_RATE"}),(0,d.jsx)(t.td,{children:"Pal appearance rate"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"PAL_DAMAGE_RATE_ATTACK"}),(0,d.jsx)(t.td,{children:"Damage from pals multipiler"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"PAL_DAMAGE_RATE_DEFENSE"}),(0,d.jsx)(t.td,{children:"Damage to pals multipiler"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"PLAYER_DAMAGE_RATE_ATTACK"}),(0,d.jsx)(t.td,{children:"Damage from player multipiler"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"PLAYER_DAMAGE_RATE_DEFENSE"}),(0,d.jsx)(t.td,{children:"Damage to player multipiler"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"PLAYER_STOMACH_DECREASE_RATE"}),(0,d.jsx)(t.td,{children:"Player hunger depletion rate"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"PLAYER_STAMINA_DECREASE_RATE"}),(0,d.jsx)(t.td,{children:"Player stamina reduction rate"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"PLAYER_AUTO_HP_REGEN_RATE"}),(0,d.jsx)(t.td,{children:"Player auto HP regeneration rate"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"PLAYER_AUTO_HP_REGEN_RATE_IN_SLEEP"}),(0,d.jsx)(t.td,{children:"Player sleep HP regeneration rate"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"PAL_STOMACH_DECREASE_RATE"}),(0,d.jsx)(t.td,{children:"Pal hunger depletion rate"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"PAL_STAMINA_DECREASE_RATE"}),(0,d.jsx)(t.td,{children:"Pal stamina reduction rate"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"PAL_AUTO_HP_REGEN_RATE"}),(0,d.jsx)(t.td,{children:"Pal auto HP regeneration rate"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"PAL_AUTO_HP_REGEN_RATE_IN_SLEEP"}),(0,d.jsx)(t.td,{children:"Pal sleep health regeneration rate (in Palbox)"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"BUILD_OBJECT_DAMAGE_RATE"}),(0,d.jsx)(t.td,{children:"Damage to structure multipiler"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"BUILD_OBJECT_DETERIORATION_DAMAGE_RATE"}),(0,d.jsx)(t.td,{children:"Structure determination rate"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"COLLECTION_DROP_RATE"}),(0,d.jsx)(t.td,{children:"Getherable items multipiler"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"COLLECTION_OBJECT_HP_RATE"}),(0,d.jsx)(t.td,{children:"Getherable objects HP multipiler"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"COLLECTION_OBJECT_RESPAWN_SPEED_RATE"}),(0,d.jsx)(t.td,{children:"Getherable objects respawn interval - The smaller the number, the faster the regeneration"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"ENEMY_DROP_ITEM_RATE"}),(0,d.jsx)(t.td,{children:"Dropped Items Multipiler"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"DEATH_PENALTY"}),(0,d.jsx)(t.td,{children:"Death Penalty None: No death penalty Item: Drops items other than equipment ItemAndEquipment: Drops all items All: Drops all PALs and all items."}),(0,d.jsx)(t.td,{children:"All"}),(0,d.jsxs)(t.td,{children:[(0,d.jsx)(t.code,{children:"None"}),",",(0,d.jsx)(t.code,{children:"Item"}),",",(0,d.jsx)(t.code,{children:"ItemAndEquipment"}),",",(0,d.jsx)(t.code,{children:"All"})]})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"ENABLE_PLAYER_TO_PLAYER_DAMAGE"}),(0,d.jsx)(t.td,{children:"Allows players to cause damage to players"}),(0,d.jsx)(t.td,{children:"False"}),(0,d.jsx)(t.td,{children:"Boolean"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"ENABLE_FRIENDLY_FIRE"}),(0,d.jsx)(t.td,{children:"Allow friendly fire"}),(0,d.jsx)(t.td,{children:"False"}),(0,d.jsx)(t.td,{children:"Boolean"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"ENABLE_INVADER_ENEMY"}),(0,d.jsx)(t.td,{children:"Enable invaders"}),(0,d.jsx)(t.td,{children:"True"}),(0,d.jsx)(t.td,{children:"Boolean"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"ACTIVE_UNKO"}),(0,d.jsx)(t.td,{children:"Enable UNKO (?)"}),(0,d.jsx)(t.td,{children:"False"}),(0,d.jsx)(t.td,{children:"Boolean"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"ENABLE_AIM_ASSIST_PAD"}),(0,d.jsx)(t.td,{children:"Enable controller aim assist"}),(0,d.jsx)(t.td,{children:"True"}),(0,d.jsx)(t.td,{children:"Boolean"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"ENABLE_AIM_ASSIST_KEYBOARD"}),(0,d.jsx)(t.td,{children:"Enable Keyboard aim assist"}),(0,d.jsx)(t.td,{children:"False"}),(0,d.jsx)(t.td,{children:"Boolean"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"DROP_ITEM_MAX_NUM"}),(0,d.jsx)(t.td,{children:"Maximum number of drops in the world"}),(0,d.jsx)(t.td,{children:"3000"}),(0,d.jsx)(t.td,{children:"Integer"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"DROP_ITEM_MAX_NUM_UNKO"}),(0,d.jsx)(t.td,{children:"Maximum number of UNKO drops in the world"}),(0,d.jsx)(t.td,{children:"100"}),(0,d.jsx)(t.td,{children:"Integer"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"BASE_CAMP_MAX_NUM"}),(0,d.jsx)(t.td,{children:"Maximum number of base camps"}),(0,d.jsx)(t.td,{children:"128"}),(0,d.jsx)(t.td,{children:"Integer"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"BASE_CAMP_WORKER_MAX_NUM"}),(0,d.jsx)(t.td,{children:"Maximum number of workers"}),(0,d.jsx)(t.td,{children:"15"}),(0,d.jsx)(t.td,{children:"Integer"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"DROP_ITEM_ALIVE_MAX_HOURS"}),(0,d.jsx)(t.td,{children:"Time it takes for items to despawn in hours"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"AUTO_RESET_GUILD_NO_ONLINE_PLAYERS"}),(0,d.jsx)(t.td,{children:"Automatically reset guild when no players are online"}),(0,d.jsx)(t.td,{children:"False"}),(0,d.jsx)(t.td,{children:"Bool"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"AUTO_RESET_GUILD_TIME_NO_ONLINE_PLAYERS"}),(0,d.jsx)(t.td,{children:"Time to automatically reset guild when no players are online"}),(0,d.jsx)(t.td,{children:"72.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"GUILD_PLAYER_MAX_NUM"}),(0,d.jsx)(t.td,{children:"Max player of Guild"}),(0,d.jsx)(t.td,{children:"20"}),(0,d.jsx)(t.td,{children:"Integer"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"PAL_EGG_DEFAULT_HATCHING_TIME"}),(0,d.jsx)(t.td,{children:"Time(h) to incubate massive egg"}),(0,d.jsx)(t.td,{children:"72.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"WORK_SPEED_RATE"}),(0,d.jsx)(t.td,{children:"Work speed muliplier"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"IS_MULTIPLAY"}),(0,d.jsx)(t.td,{children:"Enable multiplayer"}),(0,d.jsx)(t.td,{children:"False"}),(0,d.jsx)(t.td,{children:"Boolean"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"IS_PVP"}),(0,d.jsx)(t.td,{children:"Enable PVP"}),(0,d.jsx)(t.td,{children:"False"}),(0,d.jsx)(t.td,{children:"Boolean"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"CAN_PICKUP_OTHER_GUILD_DEATH_PENALTY_DROP"}),(0,d.jsx)(t.td,{children:"Allow players from other guilds to pick up death penalty items"}),(0,d.jsx)(t.td,{children:"False"}),(0,d.jsx)(t.td,{children:"Boolean"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"ENABLE_NON_LOGIN_PENALTY"}),(0,d.jsx)(t.td,{children:"Enable non-login penalty"}),(0,d.jsx)(t.td,{children:"True"}),(0,d.jsx)(t.td,{children:"Boolean"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"ENABLE_FAST_TRAVEL"}),(0,d.jsx)(t.td,{children:"Enable fast travel"}),(0,d.jsx)(t.td,{children:"True"}),(0,d.jsx)(t.td,{children:"Boolean"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"IS_START_LOCATION_SELECT_BY_MAP"}),(0,d.jsx)(t.td,{children:"Enable selecting of start location"}),(0,d.jsx)(t.td,{children:"True"}),(0,d.jsx)(t.td,{children:"Boolean"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"EXIST_PLAYER_AFTER_LOGOUT"}),(0,d.jsx)(t.td,{children:"Toggle for deleting players when they log off"}),(0,d.jsx)(t.td,{children:"False"}),(0,d.jsx)(t.td,{children:"Boolean"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"ENABLE_DEFENSE_OTHER_GUILD_PLAYER"}),(0,d.jsx)(t.td,{children:"Allows defense against other guild players"}),(0,d.jsx)(t.td,{children:"False"}),(0,d.jsx)(t.td,{children:"Boolean"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"COOP_PLAYER_MAX_NUM"}),(0,d.jsx)(t.td,{children:"Maximum number of players in a guild"}),(0,d.jsx)(t.td,{children:"4"}),(0,d.jsx)(t.td,{children:"Integer"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"REGION"}),(0,d.jsx)(t.td,{children:"Region"}),(0,d.jsx)(t.td,{}),(0,d.jsx)(t.td,{children:"String"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"USEAUTH"}),(0,d.jsx)(t.td,{children:"Use authentication"}),(0,d.jsx)(t.td,{children:"True"}),(0,d.jsx)(t.td,{children:"Boolean"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"BAN_LIST_URL"}),(0,d.jsx)(t.td,{children:"Which ban list to use"}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.a,{href:"https://api.palworldgame.com/api/banlist.txt",children:"https://api.palworldgame.com/api/banlist.txt"})}),(0,d.jsx)(t.td,{children:"string"})]})]})]}),"\n",(0,d.jsx)(t.h3,{id:"manually",children:"Manually"}),"\n",(0,d.jsxs)(t.p,{children:["When the server starts, a ",(0,d.jsx)(t.code,{children:"PalWorldSettings.ini"})," file will be created in the following location: ",(0,d.jsx)(t.code,{children:"/Pal/Saved/Config/LinuxServer/PalWorldSettings.ini"})]}),"\n",(0,d.jsxs)(t.p,{children:["Please keep in mind that the ENV variables will always overwrite the changes made to ",(0,d.jsx)(t.code,{children:"PalWorldSettings.ini"}),"."]}),"\n",(0,d.jsxs)(t.admonition,{type:"warning",children:[(0,d.jsxs)(t.p,{children:["Changes can only be made to ",(0,d.jsx)(t.code,{children:"PalWorldSettings.ini"})," while the server is off."]}),(0,d.jsx)(t.p,{children:"Any changes made while the server is live will be overwritten when the server stops."})]}),"\n",(0,d.jsxs)(t.p,{children:["For a more detailed list of server settings go to: ",(0,d.jsx)(t.a,{href:"https://palworld.wiki.gg/wiki/PalWorldSettings.ini",children:"Palworld Wiki"})]}),"\n",(0,d.jsxs)(t.p,{children:["For more detailed server settings explanations go to: ",(0,d.jsx)(t.a,{href:"https://shockbyte.com/billing/knowledgebase/1189/How-to-Configure-your-Palworld-server.html",children:"shockbyte"})]})]})}function x(e={}){const{wrapper:t}={...(0,n.M)(),...e.components};return t?(0,d.jsx)(t,{...e,children:(0,d.jsx)(a,{...e})}):a(e)}},2172:(e,t,r)=>{r.d(t,{I:()=>i,M:()=>l});var d=r(1504);const n={},s=d.createContext(n);function l(e){const t=d.useContext(s);return d.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:l(e.components),d.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c3826a0d.b461f91c.js b/assets/js/c3826a0d.b461f91c.js deleted file mode 100644 index c49ceba2c..000000000 --- a/assets/js/c3826a0d.b461f91c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocusaurus=self.webpackChunkdocusaurus||[]).push([[528],{2268:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>x,frontMatter:()=>l,metadata:()=>i,toc:()=>h});var d=r(7624),n=r(2172);const l={sidebar_position:2},s="Game Settings",i={id:"getting-started/configuration/game-settings",title:"Game Settings",description:"With Environment Variables",source:"@site/docs/getting-started/configuration/game-settings.md",sourceDirName:"getting-started/configuration",slug:"/getting-started/configuration/game-settings",permalink:"/getting-started/configuration/game-settings",draft:!1,unlisted:!1,editUrl:"https://github.com/thijsvanloef/palworld-server-docker/tree/main/docusaurus/docs/getting-started/configuration/game-settings.md",tags:[],version:"current",sidebarPosition:2,frontMatter:{sidebar_position:2},sidebar:"tutorialSidebar",previous:{title:"Server Settings",permalink:"/getting-started/configuration/server-settings"},next:{title:"Server Commands (RCON)",permalink:"/getting-started/configuration/server-commands"}},c={},h=[{value:"With Environment Variables",id:"with-environment-variables",level:2},{value:"Manually",id:"manually",level:3}];function a(e){const t={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",h3:"h3",li:"li",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,n.M)(),...e.components};return(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(t.h1,{id:"game-settings",children:"Game Settings"}),"\n",(0,d.jsx)(t.h2,{id:"with-environment-variables",children:"With Environment Variables"}),"\n",(0,d.jsxs)(t.admonition,{type:"warning",children:[(0,d.jsx)(t.p,{children:"These Environment Variables and Settings are subject to change since the game is still in beta."}),(0,d.jsxs)(t.p,{children:["Check out the ",(0,d.jsx)(t.a,{href:"https://tech.palworldgame.com/optimize-game-balance",children:"official webpage for the supported parameters."})]})]}),"\n",(0,d.jsx)(t.p,{children:"Converting server settings to environment variables follow the same principles (with some exceptions):"}),"\n",(0,d.jsxs)(t.ul,{children:["\n",(0,d.jsx)(t.li,{children:"all capital letters"}),"\n",(0,d.jsx)(t.li,{children:"split words by inserting an underscore"}),"\n",(0,d.jsx)(t.li,{children:"remove the single letter if the setting starts with one (like 'b')"}),"\n"]}),"\n",(0,d.jsx)(t.p,{children:"For example:"}),"\n",(0,d.jsxs)(t.ul,{children:["\n",(0,d.jsx)(t.li,{children:"Difficulty -> DIFFICULTY"}),"\n",(0,d.jsx)(t.li,{children:"PalSpawnNumRate -> PAL_SPAWN_NUM_RATE"}),"\n",(0,d.jsx)(t.li,{children:"bIsPvP -> IS_PVP"}),"\n"]}),"\n",(0,d.jsxs)(t.table,{children:[(0,d.jsx)(t.thead,{children:(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.th,{children:"Variable"}),(0,d.jsx)(t.th,{children:"Description"}),(0,d.jsx)(t.th,{children:"Default Value"}),(0,d.jsx)(t.th,{children:"Allowed Value"})]})}),(0,d.jsxs)(t.tbody,{children:[(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"DIFFICULTY"}),(0,d.jsx)(t.td,{children:"Game Difficulty"}),(0,d.jsx)(t.td,{children:"None"}),(0,d.jsxs)(t.td,{children:[(0,d.jsx)(t.code,{children:"None"}),",",(0,d.jsx)(t.code,{children:"Normal"}),",",(0,d.jsx)(t.code,{children:"Difficult"})]})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"DAYTIME_SPEEDRATE"}),(0,d.jsx)(t.td,{children:"Day time speed - Smaller number means shorter days"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"NIGHTTIME_SPEEDRATE"}),(0,d.jsx)(t.td,{children:"Night time speed - Smaller number means shorter nights"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"EXP_RATE"}),(0,d.jsx)(t.td,{children:"EXP earn rate"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"PAL_CAPTURE_RATE"}),(0,d.jsx)(t.td,{children:"Pal capture rate"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"PAL_SPAWN_NUM_RATE"}),(0,d.jsx)(t.td,{children:"Pal appearance rate"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"PAL_DAMAGE_RATE_ATTACK"}),(0,d.jsx)(t.td,{children:"Damage from pals multipiler"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"PAL_DAMAGE_RATE_DEFENSE"}),(0,d.jsx)(t.td,{children:"Damage to pals multipiler"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"PLAYER_DAMAGE_RATE_ATTACK"}),(0,d.jsx)(t.td,{children:"Damage from player multipiler"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"PLAYER_DAMAGE_RATE_DEFENSE"}),(0,d.jsx)(t.td,{children:"Damage to player multipiler"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"PLAYER_STOMACH_DECREASE_RATE"}),(0,d.jsx)(t.td,{children:"Player hunger depletion rate"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"PLAYER_STAMINA_DECREASE_RATE"}),(0,d.jsx)(t.td,{children:"Player stamina reduction rate"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"PLAYER_AUTO_HP_REGEN_RATE"}),(0,d.jsx)(t.td,{children:"Player auto HP regeneration rate"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"PLAYER_AUTO_HP_REGEN_RATE_IN_SLEEP"}),(0,d.jsx)(t.td,{children:"Player sleep HP regeneration rate"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"PAL_STOMACH_DECREASE_RATE"}),(0,d.jsx)(t.td,{children:"Pal hunger depletion rate"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"PAL_STAMINA_DECREASE_RATE"}),(0,d.jsx)(t.td,{children:"Pal stamina reduction rate"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"PAL_AUTO_HP_REGEN_RATE"}),(0,d.jsx)(t.td,{children:"Pal auto HP regeneration rate"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"PAL_AUTO_HP_REGEN_RATE_IN_SLEEP"}),(0,d.jsx)(t.td,{children:"Pal sleep health regeneration rate (in Palbox)"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"BUILD_OBJECT_DAMAGE_RATE"}),(0,d.jsx)(t.td,{children:"Damage to structure multipiler"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"BUILD_OBJECT_DETERIORATION_DAMAGE_RATE"}),(0,d.jsx)(t.td,{children:"Structure determination rate"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"COLLECTION_DROP_RATE"}),(0,d.jsx)(t.td,{children:"Getherable items multipiler"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"COLLECTION_OBJECT_HP_RATE"}),(0,d.jsx)(t.td,{children:"Getherable objects HP multipiler"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"COLLECTION_OBJECT_RESPAWN_SPEED_RATE"}),(0,d.jsx)(t.td,{children:"Getherable objects respawn interval - The smaller the number, the faster the regeneration"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"ENEMY_DROP_ITEM_RATE"}),(0,d.jsx)(t.td,{children:"Dropped Items Multipiler"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"DEATH_PENALTY"}),(0,d.jsx)(t.td,{children:"Death Penalty None: No death penalty Item: Drops items other than equipment ItemAndEquipment: Drops all items All: Drops all PALs and all items."}),(0,d.jsx)(t.td,{children:"All"}),(0,d.jsxs)(t.td,{children:[(0,d.jsx)(t.code,{children:"None"}),",",(0,d.jsx)(t.code,{children:"Item"}),",",(0,d.jsx)(t.code,{children:"ItemAndEquipment"}),",",(0,d.jsx)(t.code,{children:"All"})]})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"ENABLE_PLAYER_TO_PLAYER_DAMAGE"}),(0,d.jsx)(t.td,{children:"Allows players to cause damage to players"}),(0,d.jsx)(t.td,{children:"False"}),(0,d.jsx)(t.td,{children:"Boolean"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"ENABLE_FRIENDLY_FIRE"}),(0,d.jsx)(t.td,{children:"Allow friendly fire"}),(0,d.jsx)(t.td,{children:"False"}),(0,d.jsx)(t.td,{children:"Boolean"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"ENABLE_INVADER_ENEMY"}),(0,d.jsx)(t.td,{children:"Enable invaders"}),(0,d.jsx)(t.td,{children:"True"}),(0,d.jsx)(t.td,{children:"Boolean"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"ACTIVE_UNKO"}),(0,d.jsx)(t.td,{children:"Enable UNKO (?)"}),(0,d.jsx)(t.td,{children:"False"}),(0,d.jsx)(t.td,{children:"Boolean"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"ENABLE_AIM_ASSIST_PAD"}),(0,d.jsx)(t.td,{children:"Enable controller aim assist"}),(0,d.jsx)(t.td,{children:"True"}),(0,d.jsx)(t.td,{children:"Boolean"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"ENABLE_AIM_ASSIST_KEYBOARD"}),(0,d.jsx)(t.td,{children:"Enable Keyboard aim assist"}),(0,d.jsx)(t.td,{children:"False"}),(0,d.jsx)(t.td,{children:"Boolean"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"DROP_ITEM_MAX_NUM"}),(0,d.jsx)(t.td,{children:"Maximum number of drops in the world"}),(0,d.jsx)(t.td,{children:"3000"}),(0,d.jsx)(t.td,{children:"Integer"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"DROP_ITEM_MAX_NUM_UNKO"}),(0,d.jsx)(t.td,{children:"Maximum number of UNKO drops in the world"}),(0,d.jsx)(t.td,{children:"100"}),(0,d.jsx)(t.td,{children:"Integer"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"BASE_CAMP_MAX_NUM"}),(0,d.jsx)(t.td,{children:"Maximum number of base camps"}),(0,d.jsx)(t.td,{children:"128"}),(0,d.jsx)(t.td,{children:"Integer"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"BASE_CAMP_WORKER_MAX_NUM"}),(0,d.jsx)(t.td,{children:"Maximum number of workers"}),(0,d.jsx)(t.td,{children:"15"}),(0,d.jsx)(t.td,{children:"Integer"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"DROP_ITEM_ALIVE_MAX_HOURS"}),(0,d.jsx)(t.td,{children:"Time it takes for items to despawn in hours"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"AUTO_RESET_GUILD_NO_ONLINE_PLAYERS"}),(0,d.jsx)(t.td,{children:"Automatically reset guild when no players are online"}),(0,d.jsx)(t.td,{children:"False"}),(0,d.jsx)(t.td,{children:"Bool"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"AUTO_RESET_GUILD_TIME_NO_ONLINE_PLAYERS"}),(0,d.jsx)(t.td,{children:"Time to automatically reset guild when no players are online"}),(0,d.jsx)(t.td,{children:"72.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"GUILD_PLAYER_MAX_NUM"}),(0,d.jsx)(t.td,{children:"Max player of Guild"}),(0,d.jsx)(t.td,{children:"20"}),(0,d.jsx)(t.td,{children:"Integer"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"PAL_EGG_DEFAULT_HATCHING_TIME"}),(0,d.jsx)(t.td,{children:"Time(h) to incubate massive egg"}),(0,d.jsx)(t.td,{children:"72.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"WORK_SPEED_RATE"}),(0,d.jsx)(t.td,{children:"Work speed muliplier"}),(0,d.jsx)(t.td,{children:"1.000000"}),(0,d.jsx)(t.td,{children:"Float"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"IS_MULTIPLAY"}),(0,d.jsx)(t.td,{children:"Enable multiplayer"}),(0,d.jsx)(t.td,{children:"False"}),(0,d.jsx)(t.td,{children:"Boolean"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"IS_PVP"}),(0,d.jsx)(t.td,{children:"Enable PVP"}),(0,d.jsx)(t.td,{children:"False"}),(0,d.jsx)(t.td,{children:"Boolean"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"CAN_PICKUP_OTHER_GUILD_DEATH_PENALTY_DROP"}),(0,d.jsx)(t.td,{children:"Allow players from other guilds to pick up death penalty items"}),(0,d.jsx)(t.td,{children:"False"}),(0,d.jsx)(t.td,{children:"Boolean"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"ENABLE_NON_LOGIN_PENALTY"}),(0,d.jsx)(t.td,{children:"Enable non-login penalty"}),(0,d.jsx)(t.td,{children:"True"}),(0,d.jsx)(t.td,{children:"Boolean"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"ENABLE_FAST_TRAVEL"}),(0,d.jsx)(t.td,{children:"Enable fast travel"}),(0,d.jsx)(t.td,{children:"True"}),(0,d.jsx)(t.td,{children:"Boolean"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"IS_START_LOCATION_SELECT_BY_MAP"}),(0,d.jsx)(t.td,{children:"Enable selecting of start location"}),(0,d.jsx)(t.td,{children:"True"}),(0,d.jsx)(t.td,{children:"Boolean"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"EXIST_PLAYER_AFTER_LOGOUT"}),(0,d.jsx)(t.td,{children:"Toggle for deleting players when they log off"}),(0,d.jsx)(t.td,{children:"False"}),(0,d.jsx)(t.td,{children:"Boolean"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"ENABLE_DEFENSE_OTHER_GUILD_PLAYER"}),(0,d.jsx)(t.td,{children:"Allows defense against other guild players"}),(0,d.jsx)(t.td,{children:"False"}),(0,d.jsx)(t.td,{children:"Boolean"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"COOP_PLAYER_MAX_NUM"}),(0,d.jsx)(t.td,{children:"Maximum number of players in a guild"}),(0,d.jsx)(t.td,{children:"4"}),(0,d.jsx)(t.td,{children:"Integer"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"REGION"}),(0,d.jsx)(t.td,{children:"Region"}),(0,d.jsx)(t.td,{}),(0,d.jsx)(t.td,{children:"String"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"USEAUTH"}),(0,d.jsx)(t.td,{children:"Use authentication"}),(0,d.jsx)(t.td,{children:"True"}),(0,d.jsx)(t.td,{children:"Boolean"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"BAN_LIST_URL"}),(0,d.jsx)(t.td,{children:"Which ban list to use"}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.a,{href:"https://api.palworldgame.com/api/banlist.txt",children:"https://api.palworldgame.com/api/banlist.txt"})}),(0,d.jsx)(t.td,{children:"string"})]})]})]}),"\n",(0,d.jsx)(t.h3,{id:"manually",children:"Manually"}),"\n",(0,d.jsxs)(t.p,{children:["When the server starts, a ",(0,d.jsx)(t.code,{children:"PalWorldSettings.ini"})," file will be created in the following location: ",(0,d.jsx)(t.code,{children:"/Pal/Saved/Config/LinuxServer/PalWorldSettings.ini"})]}),"\n",(0,d.jsxs)(t.p,{children:["Please keep in mind that the ENV variables will always overwrite the changes made to ",(0,d.jsx)(t.code,{children:"PalWorldSettings.ini"}),"."]}),"\n",(0,d.jsxs)(t.admonition,{type:"warning",children:[(0,d.jsxs)(t.p,{children:["Changes can only be made to ",(0,d.jsx)(t.code,{children:"PalWorldSettings.ini"})," while the server is off."]}),(0,d.jsx)(t.p,{children:"Any changes made while the server is live will be overwritten when the server stops."})]}),"\n",(0,d.jsxs)(t.p,{children:["For a more detailed list of server settings go to: ",(0,d.jsx)(t.a,{href:"https://palworld.wiki.gg/wiki/PalWorldSettings.ini",children:"Palworld Wiki"})]}),"\n",(0,d.jsxs)(t.p,{children:["For more detailed server settings explanations go to: ",(0,d.jsx)(t.a,{href:"https://shockbyte.com/billing/knowledgebase/1189/How-to-Configure-your-Palworld-server.html",children:"shockbyte"})]})]})}function x(e={}){const{wrapper:t}={...(0,n.M)(),...e.components};return t?(0,d.jsx)(t,{...e,children:(0,d.jsx)(a,{...e})}):a(e)}},2172:(e,t,r)=>{r.d(t,{I:()=>i,M:()=>s});var d=r(1504);const n={},l=d.createContext(n);function s(e){const t=d.useContext(l);return d.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:s(e.components),d.createElement(l.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d506b4f4.b1c58929.js b/assets/js/d506b4f4.b1c58929.js new file mode 100644 index 000000000..0cbd43c2a --- /dev/null +++ b/assets/js/d506b4f4.b1c58929.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocusaurus=self.webpackChunkdocusaurus||[]).push([[536],{3128:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>h,frontMatter:()=>s,metadata:()=>d,toc:()=>a});var r=o(7624),n=o(2172);const s={sidebar_position:4},i="Automatic Reboots",d={id:"guides/automatic-reboots",title:"Automatic Reboots",description:"Configuring Automatic Reboots with Cron",source:"@site/docs/guides/automatic-reboots.md",sourceDirName:"guides",slug:"/guides/automatic-reboots",permalink:"/guides/automatic-reboots",draft:!1,unlisted:!1,editUrl:"https://github.com/thijsvanloef/palworld-server-docker/tree/main/docusaurus/docs/guides/automatic-reboots.md",tags:[],version:"current",sidebarPosition:4,frontMatter:{sidebar_position:4},sidebar:"tutorialSidebar",previous:{title:"Using discord webhooks",permalink:"/guides/discord/discord-webhooks"},next:{title:"Automatic Updates",permalink:"/guides/automatic-updates"}},c={},a=[{value:"Configuring Automatic Reboots with Cron",id:"configuring-automatic-reboots-with-cron",level:2}];function l(e){const t={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",li:"li",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,n.M)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"automatic-reboots",children:"Automatic Reboots"}),"\n",(0,r.jsx)(t.h2,{id:"configuring-automatic-reboots-with-cron",children:"Configuring Automatic Reboots with Cron"}),"\n",(0,r.jsxs)(t.p,{children:["To be able to use automatic reboots with this Server the following environment variables ",(0,r.jsx)(t.strong,{children:"have"})," to be set to ",(0,r.jsx)(t.code,{children:"true"}),":"]}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.code,{children:"RCON_ENABLED"})}),"\n"]}),"\n",(0,r.jsxs)(t.admonition,{type:"warning",children:[(0,r.jsxs)(t.p,{children:["If docker restart is not set to policy ",(0,r.jsx)(t.code,{children:"always"})," or ",(0,r.jsx)(t.code,{children:"unless-stopped"}),"\nthen the server will shutdown and will need to be manually restarted."]}),(0,r.jsxs)(t.p,{children:["The example docker run command and docker compose file in ",(0,r.jsx)(t.a,{href:"https://palworld-server-docker.loef.dev/",children:"the Quicksetup"}),"\nalready use the needed policy"]})]}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Variable"}),(0,r.jsx)(t.th,{children:"Info"}),(0,r.jsx)(t.th,{children:"Default Values"}),(0,r.jsx)(t.th,{children:"Allowed Values"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"AUTO_REBOOT_CRON_EXPRESSION"}),(0,r.jsx)(t.td,{children:"Setting affects frequency of automatic updates."}),(0,r.jsx)(t.td,{children:"0 0 * * *"}),(0,r.jsxs)(t.td,{children:["Needs a Cron-Expression - See ",(0,r.jsx)(t.a,{href:"#configuring-automatic-reboots-with-cron",children:"Configuring Automatic Backups with Cron"})]})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"AUTO_REBOOT_ENABLED"}),(0,r.jsx)(t.td,{children:"Enables automatic reboots"}),(0,r.jsx)(t.td,{children:"false"}),(0,r.jsx)(t.td,{children:"true/false"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"AUTO_REBOOT_WARN_MINUTES"}),(0,r.jsx)(t.td,{children:"How long to wait to reboot the server, after the player were informed."}),(0,r.jsx)(t.td,{children:"5"}),(0,r.jsx)(t.td,{children:"!0"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"AUTO_REBOOT_EVEN_IF_PLAYERS_ONLINE"}),(0,r.jsx)(t.td,{children:"Restart the Server even if there are players online."}),(0,r.jsx)(t.td,{children:"false"}),(0,r.jsx)(t.td,{children:"true/false"})]})]})]}),"\n",(0,r.jsx)(t.admonition,{type:"tip",children:(0,r.jsxs)(t.p,{children:["This image uses Supercronic for crons\nsee ",(0,r.jsx)(t.a,{href:"https://github.com/aptible/supercronic#crontab-format",children:"supercronic"}),"\nor ",(0,r.jsx)(t.a,{href:"https://crontab-generator.org",children:"Crontab Generator"}),"."]})}),"\n",(0,r.jsxs)(t.p,{children:["Set ",(0,r.jsx)(t.code,{children:"AUTO_REBOOT_CRON_EXPRESSION"})," to change the set the schedule, default is everynight at midnight according to the\ntimezone set with TZ"]})]})}function h(e={}){const{wrapper:t}={...(0,n.M)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},2172:(e,t,o)=>{o.d(t,{I:()=>d,M:()=>i});var r=o(1504);const n={},s=r.createContext(n);function i(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function d(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:i(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d506b4f4.efb31684.js b/assets/js/d506b4f4.efb31684.js deleted file mode 100644 index b0b96b9a1..000000000 --- a/assets/js/d506b4f4.efb31684.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocusaurus=self.webpackChunkdocusaurus||[]).push([[536],{3128:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>a,contentTitle:()=>r,default:()=>l,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var n=o(7624),i=o(2172);const s={sidebar_position:4},r="Automatic Reboots",c={id:"guides/automatic-reboots",title:"Automatic Reboots",description:"Configuring Automatic Reboots with Cron",source:"@site/docs/guides/automatic-reboots.md",sourceDirName:"guides",slug:"/guides/automatic-reboots",permalink:"/guides/automatic-reboots",draft:!1,unlisted:!1,editUrl:"https://github.com/thijsvanloef/palworld-server-docker/tree/main/docusaurus/docs/guides/automatic-reboots.md",tags:[],version:"current",sidebarPosition:4,frontMatter:{sidebar_position:4},sidebar:"tutorialSidebar",previous:{title:"Using discord webhooks",permalink:"/guides/discord/discord-webhooks"},next:{title:"Automatic Updates",permalink:"/guides/automatic-updates"}},a={},d=[{value:"Configuring Automatic Reboots with Cron",id:"configuring-automatic-reboots-with-cron",level:2}];function u(e){const t={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",p:"p",...(0,i.M)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"automatic-reboots",children:"Automatic Reboots"}),"\n",(0,n.jsx)(t.h2,{id:"configuring-automatic-reboots-with-cron",children:"Configuring Automatic Reboots with Cron"}),"\n",(0,n.jsxs)(t.p,{children:["To be able to use automatic reboots with this server ",(0,n.jsx)(t.code,{children:"RCON_ENABLED"})," enabled."]}),"\n",(0,n.jsxs)(t.admonition,{type:"warning",children:[(0,n.jsxs)(t.p,{children:["If docker restart is not set to policy ",(0,n.jsx)(t.code,{children:"always"})," or ",(0,n.jsx)(t.code,{children:"unless-stopped"}),"\nthen the server will shutdown and will need to be manually restarted."]}),(0,n.jsxs)(t.p,{children:["The example docker run command and docker compose file in ",(0,n.jsx)(t.a,{href:"https://palworld-server-docker.loef.dev/",children:"the Quicksetup"}),"\nalready use the needed policy"]})]}),"\n",(0,n.jsxs)(t.p,{children:["Set ",(0,n.jsx)(t.code,{children:"AUTO_REBOOT_ENABLED"})," to ",(0,n.jsx)(t.code,{children:"true"})," or ",(0,n.jsx)(t.code,{children:"false"})," to enable or disable automatic reboots (Default is disabled)"]}),"\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.code,{children:"AUTO_REBOOT_CRON_EXPRESSION"})," is a cron expression, in a Cron-Expression you define an interval for when to run jobs."]}),"\n",(0,n.jsx)(t.admonition,{type:"tip",children:(0,n.jsxs)(t.p,{children:["This image uses Supercronic for crons\nsee ",(0,n.jsx)(t.a,{href:"https://github.com/aptible/supercronic#crontab-format",children:"supercronic"}),"\nor ",(0,n.jsx)(t.a,{href:"https://crontab-generator.org",children:"Crontab Generator"}),"."]})}),"\n",(0,n.jsxs)(t.p,{children:["Set ",(0,n.jsx)(t.code,{children:"AUTO_REBOOT_CRON_EXPRESSION"})," to change the set the schedule, default is everynight at midnight according to the\ntimezone set with TZ"]})]})}function l(e={}){const{wrapper:t}={...(0,i.M)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(u,{...e})}):u(e)}},2172:(e,t,o)=>{o.d(t,{I:()=>c,M:()=>r});var n=o(1504);const i={},s=n.createContext(i);function r(e){const t=n.useContext(s);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),n.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e2835484.0d597990.js b/assets/js/e2835484.0d597990.js deleted file mode 100644 index d6ae62c44..000000000 --- a/assets/js/e2835484.0d597990.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocusaurus=self.webpackChunkdocusaurus||[]).push([[704],{4724:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>a,default:()=>u,frontMatter:()=>i,metadata:()=>r,toc:()=>l});var t=s(7624),o=s(2172);const i={sidebar_position:5},a="Known Issues",r={id:"known-issues/known-issues",title:"Known Issues",description:"Broadcast command can only send 1 word",source:"@site/docs/known-issues/known-issues.md",sourceDirName:"known-issues",slug:"/known-issues/",permalink:"/known-issues/",draft:!1,unlisted:!1,editUrl:"https://github.com/thijsvanloef/palworld-server-docker/tree/main/docusaurus/docs/known-issues/known-issues.md",tags:[],version:"current",sidebarPosition:5,frontMatter:{sidebar_position:5},sidebar:"tutorialSidebar",previous:{title:"Versions",permalink:"/versions/"}},d={},l=[{value:"Broadcast command can only send 1 word",id:"broadcast-command-can-only-send-1-word",level:2},{value:"XBox GamePass players unable to join",id:"xbox-gamepass-players-unable-to-join",level:2},{value:"[S_API FAIL]",id:"s_api-fail",level:2},{value:"Setting breakpad minidump AppID = 2394010",id:"setting-breakpad-minidump-appid--2394010",level:2},{value:"FAQ",id:"faq",level:2}];function c(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",li:"li",p:"p",pre:"pre",ul:"ul",...(0,o.M)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"known-issues",children:"Known Issues"}),"\n",(0,t.jsx)(n.h2,{id:"broadcast-command-can-only-send-1-word",children:"Broadcast command can only send 1 word"}),"\n",(0,t.jsx)(n.p,{children:"When using Broadcast among RCON's functions, only one word is transmitted."}),"\n",(0,t.jsx)(n.p,{children:"As an example, if I use:"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:'docker exec -it palworld-server rcon-cli Broadcast "Hello world"'})}),"\n",(0,t.jsx)(n.p,{children:"only Hello is transmitted."}),"\n",(0,t.jsx)(n.h2,{id:"xbox-gamepass-players-unable-to-join",children:"XBox GamePass players unable to join"}),"\n",(0,t.jsx)(n.p,{children:"At the moment, Xbox Gamepass/Xbox Console players will not be able to join a dedicated server."}),"\n",(0,t.jsx)(n.p,{children:"They will need to join players using the invite code and are limited to sessions of 4 players max."}),"\n",(0,t.jsx)(n.h2,{id:"s_api-fail",children:"[S_API FAIL]"}),"\n",(0,t.jsx)(n.p,{children:"The server will sometimes output the following error:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"[S_API FAIL] Tried to access Steam interface SteamUser021 before SteamAPI_Init succeeded.\n[S_API FAIL] Tried to access Steam interface SteamFriends017 before SteamAPI_Init succeeded.\n[S_API FAIL] Tried to access Steam interface STEAMAPPS_INTERFACE_VERSION008 before SteamAPI_Init succeeded.\n[S_API FAIL] Tried to access Steam interface SteamNetworkingUtils004 before SteamAPI_Init succeeded.\n"})}),"\n",(0,t.jsx)(n.p,{children:"This can safely be ignored and will not impact the server."}),"\n",(0,t.jsx)(n.h2,{id:"setting-breakpad-minidump-appid--2394010",children:"Setting breakpad minidump AppID = 2394010"}),"\n",(0,t.jsx)(n.p,{children:"This means that the server is up and running, if you still can't connect to it,\nit means that you'll need to look at the following:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"Firewall settings, make sure that you allow port 8211/udp and 27015/udp through your firewall"}),"\n",(0,t.jsx)(n.li,{children:"Make sure you've correctly port forwarded your 8211/udp 27015/udp"}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"faq",children:"FAQ"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://gist.github.com/Toakan/3c78a577c21a21fcc5fa917f3021d70e#file-palworld-server-faq-community-md",children:"A useful FAQ that gets updated regularly"})})]})}function u(e={}){const{wrapper:n}={...(0,o.M)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(c,{...e})}):c(e)}},2172:(e,n,s)=>{s.d(n,{I:()=>r,M:()=>a});var t=s(1504);const o={},i=t.createContext(o);function a(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e2835484.87af890a.js b/assets/js/e2835484.87af890a.js new file mode 100644 index 000000000..22354e9e0 --- /dev/null +++ b/assets/js/e2835484.87af890a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocusaurus=self.webpackChunkdocusaurus||[]).push([[704],{4724:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>a,default:()=>u,frontMatter:()=>t,metadata:()=>r,toc:()=>l});var i=s(7624),o=s(2172);const t={sidebar_position:5},a="Known Issues",r={id:"known-issues/known-issues",title:"Known Issues",description:"Known issues of using this Docker image.",source:"@site/docs/known-issues/known-issues.md",sourceDirName:"known-issues",slug:"/known-issues/",permalink:"/known-issues/",draft:!1,unlisted:!1,editUrl:"https://github.com/thijsvanloef/palworld-server-docker/tree/main/docusaurus/docs/known-issues/known-issues.md",tags:[],version:"current",sidebarPosition:5,frontMatter:{sidebar_position:5},sidebar:"tutorialSidebar",previous:{title:"Versions",permalink:"/versions/"}},d={},l=[{value:"Broadcast command can only send 1 word",id:"broadcast-command-can-only-send-1-word",level:2},{value:"XBox GamePass players unable to join",id:"xbox-gamepass-players-unable-to-join",level:2},{value:"[S_API FAIL]",id:"s_api-fail",level:2},{value:"Setting breakpad minidump AppID = 2394010",id:"setting-breakpad-minidump-appid--2394010",level:2},{value:"FAQ",id:"faq",level:2}];function c(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",li:"li",p:"p",pre:"pre",ul:"ul",...(0,o.M)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"known-issues",children:"Known Issues"}),"\n",(0,i.jsx)(n.p,{children:"Known issues of using this Docker image."}),"\n",(0,i.jsx)(n.h2,{id:"broadcast-command-can-only-send-1-word",children:"Broadcast command can only send 1 word"}),"\n",(0,i.jsx)(n.p,{children:"When using Broadcast among RCON's functions, only one word is transmitted."}),"\n",(0,i.jsx)(n.p,{children:"As an example, if I use:"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:'docker exec -it palworld-server rcon-cli Broadcast "Hello world"'})}),"\n",(0,i.jsx)(n.p,{children:"only Hello is transmitted."}),"\n",(0,i.jsx)(n.h2,{id:"xbox-gamepass-players-unable-to-join",children:"XBox GamePass players unable to join"}),"\n",(0,i.jsx)(n.p,{children:"At the moment, Xbox Gamepass/Xbox Console players will not be able to join a dedicated server."}),"\n",(0,i.jsx)(n.p,{children:"They will need to join players using the invite code and are limited to sessions of 4 players max."}),"\n",(0,i.jsx)(n.h2,{id:"s_api-fail",children:"[S_API FAIL]"}),"\n",(0,i.jsx)(n.p,{children:"The server will sometimes output the following error:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-bash",children:"[S_API FAIL] Tried to access Steam interface SteamUser021 before SteamAPI_Init succeeded.\n[S_API FAIL] Tried to access Steam interface SteamFriends017 before SteamAPI_Init succeeded.\n[S_API FAIL] Tried to access Steam interface STEAMAPPS_INTERFACE_VERSION008 before SteamAPI_Init succeeded.\n[S_API FAIL] Tried to access Steam interface SteamNetworkingUtils004 before SteamAPI_Init succeeded.\n"})}),"\n",(0,i.jsx)(n.p,{children:"This can safely be ignored and will not impact the server."}),"\n",(0,i.jsx)(n.h2,{id:"setting-breakpad-minidump-appid--2394010",children:"Setting breakpad minidump AppID = 2394010"}),"\n",(0,i.jsx)(n.p,{children:"This means that the server is up and running, if you still can't connect to it,\nit means that you'll need to look at the following:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Firewall settings, make sure that you allow port 8211/udp and 27015/udp through your firewall"}),"\n",(0,i.jsx)(n.li,{children:"Make sure you've correctly port forwarded your 8211/udp 27015/udp"}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"faq",children:"FAQ"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://gist.github.com/Toakan/3c78a577c21a21fcc5fa917f3021d70e#file-palworld-server-faq-community-md",children:"A useful FAQ that gets updated regularly"})})]})}function u(e={}){const{wrapper:n}={...(0,o.M)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},2172:(e,n,s)=>{s.d(n,{I:()=>r,M:()=>a});var i=s(1504);const o={},t=i.createContext(o);function a(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.062fb50f.js b/assets/js/runtime~main.062fb50f.js new file mode 100644 index 000000000..4b4958c04 --- /dev/null +++ b/assets/js/runtime~main.062fb50f.js @@ -0,0 +1 @@ +(()=>{"use strict";var e,a,t,r,f,o={},n={};function c(e){var a=n[e];if(void 0!==a)return a.exports;var t=n[e]={id:e,loaded:!1,exports:{}};return o[e].call(t.exports,t,t.exports,c),t.loaded=!0,t.exports}c.m=o,c.c=n,e=[],c.O=(a,t,r,f)=>{if(!t){var o=1/0;for(u=0;u=f)&&Object.keys(c.O).every((e=>c.O[e](t[d])))?t.splice(d--,1):(n=!1,f0&&e[u-1][2]>f;u--)e[u]=e[u-1];e[u]=[t,r,f]},c.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return c.d(a,{a:a}),a},t=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,c.t=function(e,r){if(1&r&&(e=this(e)),8&r)return e;if("object"==typeof e&&e){if(4&r&&e.__esModule)return e;if(16&r&&"function"==typeof e.then)return e}var f=Object.create(null);c.r(f);var o={};a=a||[null,t({}),t([]),t(t)];for(var n=2&r&&e;"object"==typeof n&&!~a.indexOf(n);n=t(n))Object.getOwnPropertyNames(n).forEach((a=>o[a]=()=>e[a]));return o.default=()=>e,c.d(f,o),f},c.d=(e,a)=>{for(var t in a)c.o(a,t)&&!c.o(e,t)&&Object.defineProperty(e,t,{enumerable:!0,get:a[t]})},c.f={},c.e=e=>Promise.all(Object.keys(c.f).reduce(((a,t)=>(c.f[t](e,a),a)),[])),c.u=e=>"assets/js/"+({84:"db373f69",88:"3f1e559a",160:"7a181475",176:"12e5e4b2",304:"5e95c892",348:"a9f89893",356:"582288e3",384:"8a6a27d2",412:"9c401ef1",464:"8de80f25",500:"a7bd4aaa",528:"c3826a0d",536:"d506b4f4",540:"8482a3f6",560:"6fca854b",576:"14eb3368",606:"f87e4a5f",608:"3ff43f10",612:"ca732820",648:"1a4e3797",666:"a94703ab",680:"712f1aaf",696:"935f2afb",704:"e2835484",752:"17896441",764:"c19f478c",840:"729a6696",992:"9035fd2b",995:"759d9c7b"}[e]||e)+"."+{84:"7774c58e",88:"a6058c5c",148:"acc93b26",160:"aaeb1e69",176:"20c40e5a",304:"9275e255",348:"85a5d6c3",356:"c8d1ae8a",384:"c2cc6629",412:"6b113b87",464:"64c6aaeb",500:"fef65725",528:"6d2b5b24",536:"b1c58929",540:"a5a9b831",552:"d5eb58f9",560:"9eb4e69b",576:"15a339bb",606:"a6450d4f",608:"ee8336bf",612:"d5b0e41e",648:"93a18484",666:"b4c064cc",676:"6ea46a13",680:"69c5d896",696:"7f727e0d",704:"87af890a",752:"0395c55d",764:"34919d50",840:"e75f2cfb",879:"4f0b6466",992:"c5d829b4",995:"4e4b102f"}[e]+".js",c.miniCssF=e=>{},c.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),c.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),r={},f="docusaurus:",c.l=(e,a,t,o)=>{if(r[e])r[e].push(a);else{var n,d;if(void 0!==t)for(var i=document.getElementsByTagName("script"),u=0;u{n.onerror=n.onload=null,clearTimeout(s);var f=r[e];if(delete r[e],n.parentNode&&n.parentNode.removeChild(n),f&&f.forEach((e=>e(t))),a)return a(t)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:n}),12e4);n.onerror=l.bind(null,n.onerror),n.onload=l.bind(null,n.onload),d&&document.head.appendChild(n)}},c.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},c.p="/",c.gca=function(e){return e={17896441:"752",db373f69:"84","3f1e559a":"88","7a181475":"160","12e5e4b2":"176","5e95c892":"304",a9f89893:"348","582288e3":"356","8a6a27d2":"384","9c401ef1":"412","8de80f25":"464",a7bd4aaa:"500",c3826a0d:"528",d506b4f4:"536","8482a3f6":"540","6fca854b":"560","14eb3368":"576",f87e4a5f:"606","3ff43f10":"608",ca732820:"612","1a4e3797":"648",a94703ab:"666","712f1aaf":"680","935f2afb":"696",e2835484:"704",c19f478c:"764","729a6696":"840","9035fd2b":"992","759d9c7b":"995"}[e]||e,c.p+c.u(e)},(()=>{var e={296:0,556:0};c.f.j=(a,t)=>{var r=c.o(e,a)?e[a]:void 0;if(0!==r)if(r)t.push(r[2]);else if(/^(29|55)6$/.test(a))e[a]=0;else{var f=new Promise(((t,f)=>r=e[a]=[t,f]));t.push(r[2]=f);var o=c.p+c.u(a),n=new Error;c.l(o,(t=>{if(c.o(e,a)&&(0!==(r=e[a])&&(e[a]=void 0),r)){var f=t&&("load"===t.type?"missing":t.type),o=t&&t.target&&t.target.src;n.message="Loading chunk "+a+" failed.\n("+f+": "+o+")",n.name="ChunkLoadError",n.type=f,n.request=o,r[1](n)}}),"chunk-"+a,a)}},c.O.j=a=>0===e[a];var a=(a,t)=>{var r,f,o=t[0],n=t[1],d=t[2],i=0;if(o.some((a=>0!==e[a]))){for(r in n)c.o(n,r)&&(c.m[r]=n[r]);if(d)var u=d(c)}for(a&&a(t);i{"use strict";var e,a,t,r,f,o={},n={};function d(e){var a=n[e];if(void 0!==a)return a.exports;var t=n[e]={id:e,loaded:!1,exports:{}};return o[e].call(t.exports,t,t.exports,d),t.loaded=!0,t.exports}d.m=o,d.c=n,e=[],d.O=(a,t,r,f)=>{if(!t){var o=1/0;for(u=0;u=f)&&Object.keys(d.O).every((e=>d.O[e](t[c])))?t.splice(c--,1):(n=!1,f0&&e[u-1][2]>f;u--)e[u]=e[u-1];e[u]=[t,r,f]},d.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return d.d(a,{a:a}),a},t=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,d.t=function(e,r){if(1&r&&(e=this(e)),8&r)return e;if("object"==typeof e&&e){if(4&r&&e.__esModule)return e;if(16&r&&"function"==typeof e.then)return e}var f=Object.create(null);d.r(f);var o={};a=a||[null,t({}),t([]),t(t)];for(var n=2&r&&e;"object"==typeof n&&!~a.indexOf(n);n=t(n))Object.getOwnPropertyNames(n).forEach((a=>o[a]=()=>e[a]));return o.default=()=>e,d.d(f,o),f},d.d=(e,a)=>{for(var t in a)d.o(a,t)&&!d.o(e,t)&&Object.defineProperty(e,t,{enumerable:!0,get:a[t]})},d.f={},d.e=e=>Promise.all(Object.keys(d.f).reduce(((a,t)=>(d.f[t](e,a),a)),[])),d.u=e=>"assets/js/"+({84:"db373f69",88:"3f1e559a",160:"7a181475",176:"12e5e4b2",304:"5e95c892",348:"a9f89893",356:"582288e3",384:"8a6a27d2",412:"9c401ef1",464:"8de80f25",500:"a7bd4aaa",528:"c3826a0d",536:"d506b4f4",540:"8482a3f6",560:"6fca854b",576:"14eb3368",606:"f87e4a5f",608:"3ff43f10",612:"ca732820",648:"1a4e3797",666:"a94703ab",680:"712f1aaf",696:"935f2afb",704:"e2835484",752:"17896441",764:"c19f478c",840:"729a6696",992:"9035fd2b",995:"759d9c7b"}[e]||e)+"."+{84:"7774c58e",88:"a6058c5c",148:"acc93b26",160:"cc93f103",176:"20c40e5a",304:"9275e255",348:"85a5d6c3",356:"c8d1ae8a",384:"b979a34c",412:"6b113b87",464:"64c6aaeb",500:"fef65725",528:"b461f91c",536:"efb31684",540:"a943e2dd",552:"d5eb58f9",560:"9eb4e69b",576:"15a339bb",606:"a6450d4f",608:"ee8336bf",612:"d5b0e41e",648:"93a18484",666:"b4c064cc",676:"6ea46a13",680:"69c5d896",696:"46d74570",704:"0d597990",752:"0395c55d",764:"34919d50",840:"e75f2cfb",879:"4f0b6466",992:"c5d829b4",995:"4e4b102f"}[e]+".js",d.miniCssF=e=>{},d.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),d.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),r={},f="docusaurus:",d.l=(e,a,t,o)=>{if(r[e])r[e].push(a);else{var n,c;if(void 0!==t)for(var i=document.getElementsByTagName("script"),u=0;u{n.onerror=n.onload=null,clearTimeout(s);var f=r[e];if(delete r[e],n.parentNode&&n.parentNode.removeChild(n),f&&f.forEach((e=>e(t))),a)return a(t)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:n}),12e4);n.onerror=l.bind(null,n.onerror),n.onload=l.bind(null,n.onload),c&&document.head.appendChild(n)}},d.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},d.p="/",d.gca=function(e){return e={17896441:"752",db373f69:"84","3f1e559a":"88","7a181475":"160","12e5e4b2":"176","5e95c892":"304",a9f89893:"348","582288e3":"356","8a6a27d2":"384","9c401ef1":"412","8de80f25":"464",a7bd4aaa:"500",c3826a0d:"528",d506b4f4:"536","8482a3f6":"540","6fca854b":"560","14eb3368":"576",f87e4a5f:"606","3ff43f10":"608",ca732820:"612","1a4e3797":"648",a94703ab:"666","712f1aaf":"680","935f2afb":"696",e2835484:"704",c19f478c:"764","729a6696":"840","9035fd2b":"992","759d9c7b":"995"}[e]||e,d.p+d.u(e)},(()=>{var e={296:0,556:0};d.f.j=(a,t)=>{var r=d.o(e,a)?e[a]:void 0;if(0!==r)if(r)t.push(r[2]);else if(/^(29|55)6$/.test(a))e[a]=0;else{var f=new Promise(((t,f)=>r=e[a]=[t,f]));t.push(r[2]=f);var o=d.p+d.u(a),n=new Error;d.l(o,(t=>{if(d.o(e,a)&&(0!==(r=e[a])&&(e[a]=void 0),r)){var f=t&&("load"===t.type?"missing":t.type),o=t&&t.target&&t.target.src;n.message="Loading chunk "+a+" failed.\n("+f+": "+o+")",n.name="ChunkLoadError",n.type=f,n.request=o,r[1](n)}}),"chunk-"+a,a)}},d.O.j=a=>0===e[a];var a=(a,t)=>{var r,f,o=t[0],n=t[1],c=t[2],i=0;if(o.some((a=>0!==e[a]))){for(r in n)d.o(n,r)&&(d.m[r]=n[r]);if(c)var u=c(d)}for(a&&a(t);i