Userdata Folder Structure: Difference between revisions

From Veloren Wiki
Content added Content deleted
VisualWikitext
(Created page with "== Userdata Folder Structure == The <code>userdata</code> folder unifies all player and server configuration in a single place, which should be transferrable between differen...")
 
(Restored the table and put the code with <pre> tag. In need verification because the page was created in 2021)
Line 46: Line 46:


This file is intended for manual editing, and should never be overwritten by the game. If the file is in an invalid state, the server will emit a warning in including the position of the error, create a settings.template.ron file full of the default values, and start up with all default values.
This file is intended for manual editing, and should never be overwritten by the game. If the file is in an invalid state, the server will emit a warning in including the position of the error, create a settings.template.ron file full of the default values, and start up with all default values.
{| class="wikitable"

! Setting!!Description !! Default value
| Setting | Description | Default value |
|-
| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- |
| `gameserver_address` | Address and port the game server will listen to. Note that clients will use the port `14004` by default. _Changing the port will require to specify it in the client too._ | `"0.0.0.0:14004"` |
| gameserver_address || Address and port the game server will listen to. Note that clients will use the port 14004 by default. Changing the port will require to specify it in the client too.||<code>0.0.0.0:14004</code>
|-
| `metrics_address` | Address and port the game server will expose [prometheus](https://prometheus.io) metrics. | `"0.0.0.0:14005"` |
|metrics_address||Address and port the game server will expose <code><nowiki>[prometheus](https://prometheus.io)</nowiki></code> metrics.||<code>0.0.0.0:14005</code>
⚫
| `auth_server_address` | When using `Some(<value>)`: The value is the IP address or domain the **game server and client** will use. If you want to disable authentication, you replace `Some(...)` with `None`. | `Some("https://auth.veloren.net")` |
|-
| `max_players` | Maximum number of players connected to the game server. | `100` |
⚫
| auth_server_address |When using <code>Some(<value></code>: The value is the IP address or domain the **game server and client** will use. If you want to disable authentication, you replace <code>Some(...)</code> with None.||<code>Some("https://auth.veloren.net")</code>
| `world_seed` | seed number used to setup the random generation of the world. | `59686` |
|-
| `server_name` | displayed server name | `"Veloren Alpha"` |
| max_players||Maximum number of players connected to the game server.||<code>100</code>
| `start_time` | Server daylight start time in seconds. | `32400` |
|-
⚫
| `map_file` | Sets which map to load. [See here](world-generation.html#map_file-options) for allowed values. | `None` |
|world_seed||seed number used to setup the random generation of the world.|| <code>59686</code>
⚫
| `max_view_distance` | The maximum view distance that clients may request. Useful for low-RAM servers. | `Some(30)` |
|-
⚫
| `banned_words_files` | List of files containing words to be censored. None are distributed by default. | `[]` (Empty array) |
| server_name || displayed server name|| <code>"Veloren Alpha"</code>
⚫
| `max_player_group_size` | The maximum party size players can have, for purposes of XP sharing and ignoring friendly fire. | `6` |
|-
| `client_timeout` | | `(secs: 40, nanos: 0,)` |
|start_time ||Server daylight start time in seconds.||<code>32400</code>

|-
⚫
| map_file|| Sets which map to load. [See here](world-generation.html#map_file-options) for allowed values.|| <code>None</code>
|-
⚫
|max_view_distance||The maximum view distance that clients may request. Useful for low-RAM servers.||<code>Some(30)</code>
|-
⚫
| banned_words_files || List of files containing words to be censored. None are distributed by default.|| <nowiki>[]</nowiki> (Empty array)
|-
⚫
| max_player_group_size | The maximum party size players can have, for purposes of XP sharing and ignoring friendly fire.|| <code>6</code>
|-
| client_timeout || (secs: 40, nanos: 0,) || <code> </code>
|}
== description.ron ==
== description.ron ==


Line 67: Line 78:


Example:
Example:

```
"This is the best Veloren server"
"This is the best Veloren server"

```


== whitelist.ron ==
== whitelist.ron ==
Line 77: Line 88:
Example: Result of using <code>/whitelist add Treeco</code> and <code>/whitelist add treeco2</code>.
Example: Result of using <code>/whitelist add Treeco</code> and <code>/whitelist add treeco2</code>.


<pre>
```
[
[
"6f15b915-074f-f78d-df88-34fb33e4e13f",
"6f15b915-074f-f78d-df88-34fb33e4e13f",
"3445349e-d03c-64bf-6ecf-a15806275a1f",
"3445349e-d03c-64bf-6ecf-a15806275a1f",
]
]
</pre>
```


== banlist.ron ==
==banlist.ron==


Contains a list of banned accounts, and reasons. Heavily recommended to use the <code>/ban</code> and <code>/unban</code> ingame commands, rather than manual editing.
Contains a list of banned accounts, and reasons. Heavily recommended to use the <code>/ban</code> and <code>/unban</code> ingame commands, rather than manual editing.
Line 90: Line 101:
Example: Result of using <code>/ban Treeco General nuisance</code> and <code>/ban treeco2 alt account</code>.
Example: Result of using <code>/ban Treeco General nuisance</code> and <code>/ban treeco2 alt account</code>.


<pre>
```
{
{
"6f15b915-074f-f78d-df88-34fb33e4e13f": (
"6f15b915-074f-f78d-df88-34fb33e4e13f": (
Line 101: Line 112:
),
),
}
}
</pre>
```

== admins.ron ==
== admins.ron ==


Line 108: Line 120:
Example: Result of using <code>admin add Treeco</code>.
Example: Result of using <code>admin add Treeco</code>.


<pre>
```
[
[
"ee193d08-8f5a-4862-a279-1a8c4bd357f3",
"ee193d08-8f5a-4862-a279-1a8c4bd357f3",
]
]
</pre>
```


== settings.ron (server-cli edition) ==
== settings.ron (server-cli edition) ==


The settings in this file govern the warning period the server gives for automatic shutdowns for updates.
The settings in this file govern the warning period the server gives for automatic shutdowns for updates.
[[Category:Sysadmin]]

Revision as of 09:34, 27 September 2022

Userdata Folder Structure

The userdata folder unifies all player and server configuration in a single place, which should be transferrable between different Veloren installations from v0.8 onwards.

The folder will be next to your Veloren executable, or in your repository's root if self-compiling. See [where Airshipper stores files](airshipper.html#files) if using the launcher.

Airshipper currently stores the items under the voxygen heading outside of userdata, but this will change in the future.

  • voxygen
    • logs
      • voxygen.log.<date of log>
    • settings.ron
    • profile.ron
  • singleplayer
    • saves
      • db.sqlite
    • server_config
      • settings.ron (Some entries ignored)
      • description.ron
      • whitelist.ron (Ignored)
      • banlist.ron (Ignored)
      • admins.ron (Ignored)
  • server
    • saves
      • db.sqlite
    • server_config
      • settings.ron
      • description.ron
      • whitelist.ron
      • banlist.ron
      • admins.ron
  • server-cli
    • settings.ron

settings.ron (voxygen edition)

Contains all of the settings accessible from the in-game GUI, and usually shouldn't require manual intervention.

The main thing not accessible from main game menus is gamepad keybindings, which can only be changed by directly editing the file.

profile.ron

Contains hotbar infomation, per-character and per-server. Should never need to be manually modified.

settings.ron (server edition)

This file is intended for manual editing, and should never be overwritten by the game. If the file is in an invalid state, the server will emit a warning in including the position of the error, create a settings.template.ron file full of the default values, and start up with all default values.

Setting Description Default value
gameserver_address Address and port the game server will listen to. Note that clients will use the port 14004 by default. Changing the port will require to specify it in the client too. 0.0.0.0:14004
metrics_address Address and port the game server will expose [prometheus](https://prometheus.io) metrics. 0.0.0.0:14005
When using Some(<value>: The value is the IP address or domain the **game server and client** will use. If you want to disable authentication, you replace Some(...) with None. Some("https://auth.veloren.net")
max_players Maximum number of players connected to the game server. 100
world_seed seed number used to setup the random generation of the world. 59686
server_name displayed server name "Veloren Alpha"
start_time Server daylight start time in seconds. 32400
map_file Sets which map to load. [See here](world-generation.html#map_file-options) for allowed values. None
max_view_distance The maximum view distance that clients may request. Useful for low-RAM servers. Some(30)
banned_words_files List of files containing words to be censored. None are distributed by default. [] (Empty array)
The maximum party size players can have, for purposes of XP sharing and ignoring friendly fire. 6
client_timeout (secs: 40, nanos: 0,)

description.ron

Contains the introductory chat message clients get when entering the server, as a quoted string. Can be multiple lines.

Example:

"This is the best Veloren server"


whitelist.ron

Contains a list of whitelisted account IDs, and is considered disabled if empty. Heavily recommended to use the /whitelist add/remove ingame command, rather than manual editing.

Example: Result of using /whitelist add Treeco and /whitelist add treeco2. 

[
    "6f15b915-074f-f78d-df88-34fb33e4e13f",
    "3445349e-d03c-64bf-6ecf-a15806275a1f",
]

banlist.ron

Contains a list of banned accounts, and reasons. Heavily recommended to use the /ban and /unban ingame commands, rather than manual editing.

Example: Result of using /ban Treeco General nuisance and /ban treeco2 alt account. 

{
    "6f15b915-074f-f78d-df88-34fb33e4e13f": (
        username_when_banned: "treeco2",
        reason: "alt account",
    ),
    "3445349e-d03c-64bf-6ecf-a15806275a1f": (
        username_when_banned: "Treeco",
        reason: "General nuisance",
    ),
}

admins.ron

Contains a list of admin account IDs. Heavily recommended to use admin add/remove from the server's TUI, rather than manual editing. There is no in-game command to permanently add admins, for security reasons.

Example: Result of using admin add Treeco. 

[
    "ee193d08-8f5a-4862-a279-1a8c4bd357f3",
]

settings.ron (server-cli edition)

The settings in this file govern the warning period the server gives for automatic shutdowns for updates.

Retrieved from "https://wiki.veloren.net/wiki/Userdata_Folder_Structure?oldid=14381"
Last modified
This page was last edited on 27 September 2022, at 09:34.
Copyright
Content is available under Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) unless otherwise noted.
Cookies help us deliver our services. By using our services, you agree to our use of cookies.
More information