https://github.com/yousuf-shahzad/nex
Nex is a powerful command-line tool for managing Minecraft servers. It simplifies the process of downloading, configuring, and running Minecraft servers on Windows, macOS, and Linux.
https://github.com/yousuf-shahzad/nex
minecraft minecraft-server-management minecraft-server-software paper papermc
Last synced: about 1 month ago
JSON representation
Nex is a powerful command-line tool for managing Minecraft servers. It simplifies the process of downloading, configuring, and running Minecraft servers on Windows, macOS, and Linux.
- Host: GitHub
- URL: https://github.com/yousuf-shahzad/nex
- Owner: yousuf-shahzad
- License: mit
- Created: 2025-04-06T22:59:50.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2025-04-09T14:35:33.000Z (about 1 month ago)
- Last Synced: 2025-04-09T15:35:36.192Z (about 1 month ago)
- Topics: minecraft, minecraft-server-management, minecraft-server-software, paper, papermc
- Language: Python
- Homepage:
- Size: 39.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nex - Minecraft Server Management Tool
Nex is a powerful command-line tool for managing Minecraft servers. It simplifies the process of downloading, configuring, and running Minecraft servers on Windows, macOS, and Linux.
## Features
- Download server JARs for any Minecraft version (Vanilla, Paper, or Purpur)
- Automatically set up server configuration files
- Customize server properties via command-line flags or interactive prompts
- List available versions for any server type
- Run servers with configurable memory settings
- Cross-platform support (Windows, macOS, and Linux)
- Comprehensive plugin management system
## Installation
### Prerequisites
- Python 3.9 or higher
- Java 17 or higher (for running Minecraft servers)
### Installation Methods
#### From Source
```bash
git clone https://github.com/yousuf-shahzad/nex.git
cd nex
pip install -e .
```
## Project Structure
```
nex/
├── cli/ # Command-line interface implementation
├── core/ # Core functionality
├── plugins/ # Plugin management system
├── utils/ # Utility functions
├── config/ # Configuration handling
└── downloaders/ # Server download implementations
```
## Usage
### Server Management
#### Download a Server
```bash
# Download the latest vanilla server
nex download latest vanilla
# Download a specific Paper server version
nex download 1.20.1 paper
# Download Purpur server
nex download 1.19.4 purpur
```
#### List Available Versions
```bash
# List available vanilla versions
nex list-versions vanilla
# List available Paper versions
nex list-versions paper
```
#### Server Setup
```bash
# Set up with default settings
nex setup --dir my_server --version 1.20.1 --type paper
# Set up with custom properties
nex setup --dir my_server --version 1.20.1 --type paper \
--difficulty hard \
--gamemode creative \
--max-players 10 \
--motd "My Awesome Server" \
--no-pvp
# Interactive setup
nex setup --interactive
```
#### Run a Server
```bash
# Run with default settings (2GB RAM)
nex run
# Allocate 4GB RAM
nex run --ram 4G
# Run server without GUI
nex run --nogui
```
### Plugin Management
Nex provides a comprehensive plugin management system with support for multiple sources and automatic dependency handling.
#### Supported Plugin Sources
- SpigotMC
- Modrinth
#### Plugin Commands
```bash
# Search for plugins
nex plugins search [--source SOURCE] [--category CATEGORY]
# Install a plugin
nex plugins install [--version VERSION]
# List installed plugins
nex plugins list
# Enable/disable plugins
nex plugins enable
nex plugins disable
# Delete a plugin
nex plugins delete
# Update a plugin
nex plugins update
# Pin plugin version
nex plugins pin
nex plugins unpin
# Check dependencies
nex plugins check-deps
# Configure plugin
nex plugins configure = [= ...]
```
## Examples
### Complete Server Setup
```bash
# Create a new directory for the server
mkdir my_minecraft_server
cd my_minecraft_server
# Download and set up a Paper server
nex download 1.20.1 paper
nex setup --motd "Welcome to my server!" --max-players 20 --difficulty normal
# Run the server
nex run --ram 4G
```
### Quick Setup with One Command
```bash
# Set up and configure in one command
nex setup --dir my_server \
--version 1.20.1 \
--type paper \
--difficulty hard \
--motd "My Awesome Server" \
--max-players 10
```
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
MIT