krinfo

A web application that provides a number of data from the mobile game King's Raid.

Features

• Hero Database: Detailed information on heroes, including profile, skills, perks, unique weapons, unique treasures, soul weapons, splasharts, costumes, 3D models and voice lines.
• Artifacts & Bosses: Comprehensive list of game artifacts and detailed boss information.
• Team Builder: Plan and create your ideal team compositions.
• Softcaps: View detailed statistics and softcap thresholds for optimized builds.
• Stats: Compare stat numbers between versions.
• Compare Tool: Compare different heroes or artifacts side-by-side.
• 3D Model Viewer: Web-based interactive 3D models of the heroes via Three.js.
• News Feed: Catch up with the latest King's Raid news via Steam RSS.

Data being used includes before doomsday (Vespa) and distributed by Masangsoft (currently 3 CBTs).

Getting Started

Data and 3D Model Files

Data and illustrations are stored in kingsraid-data (required). 3D model and audio files are in self-hosted Git servers kingsraid-models and kingsraid-audio due to their large size (optional).

By default, only the kingsraid-data submodule is used to keep the repository size manageable. The models and audio submodules are optional and only needed if you want the Models and Voices features (total size ~40GB).

Prerequisites

• Bun
• Git

Installation

Firstly, clone the repository:

git clone https://github.com/faberuser/krinfo.git
cd krinfo

Default Setup

This setup includes only the required data and is suitable for most deployments:

1. Initialize basic data submodule:

git submodule update --init public/kingsraid-data

2. Install dependencies:

bun install

3. Run the development server:

bun dev

The Models and Voices tabs will be disabled by default.

Full Setup (with Models & Voices)

If you want the 3D model viewer and voice lines features:

1. Clone the optional repositories:

git clone https://gitea.k-clowd.top/faberuser/kingsraid-models public/kingsraid-models
git clone https://gitea.k-clowd.top/faberuser/kingsraid-audio public/kingsraid-audio

2. Create environment file to enable these features:

Linux:

echo "NEXT_PUBLIC_ENABLE_MODELS_VOICES=true" > .env

Windows:

"NEXT_PUBLIC_ENABLE_MODELS_VOICES=true" | Out-File -FilePath .env -Encoding utf8

3. Install dependencies:

bun install

4. Run the development server:

bun dev

Open http://localhost:3000 in your browser.

Docker Deployment

The application can be deployed using Docker:

Default Build

1. Build the image:

docker build -t krinfo .

2. Run the container:

docker run -p 3000:3000 krinfo

Full Build (with Models and Voices)

To include 3D models and voices:

1. Build the image with the environment variable:

docker build --build-arg NEXT_PUBLIC_ENABLE_MODELS_VOICES=true -t krinfo .

2. Run the container:

docker run -p 3000:3000 krinfo

Using Docker Compose

Due to GHCR limitation, Docker image only support standard version.

To use the pre-built image (default, no build):

docker-compose up -d

To build:

docker-compose -f docker-compose.yml -f docker-compose.build.yml up -d --build

The application will be available at http://localhost:3000 (or the port specified in your environment).

Environment Variables

Create a .env file for local usage. See .env.example for all available options.

Environment Variables:

• NEXT_PUBLIC_ENABLE_MODELS_VOICES: Set to "true" to enable Models and Voices features (optional, default: false)
• NEXT_PUBLIC_BASE_PATH: Base path for the application (e.g., "/krinfo" for GitHub Pages) (optional)
• NEXT_STATIC_EXPORT: Set to "true" when building for static export (optional, default: false)
• NEXT_PUBLIC_SITE_URL: Site URL for metadata (optional)
• DOCKER_IMAGE: Docker Compose's image, mostly for custom registry in case you want full build (optional, default: "ghcr.io/faberuser/krinfo:latest")
• CONTAINER_NAME: Docker Compose's container name (optional, default: "krinfo")
• DOCKER_PORT: Docker Compose's container port (optional, default: 3000)