<commit_before>INSTALLATION INSTRUCTIONS
====

## Prerequisites

* Linux or MacOS (haven't tested on Windows)
* Git
* unzip command for extracting zip archives
* Python3
* Node and npm
* Optional NPM modules: mysql or mongodb

## Get the code

First, clone the voxeling git repo into your current working directory.

```shell
git clone https://github.com/alanszlosek/voxeling.git
```

## Install dependencies and generate texture atlases

Run the `setup.sh` script to get textures, install deps, generate texture atlases.

```shell
cd voxeling
./scripts/setup.sh
```

## Configure data storage

Now decide whether you want to store world state in files, mysql or in mongodb. Visit the appopriate sub-section below.

### Option 1: Store world state in files

Create a folder for the world chunk files and set path in server config.

```shell
mkdir -p chunks/FOLDER_FOR_YOUR_DATA
```

Now set chunkFolder in config-server.mjs accordingly.

### Option 2: Store world state in MySQL/MariaDB

Install the mysql module.

```shell
npm install mysql
```
<commit_msg>mention that mysql backend docs are incomplete<commit_after>INSTALLATION INSTRUCTIONS
====

## Prerequisites

* Linux or MacOS (haven't tested on Windows)
* Git
* unzip command for extracting zip archives
* Python3
* Node and npm
* Optional NPM modules: mysql or mongodb

## Get the code

First, clone the voxeling git repo into your current working directory.

```shell
git clone https://github.com/alanszlosek/voxeling.git
```

## Install dependencies and generate texture atlases

Run the `setup.sh` script to get textures, install deps, generate texture atlases.

```shell
cd voxeling
./scripts/setup.sh
```

## Configure data storage

Now decide whether you want to store world state in files, mysql or in mongodb. Visit the appopriate sub-section below.

### Option 1: Store world state in files

Create a folder for the world chunk files and set path in server config.

```shell
mkdir -p chunks/FOLDER_FOR_YOUR_DATA
```

Now set chunkFolder in config-server.mjs accordingly.

### Option 2: Store world state in MySQL/MariaDB

Note: These instructions are currently incomplete. Need to add schema creation steps.

Install the mysql module.

```shell
npm install mysql
```

{'fraction_non_alphanumeric': 0.08005366726296959, 'fraction_numerical': 0.0026833631484794273, 'mean_word_length': 4.45609756097561, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3036437', 'n_tokens_mistral': 690, 'n_tokens_neox': 630, 'n_words': 290}