Unciv/docs/Other/Hosting-a-Multiplayer-server.md

# Hosting a Multiplayer server

Due to certain limitations on Dropbox's API, with the current influx of players, we've many times reached the point that Dropbox has become unavailable.

Therefore, you can now host your own Unciv server on any computer that can run Java programs.

This guide is written for people with a moderate amount of technical knowledge about computer software and who are able to search the web to learn stuff they might not know. If you're completely new to this, you'll likely not be able to follow without some larger time investment to learn.

If you're proficient in server hosting, there's another how-to for you at the end.

## How To

Before starting, you must have a Java JDK installed. You'll also have to download the [latest UncivServer.jar](https://github.com/yairm210/Unciv/releases/latest/download/UncivServer.jar).

From the directory where the `UncivServer.jar` file is located, create a folder named "MultiplayerFiles", open a terminal (in Windows, Shift+RightClick in the folder) and run the following command in the directory:
`java -jar UncivServer.jar`

Your server has now started!

To check if everything works, you can start Unciv on the same computer, go to "Options > Multiplayer", then enter `http://localhost` as the "Server address" and click "Check connection to server". You should now get a "Success!" result, which means it's working!

To connect with other devices, you'll need the port (default 80) the server is running on to be visible externally (port forwarding) and know your external IP-address.

On the other device, enter the URL to your server, click 'check connection' from the new device, and if you get the same "Success!" result - congratulations, you're connected to the same server and can start a multiplayer game!

Please note:
* Devices *not* connected to the same server will *not* be able to participate in multiplayer games together
* In many places, your external IP address changes periodically. If that is the case, you either have to update the IP all the time or use something like a dynamic DNS service.

## How To for people with hosting experience

* Have a Java JDK installed
* Download the [latest UncivServer.jar](https://github.com/yairm210/Unciv/releases/latest/download/UncivServer.jar) (can also use that link to automatically update probably)
* See options with `java -jar UncivServer.jar --help`
    * The server will run on a specified port (`-p`, default `80`), writing files in a folder (`-f`, default `./MultiplayerGames/`), so it needs appropriate permissions.
* Run it: `java -jar UncivServer.jar -p 8080 -f /some/folder/`
    * It basically just does simple file storage over HTTP.
    * Files are not cleaned automatically if a game ends or is deleted on the client-side
Unciv server (#6384) * Background implementation for Unciv server with ktor. Server ip in settings, able to copy your own ip and copy ip from clipboard for easy sharing, created stub for the client-server data transfer. No actual data storage or server implementation. * Unciv server round 2 - implementing crud for files and it works! metadata seems to only be in use for mutex, which is currently unused That's all for today * When starting a new multiplayer game the files are correctly saved in the server, and the server can return the files, but the function in the game to retrieve the game info is non-blocking so it doesn't work. Still, progress! * Changed the Gdx http to basic Java http, as used for Dropbox, and now everything works!!!! * Documentation for running and using the server * Better texts, translations, etc * Trog is right this should be a PUT not POST 2022-03-22 02:05:02 +07:00			`# Hosting a Multiplayer server`

			`Due to certain limitations on Dropbox's API, with the current influx of players, we've many times reached the point that Dropbox has become unavailable.`

Allow non-SSL-encrypted HTTP traffic & warn Dropbox users (#7013) * Add usesCleartextTrafic permission to Android manifest * Add warning for starting a multiplayer game with the default Dropbox server * Improve multiplayer server documentation * Only update the current game if we're using a custom server or it's not our turn * Refactor: Nicer variable name * Fix compilation * Fix type Don't know what happened there 2022-06-02 02:40:20 +07:00			`Therefore, you can now host your own Unciv server on any computer that can run Java programs.`
Unciv server (#6384) * Background implementation for Unciv server with ktor. Server ip in settings, able to copy your own ip and copy ip from clipboard for easy sharing, created stub for the client-server data transfer. No actual data storage or server implementation. * Unciv server round 2 - implementing crud for files and it works! metadata seems to only be in use for mutex, which is currently unused That's all for today * When starting a new multiplayer game the files are correctly saved in the server, and the server can return the files, but the function in the game to retrieve the game info is non-blocking so it doesn't work. Still, progress! * Changed the Gdx http to basic Java http, as used for Dropbox, and now everything works!!!! * Documentation for running and using the server * Better texts, translations, etc * Trog is right this should be a PUT not POST 2022-03-22 02:05:02 +07:00
Allow non-SSL-encrypted HTTP traffic & warn Dropbox users (#7013) * Add usesCleartextTrafic permission to Android manifest * Add warning for starting a multiplayer game with the default Dropbox server * Improve multiplayer server documentation * Only update the current game if we're using a custom server or it's not our turn * Refactor: Nicer variable name * Fix compilation * Fix type Don't know what happened there 2022-06-02 02:40:20 +07:00			`This guide is written for people with a moderate amount of technical knowledge about computer software and who are able to search the web to learn stuff they might not know. If you're completely new to this, you'll likely not be able to follow without some larger time investment to learn.`
Unciv server (#6384) * Background implementation for Unciv server with ktor. Server ip in settings, able to copy your own ip and copy ip from clipboard for easy sharing, created stub for the client-server data transfer. No actual data storage or server implementation. * Unciv server round 2 - implementing crud for files and it works! metadata seems to only be in use for mutex, which is currently unused That's all for today * When starting a new multiplayer game the files are correctly saved in the server, and the server can return the files, but the function in the game to retrieve the game info is non-blocking so it doesn't work. Still, progress! * Changed the Gdx http to basic Java http, as used for Dropbox, and now everything works!!!! * Documentation for running and using the server * Better texts, translations, etc * Trog is right this should be a PUT not POST 2022-03-22 02:05:02 +07:00
Allow non-SSL-encrypted HTTP traffic & warn Dropbox users (#7013) * Add usesCleartextTrafic permission to Android manifest * Add warning for starting a multiplayer game with the default Dropbox server * Improve multiplayer server documentation * Only update the current game if we're using a custom server or it's not our turn * Refactor: Nicer variable name * Fix compilation * Fix type Don't know what happened there 2022-06-02 02:40:20 +07:00			`If you're proficient in server hosting, there's another how-to for you at the end.`
Unciv server (#6384) * Background implementation for Unciv server with ktor. Server ip in settings, able to copy your own ip and copy ip from clipboard for easy sharing, created stub for the client-server data transfer. No actual data storage or server implementation. * Unciv server round 2 - implementing crud for files and it works! metadata seems to only be in use for mutex, which is currently unused That's all for today * When starting a new multiplayer game the files are correctly saved in the server, and the server can return the files, but the function in the game to retrieve the game info is non-blocking so it doesn't work. Still, progress! * Changed the Gdx http to basic Java http, as used for Dropbox, and now everything works!!!! * Documentation for running and using the server * Better texts, translations, etc * Trog is right this should be a PUT not POST 2022-03-22 02:05:02 +07:00
Allow non-SSL-encrypted HTTP traffic & warn Dropbox users (#7013) * Add usesCleartextTrafic permission to Android manifest * Add warning for starting a multiplayer game with the default Dropbox server * Improve multiplayer server documentation * Only update the current game if we're using a custom server or it's not our turn * Refactor: Nicer variable name * Fix compilation * Fix type Don't know what happened there 2022-06-02 02:40:20 +07:00			`## How To`
Fixed the official wiki (#6453) * Fixed the links in the docs * Fixed broken tables Tables without a line break above are not treated as valid tables * Removed redundant table of contents and formatted some bulleted lists * The image in Regions.md is now properly displayed * Standardized list indentation, line spacing, table header rows, and JSON code blocks * Standardized headers * Fixed remaining broken links, edited pseudo-footnotes 2022-03-31 14:47:58 +07:00
Allow non-SSL-encrypted HTTP traffic & warn Dropbox users (#7013) * Add usesCleartextTrafic permission to Android manifest * Add warning for starting a multiplayer game with the default Dropbox server * Improve multiplayer server documentation * Only update the current game if we're using a custom server or it's not our turn * Refactor: Nicer variable name * Fix compilation * Fix type Don't know what happened there 2022-06-02 02:40:20 +07:00			`Before starting, you must have a Java JDK installed. You'll also have to download the [latest UncivServer.jar](https://github.com/yairm210/Unciv/releases/latest/download/UncivServer.jar).`
Update Hosting_a_Multiplayer_server.md (#6424) * Update Hosting_a_Multiplayer_server.md * Update Hosting_a_Multiplayer_server.md 2022-03-28 21:34:08 +07:00
Allow non-SSL-encrypted HTTP traffic & warn Dropbox users (#7013) * Add usesCleartextTrafic permission to Android manifest * Add warning for starting a multiplayer game with the default Dropbox server * Improve multiplayer server documentation * Only update the current game if we're using a custom server or it's not our turn * Refactor: Nicer variable name * Fix compilation * Fix type Don't know what happened there 2022-06-02 02:40:20 +07:00			From the directory where the `UncivServer.jar` file is located, create a folder named "MultiplayerFiles", open a terminal (in Windows, Shift+RightClick in the folder) and run the following command in the directory:
			`java -jar UncivServer.jar`
Unciv server (#6384) * Background implementation for Unciv server with ktor. Server ip in settings, able to copy your own ip and copy ip from clipboard for easy sharing, created stub for the client-server data transfer. No actual data storage or server implementation. * Unciv server round 2 - implementing crud for files and it works! metadata seems to only be in use for mutex, which is currently unused That's all for today * When starting a new multiplayer game the files are correctly saved in the server, and the server can return the files, but the function in the game to retrieve the game info is non-blocking so it doesn't work. Still, progress! * Changed the Gdx http to basic Java http, as used for Dropbox, and now everything works!!!! * Documentation for running and using the server * Better texts, translations, etc * Trog is right this should be a PUT not POST 2022-03-22 02:05:02 +07:00
Allow non-SSL-encrypted HTTP traffic & warn Dropbox users (#7013) * Add usesCleartextTrafic permission to Android manifest * Add warning for starting a multiplayer game with the default Dropbox server * Improve multiplayer server documentation * Only update the current game if we're using a custom server or it's not our turn * Refactor: Nicer variable name * Fix compilation * Fix type Don't know what happened there 2022-06-02 02:40:20 +07:00			`Your server has now started!`
Unciv server (#6384) * Background implementation for Unciv server with ktor. Server ip in settings, able to copy your own ip and copy ip from clipboard for easy sharing, created stub for the client-server data transfer. No actual data storage or server implementation. * Unciv server round 2 - implementing crud for files and it works! metadata seems to only be in use for mutex, which is currently unused That's all for today * When starting a new multiplayer game the files are correctly saved in the server, and the server can return the files, but the function in the game to retrieve the game info is non-blocking so it doesn't work. Still, progress! * Changed the Gdx http to basic Java http, as used for Dropbox, and now everything works!!!! * Documentation for running and using the server * Better texts, translations, etc * Trog is right this should be a PUT not POST 2022-03-22 02:05:02 +07:00
Allow non-SSL-encrypted HTTP traffic & warn Dropbox users (#7013) * Add usesCleartextTrafic permission to Android manifest * Add warning for starting a multiplayer game with the default Dropbox server * Improve multiplayer server documentation * Only update the current game if we're using a custom server or it's not our turn * Refactor: Nicer variable name * Fix compilation * Fix type Don't know what happened there 2022-06-02 02:40:20 +07:00			To check if everything works, you can start Unciv on the same computer, go to "Options > Multiplayer", then enter `http://localhost` as the "Server address" and click "Check connection to server". You should now get a "Success!" result, which means it's working!
Unciv server (#6384) * Background implementation for Unciv server with ktor. Server ip in settings, able to copy your own ip and copy ip from clipboard for easy sharing, created stub for the client-server data transfer. No actual data storage or server implementation. * Unciv server round 2 - implementing crud for files and it works! metadata seems to only be in use for mutex, which is currently unused That's all for today * When starting a new multiplayer game the files are correctly saved in the server, and the server can return the files, but the function in the game to retrieve the game info is non-blocking so it doesn't work. Still, progress! * Changed the Gdx http to basic Java http, as used for Dropbox, and now everything works!!!! * Documentation for running and using the server * Better texts, translations, etc * Trog is right this should be a PUT not POST 2022-03-22 02:05:02 +07:00
Allow non-SSL-encrypted HTTP traffic & warn Dropbox users (#7013) * Add usesCleartextTrafic permission to Android manifest * Add warning for starting a multiplayer game with the default Dropbox server * Improve multiplayer server documentation * Only update the current game if we're using a custom server or it's not our turn * Refactor: Nicer variable name * Fix compilation * Fix type Don't know what happened there 2022-06-02 02:40:20 +07:00			`To connect with other devices, you'll need the port (default 80) the server is running on to be visible externally (port forwarding) and know your external IP-address.`
Unciv server (#6384) * Background implementation for Unciv server with ktor. Server ip in settings, able to copy your own ip and copy ip from clipboard for easy sharing, created stub for the client-server data transfer. No actual data storage or server implementation. * Unciv server round 2 - implementing crud for files and it works! metadata seems to only be in use for mutex, which is currently unused That's all for today * When starting a new multiplayer game the files are correctly saved in the server, and the server can return the files, but the function in the game to retrieve the game info is non-blocking so it doesn't work. Still, progress! * Changed the Gdx http to basic Java http, as used for Dropbox, and now everything works!!!! * Documentation for running and using the server * Better texts, translations, etc * Trog is right this should be a PUT not POST 2022-03-22 02:05:02 +07:00
Allow non-SSL-encrypted HTTP traffic & warn Dropbox users (#7013) * Add usesCleartextTrafic permission to Android manifest * Add warning for starting a multiplayer game with the default Dropbox server * Improve multiplayer server documentation * Only update the current game if we're using a custom server or it's not our turn * Refactor: Nicer variable name * Fix compilation * Fix type Don't know what happened there 2022-06-02 02:40:20 +07:00			`On the other device, enter the URL to your server, click 'check connection' from the new device, and if you get the same "Success!" result - congratulations, you're connected to the same server and can start a multiplayer game!`
Unciv server (#6384) * Background implementation for Unciv server with ktor. Server ip in settings, able to copy your own ip and copy ip from clipboard for easy sharing, created stub for the client-server data transfer. No actual data storage or server implementation. * Unciv server round 2 - implementing crud for files and it works! metadata seems to only be in use for mutex, which is currently unused That's all for today * When starting a new multiplayer game the files are correctly saved in the server, and the server can return the files, but the function in the game to retrieve the game info is non-blocking so it doesn't work. Still, progress! * Changed the Gdx http to basic Java http, as used for Dropbox, and now everything works!!!! * Documentation for running and using the server * Better texts, translations, etc * Trog is right this should be a PUT not POST 2022-03-22 02:05:02 +07:00
Allow non-SSL-encrypted HTTP traffic & warn Dropbox users (#7013) * Add usesCleartextTrafic permission to Android manifest * Add warning for starting a multiplayer game with the default Dropbox server * Improve multiplayer server documentation * Only update the current game if we're using a custom server or it's not our turn * Refactor: Nicer variable name * Fix compilation * Fix type Don't know what happened there 2022-06-02 02:40:20 +07:00			`Please note:`
			`* Devices not connected to the same server will not be able to participate in multiplayer games together`
			`* In many places, your external IP address changes periodically. If that is the case, you either have to update the IP all the time or use something like a dynamic DNS service.`
Unciv server (#6384) * Background implementation for Unciv server with ktor. Server ip in settings, able to copy your own ip and copy ip from clipboard for easy sharing, created stub for the client-server data transfer. No actual data storage or server implementation. * Unciv server round 2 - implementing crud for files and it works! metadata seems to only be in use for mutex, which is currently unused That's all for today * When starting a new multiplayer game the files are correctly saved in the server, and the server can return the files, but the function in the game to retrieve the game info is non-blocking so it doesn't work. Still, progress! * Changed the Gdx http to basic Java http, as used for Dropbox, and now everything works!!!! * Documentation for running and using the server * Better texts, translations, etc * Trog is right this should be a PUT not POST 2022-03-22 02:05:02 +07:00
Allow non-SSL-encrypted HTTP traffic & warn Dropbox users (#7013) * Add usesCleartextTrafic permission to Android manifest * Add warning for starting a multiplayer game with the default Dropbox server * Improve multiplayer server documentation * Only update the current game if we're using a custom server or it's not our turn * Refactor: Nicer variable name * Fix compilation * Fix type Don't know what happened there 2022-06-02 02:40:20 +07:00			`## How To for people with hosting experience`
Update Hosting-a-Multiplayer-server.md (#6676) * Update Hosting-a-Multiplayer-server.md Added a section for explaining that Android does not like unencrypted traffic to a self-hosted server and that you need to setup a reverse proxy to do that. * Added hint for MultiplayerFiles folder 2022-05-03 11:52:59 +07:00
Allow non-SSL-encrypted HTTP traffic & warn Dropbox users (#7013) * Add usesCleartextTrafic permission to Android manifest * Add warning for starting a multiplayer game with the default Dropbox server * Improve multiplayer server documentation * Only update the current game if we're using a custom server or it's not our turn * Refactor: Nicer variable name * Fix compilation * Fix type Don't know what happened there 2022-06-02 02:40:20 +07:00			`* Have a Java JDK installed`
			`* Download the [latest UncivServer.jar](https://github.com/yairm210/Unciv/releases/latest/download/UncivServer.jar) (can also use that link to automatically update probably)`
			* See options with `java -jar UncivServer.jar --help`
			* The server will run on a specified port (`-p`, default `80`), writing files in a folder (`-f`, default `./MultiplayerGames/`), so it needs appropriate permissions.
			* Run it: `java -jar UncivServer.jar -p 8080 -f /some/folder/`
			`* It basically just does simple file storage over HTTP.`
			`* Files are not cleaned automatically if a game ends or is deleted on the client-side`