Skip to main content
Before setting up the Oyasai Server Platform development environment, ensure your system meets the following requirements.

​
Operating System

Windows users must install and use WSL (Windows Subsystem for Linux). All development work must be performed within the WSL environment.
Supported operating systems:
  • Linux (any modern distribution)
  • macOS
  • Windows with WSL

​
Installing WSL (Windows Only)

If you’re on Windows, install WSL before proceeding: 
wsl --install
After installation, restart your computer and launch your WSL terminal for all subsequent steps.

​
Nix Package Manager

The Oyasai Server Platform uses Nix flakes for reproducible development environments and builds. Nix is required for all development work.

​
Why Nix?

Nix provides:
  • Reproducible development environments across all team members
  • Declarative dependency management
  • Isolated build environments
  • Automatic dependency resolution for Java, Gradle, Node.js, and other tools

​
Installation

1

Download and install Nix

Visit nixos.org and follow the installation instructions.Multi-user installation is recommended, but single-user installation works as well.
2

Restart your terminal

After installation completes, close and reopen your terminal to ensure Nix is available in your PATH.
3

Enable experimental features

Enable the nix-command and flakes experimental features:
mkdir -p ~/.config/nix && echo 'experimental-features = nix-command flakes' >> ~/.config/nix/nix.conf

​
Git

Git is required for version control and must be installed on your system. Most systems come with Git pre-installed, but you can verify: 
git --version
If Git is not installed, use your system’s package manager: 
sudo apt-get update
sudo apt-get install git

​
Disk Space

Ensure you have adequate disk space:
  • Minimum: 5 GB free space
  • Recommended: 10 GB or more
Nix stores build artifacts and dependencies, which can consume significant space over time.

​
Internet Connection

A stable internet connection is required for:
  • Downloading Nix packages and dependencies
  • Fetching Gradle dependencies
  • Accessing Maven repositories (purpurmc.org, nexus.frengor.com, etc.)

​
Next Steps

Once all prerequisites are installed, proceed to Development Environment to set up your development shell.

Build docs developers (and LLMs) love

Get started for freeTalk to us