{"id":21056967,"url":"https://github.com/silentmecha/pixark-linux","last_synced_at":"2025-05-15T23:33:36.153Z","repository":{"id":261789283,"uuid":"323838226","full_name":"silentmecha/pixark-linux","owner":"silentmecha","description":"PixARK server on linux inside of Docker","archived":false,"fork":false,"pushed_at":"2023-01-10T11:23:33.000Z","size":22,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-04-03T17:13:09.035Z","etag":null,"topics":["docker","docker-comp","pixark","server"],"latest_commit_sha":null,"homepage":"https://hub.docker.com/r/silentmecha/pixark-linux","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/silentmecha.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-12-23T07:51:40.000Z","updated_at":"2024-01-17T21:12:58.000Z","dependencies_parsed_at":"2024-11-08T13:23:54.414Z","dependency_job_id":"c5beb99f-658e-4672-a67f-6355b20dc90c","html_url":"https://github.com/silentmecha/pixark-linux","commit_stats":null,"previous_names":["silentmecha/pixark-linux"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silentmecha%2Fpixark-linux","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silentmecha%2Fpixark-linux/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silentmecha%2Fpixark-linux/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silentmecha%2Fpixark-linux/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/silentmecha","download_url":"https://codeload.github.com/silentmecha/pixark-linux/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254442429,"owners_count":22071864,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","docker-comp","pixark","server"],"created_at":"2024-11-19T16:55:22.884Z","updated_at":"2025-05-15T23:33:31.080Z","avatar_url":"https://github.com/silentmecha.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# silentmecha/pixark-linux\n\nThis repository contains the files needed for the image silentmecha/pixark-linux:latest\n\n## Usage\n\nThis stack uses an image from [atmoz](https://github.com/atmoz). To see more on the image used visit their github [https://github.com/atmoz/sftp](https://github.com/atmoz/sftp).\n\nFor more info on environment variables and what they do see [Environment Variables](#environment-variables)\n\n### Simplest Method\n\nThe simplest usage for this is using the `docker-compose` method.\n\n```console\ngit clone https://github.com/silentmecha/pixark-linux.git pixark-server\ncd pixark-server\ncp .env.example .env\nnano .env\ndocker-compose up -d\n```\n\n### Without building the image locally\n\n```console\ngit clone https://github.com/silentmecha/pixark-linux.git pixark-server\ncd pixark-server\ncp .env.example .env\nnano .env\ndocker-compose pull\ndocker-compose up -d\n```\n\n### Updating\n\nUpdating is still currently in development so once that is sorted this README will be updated. The idea is to allow an image to be updated without needing to either download the full image or rebuilding the image\n\n### Environment Variables\n\n| Variable Name        | Default Value   | Description                                                                                        |\n| -------------------- | --------------- | -------------------------------------------------------------------------------------------------- |\n| MAP                  | CubeWorld_Light | Type of map to play on currently there is only two options `CubeWorld_Light` and `SkyPiea_Light`   |\n| SESSIONNAME          | SessionName     | Name of your server as seen in server browser (accepts spaces)                                     |\n| SERVERPASSWORD       |                 | Password to enter your server                                                                      |\n| SERVERADMINPASSWORD  | ChangeMe        | Admin access password (also know as RCON password)                                                 |\n| MAXPLAYERS           | 20              | Maximum number of players                                                                          |\n| RCONENABLED          | True            | Enable RCON access (will default to false if `SERVERADMINPASSWORD` is blank)                       |\n| PORT                 | 27015           | Port used to connect to the server                                                                 |\n| QUERYPORT            | 27016           | Port used to query the server                                                                      |\n| CUBEPORT             | 27018           | Port used to send world data                                                                       |\n| RCONPORT             | 27017           | Port for RCON connections                                                                          |\n| CULTUREFORCOOKING    | en              | Must be specified. 'en' for English                                                                |\n| MAPSEED              |                 | Custom map seed in numbers (do not use 0)                                                          |\n| CUBEWORLD            | cubeworld       | Name of the folder where your generated map will go                                                |\n| ALTSAVEDIRECTORYNAME |                 | Name of the folder where your saved data and configs will go                                       |\n| CLUSTERID            |                 | The variable that defines your cluster of servers to be linked see [Cluster Setup](#cluster-setup) |\n| ADDITIONAL_ARGS      |                 | Currently not used                                                                                 |\n| SFT_USER             | foo             | Username for SFTP access to edit save data                                                         |\n| SFT_PASS             | pass            | Password for SFTP access to edit save data                                                         |\n| SFT_PORT             | 2222            | Port for SFTP access (should not be 22 )                                                           \n\nFor more info on the usage of SFTP see [here](https://github.com/atmoz/sftp). If you do not want to use a plane text password see [encrypted-password](https://github.com/atmoz/sftp#encrypted-password)\n\n### Ports\nCurrently the following ports are used.\n\n| Port      | Default |\n| --------- | ------- |\n| PORT      | 27015   |\n| QUERYPORT | 27016   |\n| CUBEPORT  | 27018   |\n| RCONPORT  | 27017   |\n| SFT_PORT  | 2222    |\n\nAll these ports need to be forwarded through your router except for `RCONPORT` and `SFT_PORT` unless you wish to externally RCON into the server or remotely edit the save data.\n\n**NB PixARK does not like port remapping `eg. -p 28015:27015/udp`**\n\n## Cluster Setup\n\nIn order to configure clusters that allow players to travel between your servers you will need to give all servers in the cluster the same `CLUSTERID` and set both `CUBEWORLD` and `ALTSAVEDIRECTORYNAME` to unique names. You will also need to uncomment the last line in the [docker-compose.yml](docker-compose.yml) file.\n\n## Notes\nThe cluster function is not properly documented so I am not sure exactly how it should function so this is still under experiment.\n\n## License\n\n[MIT license](LICENSE)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsilentmecha%2Fpixark-linux","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsilentmecha%2Fpixark-linux","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsilentmecha%2Fpixark-linux/lists"}