# kinoko

**Repository Path**: Atoot/kinoko

## Basic Information

- **Project Name**: kinoko
- **Description**: No description available
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-10-29
- **Last Updated**: 2026-04-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## Kinoko

Kinoko is a server emulator for the popular mushroom game.

## Setup

Basic configuration is available via environment variables - the names and default values of the configurable options
are defined in [ServerConstants.java](src/main/java/kinoko/server/ServerConstants.java)
and [ServerConfig.java](src/main/java/kinoko/server/ServerConfig.java).

> [!NOTE]
> Client WZ files are expected to be present in the `wz/` directory in order for the provider classes to extract the
> required data. The required files are as follows:
> ```
> Character.wz
> Item.wz
> Skill.wz
> Morph.wz
> Map.wz
> Mob.wz
> Npc.wz
> Reactor.wz
> Quest.wz
> String.wz
> Etc.wz
> ```

#### Java setup

Building the project requires Java 21 and maven.

```bash
# Build jar
$ mvn clean package
```

#### Database setup

Kinoko defaults to using SQLite as the database provider for ease of use. No setup is required in this case.

It is possible to use either CassandraDB or ScyllaDB instead of SQLite, which requires starting the database using the commands below.

```bash
# Start CassandraDB
$ docker run -d -p 9042:9042 cassandra:5.0.0

# Alternatively, start ScyllaDB
$ docker run -d -p 9042:9042 scylladb/scylla --smp 1
```

You can use [Docker Desktop](https://www.docker.com/products/docker-desktop/) or WSL on Windows.

#### Docker setup

Alternatively, docker can be used to build and start the server using the [docker-compose.yml](docker-compose.yml) file.

```bash
# Build and start containers
$ docker compose up -d
```


To start the server with CassandraDB, the [docker-compose.cassandra.yml](docker-compose.cassandra.yml) file can be used as follows:

```bash
$ docker compose -f docker-compose.cassandra.yml up -d
```