Arx II is the sequel to Arx: After the Reckoning, built on the Evennia framework.

This project uses mise to manage runtime versions and uv to manage Python dependencies.

• Git ≥ 2.29
• mise
• PowerShell 7+ (Windows PowerShell 5.1 is not supported for shell hooks)

Note: Python 3.13 will be automatically installed by mise.

Install mise using winget in PowerShell 7+:

winget install jdx.mise

⚠️ Ensure Python, Git, and mise are in your system PATH. After installing mise, you may need to restart your terminal.

1. Install PowerShell 7+

   • Download the latest version from: PowerShell GitHub Releases
   • Or install using winget:

     winget install --id Microsoft.PowerShell --source winget

2. Set as Default Shell (Recommended)

   • Open Windows Terminal
   • Click the down arrow next to the tab and select "Settings"
   • Under "Startup > Default Profile", select "PowerShell"
   • Click "Save"

Open PowerShell and run the following commands:

git clone https://github.com/Arx-Game/arxii.git
cd arxii

1. First, trust the project's configuration (you'll be prompted to confirm):

mise trust

2. Install the required tools:

mise install

3. Set up mise to be available in all terminal sessions by adding it to your PowerShell profile. First, ensure the profile directory exists and create it if needed:

# Create the PowerShell profile directory if it doesn't exist
if (-not (Test-Path -Path "$HOME\Documents\PowerShell")) {
    New-Item -ItemType Directory -Path "$HOME\Documents\PowerShell" -Force
}

# Add mise activation to your PowerShell profile (with proper newline)
Add-Content -Path $PROFILE -Value "`nmise activate pwsh | Out-String | Invoke-Expression"
# Note: The backtick before 'n ensures this starts on a new line in your profile

4. Close and reopen your terminal for the changes to take effect. The next time you open PowerShell, mise will be automatically activated.

5. In your new terminal session, verify the installations:

node --version  # Should show v20.0.0
python --version  # Should show Python 3.13.x
uv --version  # Should show the installed version

Note: If you don't want to restart your current terminal, you can manually activate mise in your current session with:

mise activate pwsh | Out-String | Invoke-Expression

uv venv
uv sync

Check that the correct versions are being used:

python --version  # Should show Python 3.13.x
node --version   # Should show v20.x.x
npm --version    # Should show 11.5.1

New-Item -Path .\src\.env -ItemType File

pre-commit install

After setup, use the arx command-line tool:

arx test

arx test --coverage

arx shell

arx manage show_urls

arx build

arx start

arx serve

This command compiles the React app, collects static files, and launches the Evennia server.

arx stop

arx reload