The Hytale Community Repository

modtale/
├── backend/                       # ☕ Spring Boot API
│   ├── src/main/java/             # Core Java Application
│   │   ├── config/                # Security, CORS, and WebMvc configs
│   │   ├── controllers/           # REST endpoints mapping
│   │   ├── models/                # MongoDB document schemas
│   │   ├── repositories/          # Database interaction layer
│   │   └── services/              # Core business logic (Uploads, Auth, etc.)
│   └── build.gradle               # Dependencies & build definitions
│
├── frontend/                      # Astro + React Web Application
│   ├── src/
│   │   ├── components/            # Reusable, stateless UI components (Buttons, Modals)
│   │   ├── modules/               # Domain-Driven Design (Auth, Project, User domains)
│   │   ├── pages/                 # Astro SSR entry points (e.g., /[...all].astro)
│   │   ├── styles/                # Tailwind global CSS & theme constants
│   │   └── utils/                 # API clients, Helpers
│   ├── astro.config.mjs           # Astro build & integration settings
│   └── package.json               # Node dependencies
│
└── Warden/                        # Security Scanner Service (Closed Source)

Ready to contribute? Follow these steps to get Modtale running on your local machine.

• Node.js: v20 or higher.
• Java JDK: Version 21 (Amazon Corretto, Eclipse Temurin, or standard OpenJDK).
• MongoDB: A local instance running on port 27017, or a valid MongoDB Atlas connection string.

git clone https://github.com/Modtale/modtale.git
cd modtale

The Spring Boot backend relies on environment variables. You can set these in your IDE's Run Configuration or export them directly in your terminal.

Note on Warden: The "Warden" malware and security scanner is proprietary to protect our threat-detection logic. You must set WARDEN_ENABLED=false to run the backend locally. This enables a "Mock Mode" where file uploads bypass the scanner and automatically return a mock "CLEAN" status.

(Optional) OAuth Variables: To test social logins (GitHub, Discord, Google), provide their respective Client IDs and Secrets (e.g., GITHUB_CLIENT_ID / GITHUB_CLIENT_SECRET).

Open a terminal in the backend/ directory and use the Gradle wrapper.

cd backend
# Linux/Mac
./gradlew bootRun

# Windows
gradlew.bat bootRun

The API will start and listen on http://localhost:8080.

Create a .env file inside the frontend/ directory to point the React client to your local API.

File: frontend/.env

PUBLIC_API_URL=http://localhost:8080/api/v1

Next, open a separate terminal, install the Node dependencies, and start the Astro development server.

cd frontend
npm install
npm run dev

The web client is now accessible at http://localhost:5173!

This project is licensed under the GNU Affero General Public License v3.0 (AGPLv3).

Modtale is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This ensures that the platform remains open and accessible to the Hytale community forever.

• Docs: modtale.net/api-docs
• Discord: Join the Server
• X (Twitter): @modtalenet
• Bluesky: @modtale.net

We welcome contributions from the community! Whether it's a bug fix, a new feature, or documentation improvements, please refer to our CONTRIBUTING.md for coding guidelines and pull request instructions.