Skip to content

mc-ServerJars/serverjars

Repository files navigation

ServerJars - Minecraft Server Jar Repository

Warning

The code in this repository will not populate/update the database, please use the updater.

image

ServerJars is an open-source repository for Minecraft server jars, providing an easy way to discover and download server software for various Minecraft forks.

Features

  • 🚀 Modern, responsive UI with gaming-inspired design
  • 🔍 Powerful search functionality
  • 📦 Comprehensive API for programmatic access
  • 📊 Real-time statistics and metrics

Prerequisites

Before installing ServerJars, ensure you have:

  • PHP 8.0 or higher
  • MySQL 5.7+ or MariaDB 10.3+
  • Apache web server with mod_rewrite enabled
  • Composer (for dependency management)
  • Node.JS to run the updater and populate the database

Installation

1. Clone the repository

git clone https://github.com/mc-ServerJars/serverjars.git
cd serverjars

2. Install dependencies

composer install

3. Configure environment

Create a config.php file by copying the sample:

cp config.sample.php config.php

Edit config.php with your database credentials:

<?php
$dbHost = 'localhost';      // Database host
$dbName = 'serverjars_db';  // Database name
$dbUsername = 'db_user';    // Database username
$dbPassword = 'secure_pass';// Database password

4. Set up the database

Import the SQL schema:

mysql -u [username] -p [database_name] < schema.sql

Usage

After installation, you can:

  1. Access the web interface at http://your-server-address
  2. Use the search functionality to find server jars
  3. Browse different Minecraft forks (Paper, Purpur, Fabric, etc.)
  4. Access the API documentation at /docs

API Documentation

ServerJars provides a comprehensive API for programmatic access:

Endpoints

  • GET /api/v1/builds - Retrieve builds with filters
  • GET /api/v1/stats - Get service statistics
  • GET /api/v1/search - Search for specific builds

Full api docs available in templates/docs.twig, or /docs on your own instance.

Updating

To update to the latest version:

git pull origin main
composer install

Contributing

We welcome contributions! Please follow these steps:

  1. Fork the repository
  2. Create a new branch (git checkout -b feature/your-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin feature/your-feature)
  5. Open a pull request

License

ServerJars is open-source software licensed under the Apache 2.0 License. If you do not understand this license, please view Choose A License's page on it.

Support

If you need help setting up ServerJars, please open an issue.


ServerJars is not affiliated with Minecraft, Microsoft, Mojang, PaperMC, SpigotMC or PurpurMC.