Skip to content

INSTALLATION.md

Latest commit

 

History

History
108 lines (86 loc) · 3.03 KB

INSTALLATION.md

File metadata and controls

108 lines (86 loc) · 3.03 KB

🚀 Quick Start (Recommended)

For the easiest installation experience with automatic updates:

📥 Download Woodlanders Launcher

The launcher provides:

  • ✅ Single-click download and installation
  • 🔄 Automatic update checks
  • 🎮 Easy game launch
  • 📦 No manual dependency management required

Requirements

  • Java 21+ (OpenJDK 21.0.8 or higher)
  • Gradle 9.2.0+
  • libGDX 1.12.1

Technical Details

Project Information

  • Version: 0.0.8
  • Game Engine: libGDX 1.12.1
  • Language: Java 21
  • Build Tool: Gradle 9.2.0
  • Architecture: Client-Server with dedicated server support

Key Technologies

  • Graphics: libGDX with LWJGL3 backend
  • Fonts: FreeType font rendering (slkscr.ttf)
  • Networking: Java Socket-based TCP networking
  • Serialization: Java ObjectOutputStream for world saves
  • Concurrency: Multi-threaded server with client connection pools

Install SDKMAN (for Gradle management)

curl -s "https://get.sdkman.io" | bash
source "$HOME/.sdkman/bin/sdkman-init.sh"

Add to ~/.bashrc

# THIS MUST BE AT THE END OF THE FILE FOR SDKMAN TO WORK!!!
export SDKMAN_DIR="$HOME/.sdkman"
[[ -s "$HOME/.sdkman/bin/sdkman-init.sh" ]] && source "$HOME/.sdkman/bin/sdkman-init.sh"

# Java configuration
export JAVA_HOME=/usr/lib/jvm/java-21-openjdk
export PATH="$JAVA_HOME/bin:$PATH"

Install Gradle via SDKMAN

sdk install gradle 9.2.0

How to Run

Run from Source

cd <project folder>/Woodlanders
gradle runApp - Launches the main Woodlanders application
gradle runLauncher - Launches the launcher UI

Build and Run Client JAR

cd <project folder>/Woodlanders
gradle clean build -x test
java -jar build/libs/woodlanders-client.jar

Build and Run Dedicated Server

cd <project folder>/Woodlanders
gradle clean build -x test
java -jar build/libs/woodlanders-server.jar

Server with Custom Configuration

# Basic server start
java -jar build/libs/woodlanders-server.jar

# With custom port
java -jar build/libs/woodlanders-server.jar --port 30000

# With custom config file
java -jar build/libs/woodlanders-server.jar --config custom.properties

# With memory allocation
java -Xms2G -Xmx2G -jar build/libs/woodlanders-server.jar

# All options combined
java -Xms4G -Xmx4G -jar build/libs/woodlanders-server.jar --port 25565 --config server.properties

Windows launcher cleanup

PowerShell 7.5.4
PS C:\Windows\System32> Remove-Item -Path "$env:LOCALAPPDATA\Woodlanders\Launcher" -Recurse -Force -ErrorAction SilentlyContinue
PS C:\Windows\System32> Remove-Item -Path "$env:USERPROFILE\Desktop\Woodlanders Launcher.lnk" -Force -ErrorAction SilentlyContinue
PS C:\Windows\System32> Remove-Item -Path "$env:APPDATA\Microsoft\Windows\Start Menu\Programs\Woodlanders" -Recurse -Force -ErrorAction SilentlyContinue
PS C:\Windows\System32> Write-Host "Launcher installation removed" -ForegroundColor Green
Launcher installation removed
PS C:\Windows\System32>