Skip to content

Commit

Permalink
Merge pull request #361 from thijsvanloef/docusaurus
Browse files Browse the repository at this point in the history 
Add Docusaurus wiki
  • Loading branch information
@thijsvanloef
thijsvanloef authored Feb 11, 2024
2 parents a67ca13 + 6275ad1 commit a05392a
Show file tree
Hide file tree
Showing 32 changed files with 15,723 additions and 0 deletions.
38 changes: 38 additions & 0 deletions .github/workflows/docusaurus-deploy.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: Docs

on: # yamllint disable-line rule:truthy
push:
branches:
- main

permissions:
contents: write

jobs:
deploy:
name: Docusaurus - Deploy
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-node@v4
with:
node-version: 18
cache: npm
cache-dependency-path: './docusaurus/package-lock.json'

- name: Install dependencies
run: npm ci --prefix ./docusaurus
- name: Build website
run: npm run build --prefix ./docusaurus

- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docusaurus/build
user_name: github-actions[bot]
user_email: 41898282+github-actions[bot]@users.noreply.github.com
cname: palworld-server-docker.loef.dev
29 changes: 29 additions & 0 deletions .github/workflows/docusaurus-test.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: Docs

on: # yamllint disable-line rule:truthy
pull_request:
branches:
- main

permissions:
contents: write

jobs:
deploy:
name: Docusaurus - Test Deploy
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-node@v4
with:
node-version: 18
cache: npm
cache-dependency-path: './docusaurus/package-lock.json'

- name: Install dependencies
run: npm ci --prefix ./docusaurus
- name: Build website
run: npm run build --prefix ./docusaurus
20 changes: 20 additions & 0 deletions docusaurus/.gitignore
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Dependencies
/node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
43 changes: 43 additions & 0 deletions docusaurus/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Website

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.

## Installation

```bash
yarn
```

## Local Development

```bash
yarn start
```

This command starts a local development server and opens up a browser window.
Most changes are reflected live without having to restart the server.

## Build

```bash
yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

## Deployment

Using SSH:

```bash
USE_SSH=true yarn deploy
```

Not using SSH:

```bash
GIT_USER=<Your GitHub username> yarn deploy
```

If you are using GitHub pages for hosting,
this command is a convenient way to build the website and push to the `gh-pages` branch.
3 changes: 3 additions & 0 deletions docusaurus/babel.config.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
};
7 changes: 7 additions & 0 deletions docusaurus/docs/advanced/_category_.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"label": "Advanced",
"position": 3,
"link": {
"type": "generated-index"
}
}
21 changes: 21 additions & 0 deletions docusaurus/docs/advanced/kubernetes.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
sidebar_position: 1
---

# Kubernetes

All files you will need to deploy this container to kubernetes are located in the [k8s folder](https://github.com/thijsvanloef/palworld-server-docker/tree/main/k8s).

## Setup Palworld in kubernetes

Use the following commands to setup this Palworld container in Kubernetes:

* `kubectl apply -f pvc.yaml`
* `kubectl apply -f configmap.yaml`
* `kubectl apply -f secret.yaml`
* `kubectl apply -f service.yaml`
* `kubectl apply -f deployment.yaml`

## Using helm chart

The official helm chart can be found in a seperate repository, [palworld-server-chart](https://github.com/Twinki14/palworld-server-chart)
7 changes: 7 additions & 0 deletions docusaurus/docs/getting-started/_category_.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"label": "Getting Started",
"position": 1,
"link": {
"type": "generated-index"
}
}
7 changes: 7 additions & 0 deletions docusaurus/docs/getting-started/configuration/_category_.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"label": "Configuration",
"position": 3,
"link": {
"type": "generated-index"
}
}
97 changes: 97 additions & 0 deletions docusaurus/docs/getting-started/configuration/game-settings.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
---
sidebar_position: 2
---

# Game Settings

## With Environment Variables

:::warning
These Environment Variables and Settings are subject to change since the game is still in beta.

Check out the [official webpage for the supported parameters.](https://tech.palworldgame.com/optimize-game-balance)
:::

Converting server settings to environment variables follow the same principles (with some exceptions):

* all capital letters
* split words by inserting an underscore
* remove the single letter if the setting starts with one (like 'b')

For example:

* Difficulty -> DIFFICULTY
* PalSpawnNumRate -> PAL_SPAWN_NUM_RATE
* bIsPvP -> IS_PVP

| Variable | Description | Default Value | Allowed Value |
|-------------------------------------------|----------------------------------------------------------------|----------------------------------------------------------------------------------------------|----------------------------------------|
| DIFFICULTY | Game Difficulty | None | `None`,`Normal`,`Difficult` |
| DAYTIME_SPEEDRATE | Day time speed - Smaller number means shorter days | 1.000000 | Float |
| NIGHTTIME_SPEEDRATE | Night time speed - Smaller number means shorter nights | 1.000000 | Float |
| EXP_RATE | EXP earn rate | 1.000000 | Float |
| PAL_CAPTURE_RATE | Pal capture rate | 1.000000 | Float |
| PAL_SPAWN_NUM_RATE | Pal appearance rate | 1.000000 | Float |
| PAL_DAMAGE_RATE_ATTACK | Damage from pals multipiler | 1.000000 | Float |
| PAL_DAMAGE_RATE_DEFENSE | Damage to pals multipiler | 1.000000 | Float |
| PLAYER_DAMAGE_RATE_ATTACK | Damage from player multipiler | 1.000000 | Float |
| PLAYER_DAMAGE_RATE_DEFENSE | Damage to player multipiler | 1.000000 | Float |
| PLAYER_STOMACH_DECREASE_RATE | Player hunger depletion rate | 1.000000 | Float |
| PLAYER_STAMINA_DECREASE_RATE | Player stamina reduction rate | 1.000000 | Float |
| PLAYER_AUTO_HP_REGEN_RATE | Player auto HP regeneration rate | 1.000000 | Float |
| PLAYER_AUTO_HP_REGEN_RATE_IN_SLEEP | Player sleep HP regeneration rate | 1.000000 | Float |
| PAL_STOMACH_DECREASE_RATE | Pal hunger depletion rate | 1.000000 | Float |
| PAL_STAMINA_DECREASE_RATE | Pal stamina reduction rate | 1.000000 | Float |
| PAL_AUTO_HP_REGEN_RATE | Pal auto HP regeneration rate | 1.000000 | Float |
| PAL_AUTO_HP_REGEN_RATE_IN_SLEEP | Pal sleep health regeneration rate (in Palbox) | 1.000000 | Float |
| BUILD_OBJECT_DAMAGE_RATE | Damage to structure multipiler | 1.000000 | Float |
| BUILD_OBJECT_DETERIORATION_DAMAGE_RATE | Structure determination rate | 1.000000 | Float |
| COLLECTION_DROP_RATE | Getherable items multipiler | 1.000000 | Float |
| COLLECTION_OBJECT_HP_RATE | Getherable objects HP multipiler | 1.000000 | Float |
| COLLECTION_OBJECT_RESPAWN_SPEED_RATE | Getherable objects respawn interval - The smaller the number, the faster the regeneration | 1.000000 | Float |
| ENEMY_DROP_ITEM_RATE | Dropped Items Multipiler | 1.000000 | Float |
| DEATH_PENALTY | Death Penalty None: No death penalty Item: Drops items other than equipment ItemAndEquipment: Drops all items All: Drops all PALs and all items. | All | `None`,`Item`,`ItemAndEquipment`,`All` |
| ENABLE_PLAYER_TO_PLAYER_DAMAGE | Allows players to cause damage to players | False | Boolean |
| ENABLE_FRIENDLY_FIRE | Allow friendly fire | False | Boolean |
| ENABLE_INVADER_ENEMY | Enable invaders | True | Boolean |
| ACTIVE_UNKO | Enable UNKO (?) | False | Boolean |
| ENABLE_AIM_ASSIST_PAD | Enable controller aim assist | True | Boolean |
| ENABLE_AIM_ASSIST_KEYBOARD | Enable Keyboard aim assist | False | Boolean |
| DROP_ITEM_MAX_NUM | Maximum number of drops in the world | 3000 | Integer |
| DROP_ITEM_MAX_NUM_UNKO | Maximum number of UNKO drops in the world | 100 | Integer |
| BASE_CAMP_MAX_NUM | Maximum number of base camps | 128 | Integer |
| BASE_CAMP_WORKER_MAX_NUM | Maximum number of workers | 15 | Integer |
| DROP_ITEM_ALIVE_MAX_HOURS | Time it takes for items to despawn in hours | 1.000000 | Float |
| AUTO_RESET_GUILD_NO_ONLINE_PLAYERS | Automatically reset guild when no players are online | False | Bool |
| AUTO_RESET_GUILD_TIME_NO_ONLINE_PLAYERS | Time to automatically reset guild when no players are online | 72.000000 | Float |
| GUILD_PLAYER_MAX_NUM | Max player of Guild | 20 | Integer |
| PAL_EGG_DEFAULT_HATCHING_TIME | Time(h) to incubate massive egg | 72.000000 | Float |
| WORK_SPEED_RATE | Work speed muliplier | 1.000000 | Float |
| IS_MULTIPLAY | Enable multiplayer | False | Boolean |
| IS_PVP | Enable PVP | False | Boolean |
| CAN_PICKUP_OTHER_GUILD_DEATH_PENALTY_DROP | Allow players from other guilds to pick up death penalty items | False | Boolean |
| ENABLE_NON_LOGIN_PENALTY | Enable non-login penalty | True | Boolean |
| ENABLE_FAST_TRAVEL | Enable fast travel | True | Boolean |
| IS_START_LOCATION_SELECT_BY_MAP | Enable selecting of start location | True | Boolean |
| EXIST_PLAYER_AFTER_LOGOUT | Toggle for deleting players when they log off | False | Boolean |
| ENABLE_DEFENSE_OTHER_GUILD_PLAYER | Allows defense against other guild players | False | Boolean |
| COOP_PLAYER_MAX_NUM | Maximum number of players in a guild | 4 | Integer |
| REGION | Region | | String |
| USEAUTH | Use authentication | True | Boolean |
| BAN_LIST_URL | Which ban list to use | [https://api.palworldgame.com/api/banlist.txt](https://api.palworldgame.com/api/banlist.txt) | string |

### Manually

When the server starts, a `PalWorldSettings.ini` file will be created in the following location: `<mount_folder>/Pal/Saved/Config/LinuxServer/PalWorldSettings.ini`

Please keep in mind that the ENV variables will always overwrite the changes made to `PalWorldSettings.ini`.

:::warning
Changes can only be made to `PalWorldSettings.ini` while the server is off.

Any changes made while the server is live will be overwritten when the server stops.
:::

For a more detailed list of server settings go to: [Palworld Wiki](https://palworld.wiki.gg/wiki/PalWorldSettings.ini)

For more detailed server settings explanations go to: [shockbyte](https://shockbyte.com/billing/knowledgebase/1189/How-to-Configure-your-Palworld-server.html)
Loading

0 comments on commit a05392a

Please sign in to comment.