Skip to content

Installation and setup

Jump to bottom
Tibo edited this page May 1, 2022 · 9 revisions

Installation and setup

Here's a video that shows how to install it in <90s (uses Chrome as example).

Setup

It's recommended that you start out from a cache dump. You can download the latest one from shizuru.piro.moe/kccp/ or Oradimi's MEGA (should be a bit over ~5GB). If you just want the minimal files required for the gadget server block since 2020-02-25, they are included in the new versions of the proxy.

Setup for Windows (with UI)

  1. Go to Releases and download the Setup.exe
  2. Run this file, this will set up automatic startup on windows and some icons.
  3. You can also change the location to store cache (click on save). Optionally (but recommended), you can import the minimal cache required to bypass from the UI. See Using cache dumps for more information about using the full one.
  4. Depending on browser/viewer used, set it up to use localhost:8081 as HTTP proxy. Below are some details) on how to do it for some viewers/chrome.

Upgrading from v1

Install like above. Then in the UI you can set the cache location. You can move this folder wherever you want now. Clicking on save will load the cache at that location (if there is one). If you set up auto startup for the old version, please remove these.

Setup using other compiled versions (legacy)

  1. Go to Releases and download the zip for your platform
  2. Unzip this file somewhere, run the executable. Recommended to do this from command prompt/powershell/terminal so the output is visible after it finishes running.
  3. (Optional) Extract the downloaded cache dump, so you'll have a folder cache with cached.json in it respectively to where you unzipped/cloned the repository (if there's a file ./proxy.js then there should be ./cache/cached.json).
  4. Depending on browser/viewer used, set it up to use localhost:8081 as HTTP proxy. Below are some details) on how to do it for some viewers/chrome.

Setup using node (legacy)

  1. This proxy requires Node, and optionally git to clone this repository (or download zip at top right, unzip it somewhere).
  2. Install dependencies with npm by running npm i --only=production in the folder with package.json.
  3. (Optional) Extract the downloaded cache dump, so you'll have a folder cache with cached.json in it respectively to where you unzipped/cloned the repository (if there's a file ./proxy.js then there should be ./cache/cached.json).
  4. You can start the proxy server with node proxy.
  5. Depending on browser/viewer used, set it up to use localhost:8081 as HTTP proxy. Below are some details) on how to do it for some viewers/chrome.

NOTE for technical people: You can NOT run both the preloader and proxy server at the same time, unless you run the preloader via the proxy on startup.

Using cache dumps

You can download the latest one from shizuru.piro.moe/kccp/ or Oradimi's MEGA. Full one should be a bit over ~4GB. Download the latest full one (if needed) and the latest differential one for that full one. I'll try to release full ones every once in a while, and differentials to the latest full dump every bigger maint.

Minimum cache dump

Just click the button in the UI

Full cache dumps

  • Method A:
  • Method B:
    • Extract these to some folder. If you are using the same folder as your cache, try not to play the game, since it can overwrite the metadata required for the cache to work (you can just re-extract cached.json from zip if you did).
    • Set the cache folder to the folder you extracted to from the UI and click on Save. If it's the same as existing one, click on Reload Cache.
    • The stats at top should indicate that you have thousands of files cached of around >4GB total. If this isn't the case, try re-extracting cached.json to the cache folder and click on Reload cache

Differential cache dumps

Click on Import cache dump button, select the zip and wait. There should be output in Proxy log at end.

Updating

Game/Cache

Game files should be automatically updated on the fly. No need to redownload the full cache dump. There should be regular differential cache dumps being released to keep your copy up to date. See Using cache dumps for more information.
If you are having trouble entering after a maint/game didn't update properly. See FAQ/Game didn't update.

Proxy

If you want to update the proxy, just re-run the Setup. If you're running node version and installed via git, run git pull and restart proxy. Otherwise unzip and restart proxy.

Browser/Viewer setup

Below are some instructions for some viewers/browsers available

Chrome proxy setup

With pictures

  1. To use this in chrome, an extension like Proxy SwitchyOmega
  2. Open options of said extension (from drop down menu)
  3. Open the default proxy profile (or create a new one if you want)
  4. Set up the profile as follow: Screenshot
    1. Click on Show Advanced
    2. Change the top protocol to DIRECT
    3. In the the http:// row: set Protocol to HTTP, Server to localhost and Port to 8081
  5. Close the options tab and enable the proxy profile (or whatever you named it) in the dropdown menu. Preview

Electronic Observer

  1. Open settings via File -> Settings.
  2. Go to Network tab (should be first tab) and check Use local proxy and enter port 8081 (this can be changed in the config.json or the UI). Preview
  3. Save and restart EO to apply your settings. Preview

Poi

  1. Open settings via the gear icon
  2. Go to Network tab (should be fourth tab) set proxy to HTTP Proxy and change port to 8081 (this can be changed in the config.json or the UI). Preview
  3. No refresh required, but it should help checking if it works by looking at the console window. Preview
Clone this wiki locally