{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"Installation Instructions","type":"basic","slug":"server-installation-instructions","excerpt":"","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Don't have a website host yet?\",\n  \"body\": \"We recommend either Bluehost (low cost, standard hosting) or Knownhost (fully-managed scalable VPS servers with excellent support)\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"What is Online Server Sync?\"\n}\n[/block]\nThe CityBuildingKit.com includes PHP server scripts that allow you to sync player data across devices or let players battle other players to steal their loot, or attack campaign bases to gain loot.  These scripts also include a control panel so you can view development messages in the Datalog for testing or player statistics for launch. \n\nFor serious game launches, we recommend using a custom built solution - but for individual developers who don't have access to the programming or resources we've included these scripts as a complimentary bonus with every purchase of our highest package kit.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/1efa684-online-game-control-panel.jpg\",\n        \"online-game-control-panel.jpg\",\n        800,\n        325,\n        \"#187e90\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"What programming language do you use?\"\n}\n[/block]\nThe server scripts are made with **PHP** - which will work on nearly all web hosting companies, VPS servers, or more advance configurations like Amazon EC2 web instances. This language has lots of expandability and support for both individual developers. Tens of  thousands of freelance developers on Upwork.com know this language and can be hired for additional work. It's the web software standard programming language that major platforms like Wordpress also use.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Do I need a web host or do you offer a copy customers can use for free?\"\n}\n[/block]\n**We have a free experimental server for customers.** Each City Building Kit comes preconfigured to use our free customer hosting scripts that work with the demo so you can test how it works. The game kit downloads pre-made maps and rotates through a few enemy base options for war examples when you go to battle. Everything is setup out of the box for developers to test with. \n\n**No server is necessary to test**, just make sure to add your license code to both Game scene GameManager > SaveLoadWWW (for settings server load and server save testing) and Map01 scene GameManager > SaveLoadBattle for enemy map and campaign map battle gameplay.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Where can I download the server scripts?\"\n}\n[/block]\nDownload your copy from the CityBuildingKit.com/download customer download center. If you ordered our product in the Unity Asset Store, please contact help at citybuildingkit.com to request your copy of the server scripts.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"How do I install the server scripts?\"\n}\n[/block]\nOur Complete Game Kit comes with demo server software designed in PHP ready-to-test on your website and fully compatible with the City Builder Kit. [Get the kit now](http://citybuildingkit.com/#pricing)\n\n**Required Server Configuration:** Any standard web host supports the PHP sample scripts and file writing. (For example, [Bluehost](http://www.bluehost.com/track/hf/ffi)) No special server or database is necessary for the online player-versus-player asyncrnous gameplay.\n\n**Installation Instructions:**\n\n1. Unzip the demo PHP software scripts included with your Complete Game Kit purchase. You will also find a maps directory with prefilled demo maps and campaign maps (campaign maps start with the filename **0000camp**)  \n \nThe readme.txt file included will repeat these instructions. If you don't have the kit, you can [upgrade or purchase the Complete Kit](http://citybuildingkit.com/#pricing)\n\n2. First, connect through FTP to your server. If you don't have an FTP application - we recommend the free Filezilla application. Any regular Linux server with PHP support should work.\n \n3. Create a new folder. Optionally, if you experience trouble uploading sample maps, make sure the folder you create has 777 READ/WRITE/EXEC permission. ([Watch how here](https://www.youtube.com/watch?v=oq0oM2w9lcQ), not recommended for every installation, only if necessary)\n\n4. Upload all the files included in the demo PvP zip you downloaded from our customer center.\n\n5. Open your web browser and access the URL you uploaded, like http://yoursite.com/pvp/ it should show a login page like follows:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/1163493-Screen_Shot_2016-11-23_at_1.31.25_PM.png\",\n        \"Screen Shot 2016-11-23 at 1.31.25 PM.png\",\n        1271,\n        880,\n        \"#dec8bb\"\n      ],\n      \"caption\": \"Click to view larger.\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Do you not see the login page above?\",\n  \"body\": \"Check to make sure you're entering the correct URL to where you uploaded the server files in the zip. For example, http://yoursite.com/pvp/\\n\\nNext, check to make sure your server supports PHP files. Create a blank file called test.php with the text <? phpinfo(); ?> and upload it to your website. You should see a large page with the PHP logo and all your PHP settings listed out in a table. If you see this, delete this test page immediately. This confirms PHP works on your server. \\n\\nIf you do not see this - then PHP is not enabled on your server. Talk to your hosting company or use the CityBuildingKit.com demo server details included in a default kit.\"\n}\n[/block]\n6. Enter the default login and password you see in read me included in the PHP files.\n\n7. Immediately go to the settings section and change the password to a new one. This will update the configuration file. Also delete the read me file from the server.\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Update the temporary password immediately!\",\n  \"body\": \"Open settings and change the password once you have logged in to your player console. Also delete the read me file from the server as extra security.\"\n}\n[/block]","updates":[],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e7568806ba2a1003247c651","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Online Server Sync","slug":"online-server-sync","order":7,"from_sync":false,"reference":false,"_id":"5e7568806ba2a1003247c61f","version":"5e7568806ba2a1003247c68d","project":"543b9b0065bf840e00b473d5","createdAt":"2016-11-20T00:22:30.250Z","__v":0},"project":"543b9b0065bf840e00b473d5","user":"543b9aa865bf840e00b473d1","parentDoc":null,"version":{"version":"2020","version_clean":"2020.0.0","codename":"Ultimate","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5e7568806ba2a1003247c618","5e7568806ba2a1003247c619","5e7568806ba2a1003247c61a","5e7568806ba2a1003247c61b","5e7568806ba2a1003247c61c","5e7568806ba2a1003247c61d","5e7568806ba2a1003247c61e","5e7568806ba2a1003247c61f","5e7568806ba2a1003247c620","5e7568806ba2a1003247c621","5e7568806ba2a1003247c622","5e7568806ba2a1003247c623","5e7568806ba2a1003247c624"],"_id":"5e7568806ba2a1003247c68d","project":"543b9b0065bf840e00b473d5","createdAt":"2017-09-02T00:13:39.834Z","releaseDate":"2017-09-02T00:13:39.834Z","__v":0,"forked_from":"59a9f7b328ab5f000f23954a"},"createdAt":"2016-11-20T00:22:53.293Z","githubsync":"","__v":0}

Installation Instructions


[block:callout] { "type": "info", "title": "Don't have a website host yet?", "body": "We recommend either Bluehost (low cost, standard hosting) or Knownhost (fully-managed scalable VPS servers with excellent support)" } [/block] [block:api-header] { "type": "basic", "title": "What is Online Server Sync?" } [/block] The CityBuildingKit.com includes PHP server scripts that allow you to sync player data across devices or let players battle other players to steal their loot, or attack campaign bases to gain loot. These scripts also include a control panel so you can view development messages in the Datalog for testing or player statistics for launch. For serious game launches, we recommend using a custom built solution - but for individual developers who don't have access to the programming or resources we've included these scripts as a complimentary bonus with every purchase of our highest package kit. [block:image] { "images": [ { "image": [ "https://files.readme.io/1efa684-online-game-control-panel.jpg", "online-game-control-panel.jpg", 800, 325, "#187e90" ] } ] } [/block] [block:api-header] { "type": "basic", "title": "What programming language do you use?" } [/block] The server scripts are made with **PHP** - which will work on nearly all web hosting companies, VPS servers, or more advance configurations like Amazon EC2 web instances. This language has lots of expandability and support for both individual developers. Tens of thousands of freelance developers on Upwork.com know this language and can be hired for additional work. It's the web software standard programming language that major platforms like Wordpress also use. [block:api-header] { "type": "basic", "title": "Do I need a web host or do you offer a copy customers can use for free?" } [/block] **We have a free experimental server for customers.** Each City Building Kit comes preconfigured to use our free customer hosting scripts that work with the demo so you can test how it works. The game kit downloads pre-made maps and rotates through a few enemy base options for war examples when you go to battle. Everything is setup out of the box for developers to test with. **No server is necessary to test**, just make sure to add your license code to both Game scene GameManager > SaveLoadWWW (for settings server load and server save testing) and Map01 scene GameManager > SaveLoadBattle for enemy map and campaign map battle gameplay. [block:api-header] { "type": "basic", "title": "Where can I download the server scripts?" } [/block] Download your copy from the CityBuildingKit.com/download customer download center. If you ordered our product in the Unity Asset Store, please contact help at citybuildingkit.com to request your copy of the server scripts. [block:api-header] { "type": "basic", "title": "How do I install the server scripts?" } [/block] Our Complete Game Kit comes with demo server software designed in PHP ready-to-test on your website and fully compatible with the City Builder Kit. [Get the kit now](http://citybuildingkit.com/#pricing) **Required Server Configuration:** Any standard web host supports the PHP sample scripts and file writing. (For example, [Bluehost](http://www.bluehost.com/track/hf/ffi)) No special server or database is necessary for the online player-versus-player asyncrnous gameplay. **Installation Instructions:** 1. Unzip the demo PHP software scripts included with your Complete Game Kit purchase. You will also find a maps directory with prefilled demo maps and campaign maps (campaign maps start with the filename **0000camp**) The readme.txt file included will repeat these instructions. If you don't have the kit, you can [upgrade or purchase the Complete Kit](http://citybuildingkit.com/#pricing) 2. First, connect through FTP to your server. If you don't have an FTP application - we recommend the free Filezilla application. Any regular Linux server with PHP support should work. 3. Create a new folder. Optionally, if you experience trouble uploading sample maps, make sure the folder you create has 777 READ/WRITE/EXEC permission. ([Watch how here](https://www.youtube.com/watch?v=oq0oM2w9lcQ), not recommended for every installation, only if necessary) 4. Upload all the files included in the demo PvP zip you downloaded from our customer center. 5. Open your web browser and access the URL you uploaded, like http://yoursite.com/pvp/ it should show a login page like follows: [block:image] { "images": [ { "image": [ "https://files.readme.io/1163493-Screen_Shot_2016-11-23_at_1.31.25_PM.png", "Screen Shot 2016-11-23 at 1.31.25 PM.png", 1271, 880, "#dec8bb" ], "caption": "Click to view larger." } ] } [/block] [block:callout] { "type": "warning", "title": "Do you not see the login page above?", "body": "Check to make sure you're entering the correct URL to where you uploaded the server files in the zip. For example, http://yoursite.com/pvp/\n\nNext, check to make sure your server supports PHP files. Create a blank file called test.php with the text <? phpinfo(); ?> and upload it to your website. You should see a large page with the PHP logo and all your PHP settings listed out in a table. If you see this, delete this test page immediately. This confirms PHP works on your server. \n\nIf you do not see this - then PHP is not enabled on your server. Talk to your hosting company or use the CityBuildingKit.com demo server details included in a default kit." } [/block] 6. Enter the default login and password you see in read me included in the PHP files. 7. Immediately go to the settings section and change the password to a new one. This will update the configuration file. Also delete the read me file from the server. [block:callout] { "type": "danger", "title": "Update the temporary password immediately!", "body": "Open settings and change the password once you have logged in to your player console. Also delete the read me file from the server as extra security." } [/block]