/kenshi-ui

A pet project focusing the porting of Kenshi UI to the browser.

Primary LanguageJavaScript

Kenshi UI

Imagine managing inventory to the sound of a dark ambient music, while watching
the day turns into night and vice versa, and so on, right in your browser.
Well, that's what it's all about.

View Demo »

About

This application carefully interprets all the above mentioned experience you might have when playing the Kenshi game.

Here's the list of core Kenshi UI features:

  • Complete day/night cycle and time speed control.
  • Registry of items with properties taken from the game (thanks to OCS).
  • All the inventory management related logic including dragging with a mouse (or any other pointing device), item stacks, automatic arrangement, continuous (re)placement, fast distributive moving, targeting of type-specific regions, cross-character moving and more and more.
  • GUI sounds and music system that imitates the original one.
  • Flexible layout that looks relatively well on small screens.
  • Minimalist styling taken from the Dark UI mod.
  • Minor improvements affecting user experience.

Code

Vue

The code is organised into layers of data and interface, which makes it easy to reason about.

Also there is a tool called Kenshi UI Items Loader that allows to get/update the items data right from the installed copy of a game. It utilizes the Open Construction Set (OCS) modding SDK.

Thanks

This application would not be possible without:

  • Lo-Fi Games, developers of Kenshi
  • Kole Hicks, composer/sound designer of Kenshi
  • lmaydev, the creator of an amazing Open Construction Set modding tool
  • Eldryn, the creator of Dark UI mod
  • Kenshi Wiki contributors and maintainers

@ All rights belong to their respective owners