alkhe/kcsrv

An open source KanColle server

kcsrv

kcsrv is a project to try to implement an open source KanColle server.
It's currently under very heavy development, and no part of the game server even works. Check back later.

FAQ

Q: Will I be able to import my data from an official server?

Yup, you will be able to zip up KanColleTool's cache folder and thus import your old information. We will not ask for your API link to do this, nor touch your old server in any way.

Q: Why is it built on Python?

There aren't actually that many things you can build a web application on, and most of them were out from the start.

• PHP is an ungodly clusterfuck that's insanely unwieldly, performs about as well as a football team in Antarctica and is a nightmare to maintain.
  I've written large applications in PHP before, and I'm not going there again.

• Ruby and Java are both massive resource hogs, and this server needs to be able to scale well, preferably without me having me hire another server I can't pay for.
  I run a JIRA (Java) and a Discourse (Ruby) instance, and they both chew up nearly everything their servers have to give.

• NodeJS is actually a good candidate, mostly thanks to being blazing fast.
  Unfortunately, nearly everything around it (including the runtime itself) is in beta, and many things (such as database abstraction layers) simply aren't mature enough for me to want to depend on it - I have yet to see a robust migration system, for instance.
  One day I might even port over at least parts of the server to it (the game API comes to mind), but not right now.

Python isn't the fastest thing around, but both it and its ecosystem are very stable and mature. SQLAlchemy + Alembic alone makes an incredibly robust database abstraction layer, that nothing I've seen in NodeJS can match. (Do feel free to prove me wrong though.)

Q: I'm from DMM, can I just replace all our official servers with this?

Sure, go right ahead, I'll even come over there and set it up for you.

Development Setup

Should even work on Windows, since basically everything is in a known good VM configuration.

1. Install Ansible and Vagrant.
   These are the only things that will ever need to be installed on your host system.
   (Aside from a Git client, obviously, how else will you get the source?)

2. Set up the VM.
   It will automatically be provisioned by the Ansible playbook, assuming you have both Vagrant and Ansible installed properly.

   vagrant up
   vagrant ssh
   

   If you are using VirtualBox on Linux encounter problems, try enabling the following kernel modules (modprobe):

   vboxdrv
   vboxnetadp
   vboxnetflt
   

   If you get a message saying that Intel VT-x or AMD-V is required, you can either turn off long mode or enable the virtualization service through the BIOS.

   vboxmanage list vms
   vboxmanage modifyvm <name/uuid> --longmode off
   

   If you make any changes to the Vagrant configuration, reload the environment.

   vagrant reload
   

3. Set up the environment.
   The directory with the Vagrantfile is always mounted at /vagrant.

   cd /vagrant
   virtualenv .
   pip install -r requirements.txt
   

4. Create the database.
   Repeat this to upgrade it later.

   ./manage.py db upgrade
   ./manage.py setup
   

5. Create an account for yourself.
   Be sure to give yourself the admin and staff roles!

   ./manage.py user create
   

6. Run the development server.
   It will run on Port 5000, which nginx will proxy to Port 80. With the Vagrantfile's network adapter setup, this means it'll be accessible by opening 192.168.33.10 in a browser. (This will only be accessible from your local machine.)

   ./kcsrv.py