Merge d4c29596ab into 98d756d181

2026-05-17 11:12:37 +08:00 · 2024-04-08 21:01:56 +02:00
parent 98d756d181 d4c29596ab
commit 6077ca46c6
5 changed files with 247 additions and 1 deletions
@@ -374,7 +374,9 @@ If you are reading this it looks like you are looking to add an egg to your serv

 [Veloren](game_eggs/veloren)

-[Vintage Story](game_eggs/vintage_story)
+[Venice Unleashed](game_eggs/venice_unleashed)
+
+[Vintage Story](game_eggs/vintage_story/vintage_story)

 [Wine Generic](game_eggs/wine/generic)

@@ -268,6 +268,8 @@

 [Veloren](veloren)

+[Venice Unleashed](venice_unleashed)
+
 [Vintage Story](vintage_story)

 [Xonotic](xonotic/xonotic)
@@ -0,0 +1,58 @@
+# [Venice Unleashed](https://veniceunleashed.net/)
+
+Experience Battlefield 3 like never before
+VU /vi:ju:/ is a community-oriented Battlefield 3 modding platform that gives you back control of your gaming experience.
+
+## PREREQUISITES
+ - Venice Unleashed Account linked to EA/Origin Account. [Refer here on how to link](https://docs.veniceunleashed.net/general/playing/#creating-an-account-and-linking-your-origin-account)
+ - Server key generated from Venice Unleashed [key management portal](https://veniceunleashed.net/keys) (Download the generated key file)
+ - Copy of Battlefield 3 (full and up-to-date installation)
+
+## PORTS
+
+ - 3 Ports are required to run Venice Unleashed servers
+ - Primary port is automatically assigned as game port for the server
+ - Harmony services and RCON needs port assigned in the Startup tab
+
+|  Port   |      Default Ports      |
+|---------|-------------------------|
+|  Game   |  Primary Port of server |
+| Harmony |           7948          |
+|  RCON   |          47200          |
+
+## EGG VARIANT
+
+There is 2 variants of Eggs for Venice Unleashed
+- With mount
+- Without mount
+
+### WITH MOUNT
+
+In order to reduce size of server, **/bf3** directory is shared with multiple servers rather than having it in root directory of each server.
+
+This type of egg uses mount feature of Pterodactyl where you need to create a mount for **/bf3** directory and mount it to server.
+Refer to this [link](https://pterodactyl.io/guides/mounts.html)  for more info on how to create mounts in Pterodactyl Panel
+
+Below example shows BF3 game files mount hosted in source path `/var/lib/pterodactyl/mounts/bf3` which has required BF3 game files
+![Mounts](https://i.postimg.cc/mgrmVL5t/image.png)
+
+**Recommended disk size** : 3GB (Uses about 1.6GB after initial startup without any mods)
+
+### WITHOUT MOUNT
+
+This type of server uses more than 35GB in space where you have to upload the BF3 game files for each server under **/bf3** directory.
+
+**Recommended disk size** : 45GB (Including BF3 game files which is ~35GB. Can vary between regions)
+
+## NOTES
+
+- Server takes sometime to mark as running status since server has to connect to Zeus backend for listing. Wait for this message in console [Game successfully registered with Zeus. The server is now accepting connections.]
+- Email and Password should be provided in startup before starting the server for 1st time to activate the instance (Only required for initial startup. Once the server is activated, you can remove your credentials and replace with default credentials [example@example.com|Password@123])
+- Before you start the server, transfer the key downloaded from VU key management portal to `~/vu/instance` directory, and name it `server.key`
+- If you start the server with default credentials, server will create `activated` file in your server directory with default credentials and server will not work. Delete `activated` file, provide your credentials in startup and restart server to activate.
+- 2FA should be disabled in your EA Account to successfully verify the installation (You can enable 2FA after activation)
+- Mount should be linked to the egg for mounts to work (Edit the mount and assign it to VU with mount Egg as shown in below image)
+![mount-edit.jpg](https://i.postimg.cc/NfdQNwt5/mount-edit.jpg)
+- Mount should also be mounted in mount tab of server settings for each servers you wish to have mount available
+- Wine Latest is the preferred image which uses Parker's latest wine generic image
+- Kindly ignore "steam user is not set." message in console during startup (this is used for steam games only).
@@ -0,0 +1,92 @@
+{
+    "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO",
+    "meta": {
+        "version": "PTDL_v2",
+        "update_url": null
+    },
+    "exported_at": "2022-09-29T14:19:56-04:00",
+    "name": "Venice Unleashed [With Mount]",
+    "author": "me@itsmemac.com",
+    "description": "Experience Battlefield 3 like never before\r\nVU \/vi:ju:\/ is a community-oriented Battlefield 3 modding platform that gives you back control of your gaming experience.",
+    "features": null,
+    "docker_images": {
+        "Wine Stable": "ghcr.io\/parkervcp\/yolks:wine_latest"
+    },
+    "file_denylist": [],
+    "startup": "if [ ! -f \/home\/container\/activated ]; then wine ~\/vu\/client\/vu.com -gamepath ~\/bf3 -activate -o_mail ${EMAIL} -o_pass ${PASSWORD}; touch \/home\/container\/activated; else wine ~\/vu\/client\/vu.com -gamepath ~\/bf3 -serverInstancePath \"$(winepath -w ~\/vu\/instance)\" -server -dedicated -noUpdate -${FREQUENCY} -listen 0.0.0.0:$SERVER_PORT -mHarmonyPort ${HARMONY} -RemoteAdminPort 0.0.0.0:${RCON}; fi",
+    "config": {
+        "files": "{}",
+        "startup": "{\r\n    \"done\": \"Game successfully registered with Zeus\"\r\n}",
+        "logs": "{}",
+        "stop": "^C"
+    },
+    "scripts": {
+        "installation": {
+            "script": "#!\/bin\/bash\r\n# Venice Unleashed installer\r\n#\r\n# This will just pull the latest VU server files and unpack it in directory.\r\napt update -y\r\ndpkg --add-architecture i386\r\napt -y --no-install-recommends install curl gnupg2 wget software-properties-common file unzip lib32gcc1 ca-certificates\r\n## VU specific because reasons\r\nchown -R root:root \/mnt\r\nexport HOME=\/mnt\/server\r\nmkdir -p \/mnt\/server\/tmp\r\ncd \/tmp\r\n## install latest wine\r\nwget -nc https:\/\/dl.winehq.org\/wine-builds\/winehq.key\r\napt-key add winehq.key\r\necho \"deb https:\/\/dl.winehq.org\/wine-builds\/debian\/ buster main\" >> \/etc\/apt\/sources.list\r\napt update\r\n## install wine, cabextract, and xvfb for winetricks\r\napt install -y --install-recommends winehq-stable cabextract xvfb\r\nexport WINEPREFIX=\/mnt\/server\/.wine\r\nexport WINEDLLOVERRIDES=\"mscoree,mshtml=\"\r\nexport DISPLAY=:0\r\nexport DISPLAY_WIDTH=1024\r\nexport DISPLAY_HEIGHT=768\r\nexport DISPLAY_DEPTH=16\r\nexport AUTO_UPDATE=1\r\nexport XVFB=1\r\n## install winetricks\r\nwget -q -O \/usr\/sbin\/winetricks https:\/\/raw.githubusercontent.com\/Winetricks\/winetricks\/master\/src\/winetricks \\\r\n&& chmod +x \/usr\/sbin\/winetricks\r\n## install vc redistributable\r\nxvfb-run --auto-servernum winetricks -q vcrun2019\r\n## Make VU Required Directories\r\ncd \/\r\nmkdir -p \/mnt\/server\/vu\/client\r\nmkdir -p \/mnt\/server\/vu\/instance\r\ncd \/mnt\/server\/vu\/client\r\n# Validate and Download VU Server files\r\nif [ ! -z \"${DOWNLOAD_URL}\" ]; then\r\nif curl --output \/dev\/null --silent --head --fail ${DOWNLOAD_URL}; then\r\necho -e \"link is valid. setting download link to ${DOWNLOAD_URL}\"\r\nDOWNLOAD_LINK=${DOWNLOAD_URL}\r\nelse\r\necho -e \"link is invalid closing out\"\r\nexit 2\r\nfi\r\nfi\r\ncurl -sSL ${DOWNLOAD_LINK} -o ${DOWNLOAD_LINK##*\/}\r\n# unpack servver files\r\nFILETYPE=$(file -F ',' ${DOWNLOAD_LINK##*\/} | cut -d',' -f2 | cut -d' ' -f2)\r\nif [ \"$FILETYPE\" == \"gzip\" ]; then\r\ntar xzvf ${DOWNLOAD_LINK##*\/}\r\nelif [ \"$FILETYPE\" == \"Zip\" ]; then\r\nunzip ${DOWNLOAD_LINK##*\/}\r\nelif [ \"$FILETYPE\" == \"XZ\" ]; then\r\ntar xvf ${DOWNLOAD_LINK##*\/}\r\nelse\r\necho -e \"unknown filetype. Exiting\"\r\nexit 2\r\nfi",
+            "container": "debian:buster-slim",
+            "entrypoint": "bash"
+        }
+    },
+    "variables": [
+        {
+            "name": "VU Server Download URL",
+            "description": "Official URL provided by VU to download servers files.\r\n(Should not be changed unless you know what you are doing)",
+            "env_variable": "DOWNLOAD_URL",
+            "default_value": "https:\/\/veniceunleashed.net\/files\/vu.zip",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "required|string",
+            "field_type": "text"
+        },
+        {
+            "name": "Origin Account Email",
+            "description": "Your Origin Account Email to validate install",
+            "env_variable": "EMAIL",
+            "default_value": "example@example.com",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "email",
+            "field_type": "text"
+        },
+        {
+            "name": "Origin Account Password",
+            "description": "Your Origin Account Password to validate install",
+            "env_variable": "PASSWORD",
+            "default_value": "Password@123",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "string",
+            "field_type": "text"
+        },
+        {
+            "name": "Harmony Port",
+            "description": "Port used by Harmony services",
+            "env_variable": "HARMONY",
+            "default_value": "7948",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "numeric",
+            "field_type": "text"
+        },
+        {
+            "name": "RCON Port",
+            "description": "Port used for RCON",
+            "env_variable": "RCON",
+            "default_value": "47200",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "numeric",
+            "field_type": "text"
+        },
+        {
+            "name": "Server Frequency",
+            "description": "30 - 30Hz (Default) \/\/ high60 - 60Hz High frequency mode \/\/ high120 - 120Hz High frequency mode",
+            "env_variable": "FREQUENCY",
+            "default_value": "30",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "in:30,high60,high120",
+            "field_type": "text"
+        }
+    ]
+}
@@ -0,0 +1,92 @@
+{
+    "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO",
+    "meta": {
+        "version": "PTDL_v2",
+        "update_url": null
+    },
+    "exported_at": "2022-09-29T14:20:00-04:00",
+    "name": "Venice Unleashed [Without Mount]",
+    "author": "me@itsmemac.com",
+    "description": "Experience Battlefield 3 like never before\r\nVU \/vi:ju:\/ is a community-oriented Battlefield 3 modding platform that gives you back control of your gaming experience.",
+    "features": null,
+    "docker_images": {
+        "Wine Stable": "ghcr.io\/parkervcp\/yolks:wine_latest"
+    },
+    "file_denylist": [],
+    "startup": "if [ ! -f \/home\/container\/activated ]; then wine ~\/vu\/client\/vu.com -gamepath ~\/bf3 -activate -o_mail ${EMAIL} -o_pass ${PASSWORD}; touch \/home\/container\/activated; else wine ~\/vu\/client\/vu.com -gamepath ~\/bf3 -serverInstancePath \"$(winepath -w ~\/vu\/instance)\" -server -dedicated -noUpdate -${FREQUENCY} -listen 0.0.0.0:$SERVER_PORT -mHarmonyPort ${HARMONY} -RemoteAdminPort 0.0.0.0:${RCON}; fi",
+    "config": {
+        "files": "{}",
+        "startup": "{\r\n    \"done\": \"Game successfully registered with Zeus\"\r\n}",
+        "logs": "{}",
+        "stop": "^C"
+    },
+    "scripts": {
+        "installation": {
+            "script": "#!\/bin\/bash\r\n# Venice Unleashed installer\r\n#\r\n# This will just pull the latest VU server files and unpack it in directory.\r\napt update -y\r\ndpkg --add-architecture i386\r\napt -y --no-install-recommends install curl gnupg2 wget software-properties-common file unzip lib32gcc1 ca-certificates\r\n## VU specific because reasons\r\nchown -R root:root \/mnt\r\nexport HOME=\/mnt\/server\r\nmkdir -p \/mnt\/server\/tmp\r\ncd \/tmp\r\n## install latest wine\r\nwget -nc https:\/\/dl.winehq.org\/wine-builds\/winehq.key\r\napt-key add winehq.key\r\necho \"deb https:\/\/dl.winehq.org\/wine-builds\/debian\/ buster main\" >> \/etc\/apt\/sources.list\r\napt update\r\n## install wine, cabextract, and xvfb for winetricks\r\napt install -y --install-recommends winehq-stable cabextract xvfb\r\nexport WINEPREFIX=\/mnt\/server\/.wine\r\nexport WINEDLLOVERRIDES=\"mscoree,mshtml=\"\r\nexport DISPLAY=:0\r\nexport DISPLAY_WIDTH=1024\r\nexport DISPLAY_HEIGHT=768\r\nexport DISPLAY_DEPTH=16\r\nexport AUTO_UPDATE=1\r\nexport XVFB=1\r\n## install winetricks\r\nwget -q -O \/usr\/sbin\/winetricks https:\/\/raw.githubusercontent.com\/Winetricks\/winetricks\/master\/src\/winetricks \\\r\n&& chmod +x \/usr\/sbin\/winetricks\r\n## install vc redistributable\r\nxvfb-run --auto-servernum winetricks -q vcrun2019\r\n## Make VU Required Directories\r\ncd \/\r\nmkdir -p \/mnt\/server\/bf3\r\nmkdir -p \/mnt\/server\/vu\/client\r\nmkdir -p \/mnt\/server\/vu\/instance\r\ncd \/mnt\/server\/vu\/client\r\n# Validate and Download VU Server files\r\nif [ ! -z \"${DOWNLOAD_URL}\" ]; then\r\nif curl --output \/dev\/null --silent --head --fail ${DOWNLOAD_URL}; then\r\necho -e \"link is valid. setting download link to ${DOWNLOAD_URL}\"\r\nDOWNLOAD_LINK=${DOWNLOAD_URL}\r\nelse\r\necho -e \"link is invalid closing out\"\r\nexit 2\r\nfi\r\nfi\r\ncurl -sSL ${DOWNLOAD_LINK} -o ${DOWNLOAD_LINK##*\/}\r\n# unpack servver files\r\nFILETYPE=$(file -F ',' ${DOWNLOAD_LINK##*\/} | cut -d',' -f2 | cut -d' ' -f2)\r\nif [ \"$FILETYPE\" == \"gzip\" ]; then\r\ntar xzvf ${DOWNLOAD_LINK##*\/}\r\nelif [ \"$FILETYPE\" == \"Zip\" ]; then\r\nunzip ${DOWNLOAD_LINK##*\/}\r\nelif [ \"$FILETYPE\" == \"XZ\" ]; then\r\ntar xvf ${DOWNLOAD_LINK##*\/}\r\nelse\r\necho -e \"unknown filetype. Exiting\"\r\nexit 2\r\nfi",
+            "container": "debian:buster-slim",
+            "entrypoint": "bash"
+        }
+    },
+    "variables": [
+        {
+            "name": "VU Server Download URL",
+            "description": "Official URL provided by VU to download servers files.\r\n(Should not be changed unless you know what you are doing)",
+            "env_variable": "DOWNLOAD_URL",
+            "default_value": "https:\/\/veniceunleashed.net\/files\/vu.zip",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "required|string",
+            "field_type": "text"
+        },
+        {
+            "name": "Origin Account Email",
+            "description": "Your Origin Account Email to validate install",
+            "env_variable": "EMAIL",
+            "default_value": "example@example.com",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "email",
+            "field_type": "text"
+        },
+        {
+            "name": "Origin Account Password",
+            "description": "Your Origin Account Password to validate install",
+            "env_variable": "PASSWORD",
+            "default_value": "Password@123",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "string",
+            "field_type": "text"
+        },
+        {
+            "name": "Harmony Port",
+            "description": "Port used by Harmony services",
+            "env_variable": "HARMONY",
+            "default_value": "7948",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "numeric",
+            "field_type": "text"
+        },
+        {
+            "name": "RCON Port",
+            "description": "Port used for RCON",
+            "env_variable": "RCON",
+            "default_value": "47200",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "numeric",
+            "field_type": "text"
+        },
+        {
+            "name": "Server Frequency",
+            "description": "30 - 30Hz (Default) \/\/ high60 - 60Hz High frequency mode \/\/ high120 - 120Hz High frequency mode",
+            "env_variable": "FREQUENCY",
+            "default_value": "30",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "in:30,high60,high120",
+            "field_type": "text"
+        }
+    ]
+}