Skip to content

Home

Jump to bottom
Muhammad Rohan Ghalib edited this page Nov 18, 2024 · 1 revision

MinecraftServer Wiki

Welcome to the MinecraftServer Wiki! This resource provides all the details you need to set up, manage, and customize your Minecraft server hosted for free on GitHub Codespaces.

1. Getting Started

Overview

This repository allows you to host a Minecraft server with:

  • 4 CPU Cores
  • 16GB RAM
  • 32GB Storage

No external hosting services are required. GitHub Codespaces provides everything needed to get your server online.

Prerequisites

  • A GitHub account with access to GitHub Codespaces.
  • Basic familiarity with GitHub repositories.

2. Setting Up Your Server

Step 1: Fork the Repository

Fork this repository to your GitHub account by clicking the "Fork" button in the top-right corner of the page.

Step 2: Create a Codespace

  • Navigate to your forked repository.
  • Click the green "Code" button and select "Create Codespace on Main."
  • Wait for the Codespace environment to initialize.

Step 3: Start the Server

Open the terminal inside the Codespace and run the provided script to start the server. The terminal will display your server’s IP address once it’s live.

Step 4: Connect to Your Server

Launch Minecraft, add the displayed IP as a new server, and start playing!

3. Server Management

Starting and Stopping

  • Use the provided scripts in the repository to start or stop the server.

Configuration

  • Customize your server settings in the server.properties file, such as game mode, difficulty, and max player count.

Plugins and Mods

  • Add plugins to the plugins folder or mods to the mods folder. Restart the server to apply changes.

4. Troubleshooting

Server Not Starting

  • Ensure you are running the start script in the Codespace terminal.
  • Verify all required files are present in the repository.

Codespace Stops After Inactivity

  • GitHub Codespaces may pause after inactivity. Restart the Codespace and rerun the start script.

5. FAQs

Is this setup free?

Yes, GitHub Codespaces provides a free tier sufficient for hosting a Minecraft server.

Can I use custom Minecraft versions?

Yes, replace the server .jar file in the repository with your desired version.

How do I update plugins or mods?

Upload the updated files to the plugins or mods folder and restart the server.

6. Contributing

We welcome contributions! Feel free to open issues or submit pull requests to improve the project.

7. License

This project is licensed under the MIT License.

Enjoy hosting your Minecraft server with GitHub Codespaces! 🎮

Let me know if you'd like this formatted differently or with additional sections.

Clone this wiki locally