slime-mc 1.0.0__tar.gz

slime_mc-1.0.0/.gitignore

@@ -0,0 +1,56 @@
+# Byte-compiled / optimized files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Virtual environments
+.venv/
+venv/
+env/
+ENV/
+
+# Packaging and build artifacts
+build/
+dist/
+*.egg-info/
+*.egg
+.eggs/
+wheelhouse/
+
+# Test and tooling caches
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+.coverage.*
+coverage.xml
+htmlcov/
+.tox/
+.nox/
+.hypothesis/
+
+# Slime runtime home (when SLIME_HOME points inside the checkout)
+.slime/
+slime-home/
+
+# Logs and temporary files
+*.log
+tmp/
+.cache/
+
+# IDE and editor files
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# Secrets and local overrides
+.env
+.env.*
+!.env.example
+
+# OS metadata
+.DS_Store
+Thumbs.db
+desktop.ini

slime_mc-1.0.0/CHANGELOG.md

@@ -0,0 +1,69 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 2026-11-02
+
+First public release. This consolidates the 0.1.0 development series, which was
+never published. Slime is distributed as `slime-mc` on PyPI and installs the
+`slime` entry point.
+
+### Added
+
+- Full-screen Textual TUI: server dashboard, creation wizard, live console,
+  Java manager and environment diagnostics.
+- Typer CLI with commands for servers, Java runtimes, diagnostics and
+  configuration.
+- PaperMC Fill API v3 client for Paper, Folia, Velocity and Waterfall,
+  including build channels (`STABLE`, `BETA`, `ALPHA`, `ANY`).
+- Eclipse Adoptium API v3 client and Temurin Java manager: download, SHA-256
+  verification, safe archive extraction and per-server runtime selection.
+- Server provisioning: jar download, generated `server.properties` and
+  `eula.txt`, port, memory and Java version defaults.
+- Foreground server process management with streamed console output, command
+  input, graceful stop and per-server logs.
+- Environment checks (`slime doctor`): Python, OS, disk space, port conflicts,
+  EULA, jar, Java and `server.properties` consistency, with a CI-friendly exit
+  code.
+- TOML configuration (`~/.slime/config.toml`) and `SLIME_HOME` / `--home`
+  overrides.
+- Test suite covering models, properties, config, store, checks, API clients,
+  provisioning, process handling, CLI, archives, downloads and Java management.
+- GitHub Actions CI for Windows and Linux on Python 3.11-3.14, plus a tagged
+  release workflow that builds, publishes to PyPI and creates a GitHub release.
+- Project infrastructure: MIT license, changelog, contribution guide, release
+  checklist, `.gitignore` and `.gitattributes`.
+
+### Changed
+
+- Adapted the Fill API parsers to the 2026 response format while staying
+  tolerant of the older shape.
+- Calendar-based Minecraft versions `26.x+` now default to Java 25.
+- Migrated TUI imports to Textual 2.x (`from textual import work`).
+- API clients now derive their default `User-Agent` from the package version
+  instead of hard-coding it.
+
+### Fixed
+
+- Removed a circular import between TUI screens and `SlimeApp`.
+- `ServerStore.write_pid()` now creates the parent directory, so a PID file can
+  be written before the server directory exists.
+- Replaced `Enum` with `StrEnum`, typed bindings with `ClassVar`, and removed
+  unsafe `try/except/pass` blocks; `ruff check .` and `mypy` are clean.
+
+### Known limitations
+
+- No cross-process `stop`: a server lives as long as the Slime process that
+  started it. Stop it from the TUI, with `Ctrl+C`, or with the `stop` console
+  command.
+- Generated proxies (`velocity.toml`, `waterfall.yml`) must be configured
+  manually.
+- Windows 7 / 8 / 8.1 are not supported by this branch.
+
+[Unreleased]: https://github.com/cizik5064-bit/slime/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/cizik5064-bit/slime/releases/tag/v1.0.0

slime_mc-1.0.0/CONTRIBUTING.md

@@ -0,0 +1,102 @@
+# Contributing to Slime
+
+Thanks for taking the time to help. Slime is a small project, so clear reports
+and focused pull requests are very welcome.
+
+## Before you start
+
+- For bugs, open an issue with the Slime version (`slime --version`), your OS,
+  Python version and the exact command you ran. Include relevant lines from
+  `~/.slime/logs/slime.log`. Never paste tokens, passwords or other secrets.
+- For features, open an issue first so we can agree on the scope before you
+  spend time on code.
+- Report security problems privately to the maintainers instead of opening a
+  public issue.
+
+## Development setup
+
+Requirements: Python 3.11+ and git.
+
+```bash
+git clone https://github.com/cizik5064-bit/slime.git
+cd slime
+python -m venv .venv
+```
+
+Windows:
+
+```powershell
+.venv\Scripts\Activate.ps1
+pip install -e ".[dev]"
+```
+
+Linux/macOS:
+
+```bash
+source .venv/bin/activate
+pip install -e ".[dev]"
+```
+
+Run the app from the checkout with `slime` or `python -m slime`. Use a temporary
+home directory when experimenting so your real servers are not touched:
+
+```powershell
+$env:SLIME_HOME = "$env:TEMP\slime-dev"
+slime doctor
+```
+
+## Checks
+
+Every change must keep these commands green:
+
+```bash
+ruff check .
+mypy
+pytest
+```
+
+`pytest` and the linters run in CI on Windows and Linux for Python 3.11 through
+3.14. Tests must not depend on network access; use `respx` and the fixtures in
+`tests/fixtures` for HTTP clients.
+
+## Code style
+
+- Code, identifiers, UI strings, docstrings and documentation are in English.
+- Keep the existing layout: API clients return dataclasses, provisioning is
+  separate from process management, and the TUI only orchestrates services.
+- Add type hints to public functions. Prefer small, testable modules.
+- Do not add dependencies without discussing it in an issue first.
+- Never accept the Minecraft EULA on the user's behalf.
+- Do not log secrets, tokens or personal data.
+
+## Tests
+
+- Add or update tests for every behaviour change.
+- Put shared fixtures in `tests/conftest.py`, keep network fixtures in
+  `tests/fixtures/`.
+- A bug fix should include a regression test that fails before the fix.
+
+## Commits and pull requests
+
+- Use short imperative commit subjects, for example
+  `fix: create PID parent directory` or `feat: add Java 25 defaults`.
+- Keep pull requests focused; unrelated refactors belong in a separate PR.
+- Describe what changed, why, and how you tested it. Mention the OS and Python
+  version if the change is platform-specific.
+- Update `CHANGELOG.md` under `[Unreleased]` for user-visible changes.
+- Update `README.md` when behaviour, commands or requirements change.
+
+## Versioning
+
+Before `1.0.0`, versions are bumped at the maintainer's discretion. After the
+first public release, every user-visible change bumps the version in
+`pyproject.toml` and `src/slime/__init__.py`, and adds a `CHANGELOG.md` entry:
+
+- patch for bug fixes and small changes;
+- minor for new functionality;
+- major for incompatible changes.
+
+## License
+
+By contributing, you agree that your contribution is licensed under the MIT
+License (see `LICENSE`).

slime_mc-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Slime contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

slime_mc-1.0.0/PKG-INFO

@@ -0,0 +1,423 @@
+Metadata-Version: 2.5
+Name: slime-mc
+Version: 1.0.0
+Summary: A friendly Minecraft server manager for PaperMC servers, with a TUI and a CLI.
+Project-URL: Homepage, https://github.com/cizik5064-bit/slime
+Project-URL: Documentation, https://github.com/cizik5064-bit/slime#readme
+Project-URL: Issues, https://github.com/cizik5064-bit/slime/issues
+Project-URL: Changelog, https://github.com/cizik5064-bit/slime/blob/main/CHANGELOG.md
+Author: Slime contributors
+License: MIT
+License-File: LICENSE
+Keywords: adoptium,cli,java,minecraft,paper,papermc,server,tui,velocity
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Environment :: Win32 (MS Windows)
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows :: Windows 10
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Games/Entertainment
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.11
+Requires-Dist: httpx<1,>=0.27
+Requires-Dist: psutil<8,>=5.9.8
+Requires-Dist: rich<15,>=13.7.1
+Requires-Dist: textual<3,>=0.79
+Requires-Dist: typer<1.0,>=0.12.5
+Provides-Extra: dev
+Requires-Dist: mypy>=1.11; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest>=8.2; extra == 'dev'
+Requires-Dist: respx>=0.21; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Slime
+
+[![CI](https://github.com/cizik5064-bit/slime/actions/workflows/ci.yml/badge.svg)](https://github.com/cizik5064-bit/slime/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/slime-mc.svg)](https://pypi.org/project/slime-mc/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+[![Python 3.11+](https://img.shields.io/badge/python-3.11%2B-blue.svg)](pyproject.toml)
+
+**A friendly Minecraft server manager for humans, not sysadmins.**
+
+Slime is a Python application with a full-screen terminal UI (TUI) and a
+scriptable CLI. It helps beginners create, configure, run and troubleshoot
+Minecraft servers without hunting for jars, Java versions or API URLs.
+
+> **Status: 1.0.0 — first public release.** Core features are implemented and
+> covered by tests, but Slime is still young. Expect rough edges and please
+> report them on the issue tracker.
+
+---
+
+## Why Slime?
+
+Setting up a Minecraft server usually involves five different websites, a Java
+version you did not know you needed, a EULA you have never read, and a port
+that is already in use. Slime turns that into a guided flow:
+
+```text
+slime java install 21
+slime server create survival --project paper --memory 4096 --accept-eula
+slime server run survival
+```
+
+Or just run `slime` and use the TUI.
+
+## Features
+
+- **PaperMC Fill API v3** — download the latest builds of Paper, Folia,
+  Velocity and Waterfall directly from the official API. No scraping, no
+  BuildTools.
+- **Temurin Java manager** — install the exact Eclipse Adoptium JDK a server
+  needs (8, 11, 16, 17, 21, 25), per platform and architecture. Slime downloads
+  the archive, verifies the SHA-256 checksum, extracts it into `~/.slime/java`
+  and records the exact `bin/java` path.
+- **TUI + CLI** — a Textual interface for browsing servers, editing settings,
+  watching the console live and sending commands; a Typer CLI for automation.
+- **Server lifecycle** — create, start, stop, restart, delete and inspect
+  servers. A foreground console streams logs and accepts commands via stdin.
+- **Environment checks** — Python, OS, disk space, available RAM, port
+  conflicts, EULA status, server jar, `server.properties` consistency and Java
+  availability.
+- **Beginner-friendly defaults** — sensible `server.properties`, MOTD, port,
+  memory and Java version detection; clear error messages with actionable hints.
+- **Cross-platform** — Windows 10+ and Linux (macOS works but is not a primary
+  target). Windows 7/8/8.1 will require a separate legacy build; see
+  [Platform support](#platform-support).
+- **Local-first** — everything lives in `~/.slime` by default. No account, no
+  telemetry, no cloud.
+
+## Supported projects
+
+| Project | Kind | API | Java (by default) |
+| --- | --- | --- | --- |
+| Paper | Server | [Fill v3](https://fill.papermc.io/v3) | 21 for 1.20.5+, 17 for 1.17–1.20.4, 8 for ≤1.16.5 |
+| Folia | Server | Fill v3 | same as Paper |
+| Velocity | Proxy | Fill v3 | 17 |
+| Waterfall | Proxy | Fill v3 | 11 |
+
+Slime only uses the official PaperMC Fill API for these four projects. Spigot,
+Forge, NeoForge and Fabric are not supported yet.
+
+Proxies generate their own `velocity.toml` / `waterfall.yml` on first start.
+Slime prepares the directory and jar, then leaves proxy networking config to
+you.
+
+## Requirements
+
+- **Python 3.11+**
+- **Windows 10+** or **Linux** (x86-64 or ARM64)
+- Internet access for the first setup (PaperMC and Adoptium APIs)
+- At least 1 GiB of free disk space; 5 GiB+ recommended
+
+## Installation
+
+Slime requires Python 3.11 or newer.
+
+The recommended way is an isolated installation with
+[pipx](https://pipx.pypa.io/):
+
+```bash
+pipx install slime-mc
+```
+
+Or install it into the current environment with pip:
+
+```bash
+pip install slime-mc
+```
+
+Run it:
+
+```bash
+slime --version
+slime
+```
+
+### From source (development)
+
+```bash
+git clone https://github.com/cizik5064-bit/slime.git
+cd slime
+python -m venv .venv
+```
+
+Windows:
+
+```powershell
+.venv\Scripts\Activate.ps1
+pip install -e ".[dev]"
+```
+
+Linux/macOS:
+
+```bash
+source .venv/bin/activate
+pip install -e ".[dev]"
+```
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for the development workflow.
+
+## Quick start (CLI)
+
+```bash
+# 1. Install the Java version the server needs
+slime java install 21
+
+# 2. Create a Paper server using the latest Minecraft version
+slime server create survival --project paper --memory 4096 --accept-eula
+
+# 3. Start it in the foreground and attach the console
+slime server run survival
+```
+
+Inside the console, type Minecraft commands (`op Notch`, `say hello`, `stop`).
+Press **Ctrl+C** to stop the server gracefully.
+
+Useful follow-ups:
+
+```bash
+slime server list
+slime server info survival --checks
+slime doctor
+slime server versions --project paper
+slime server builds 1.21.4 --project paper
+```
+
+Choosing a version and build explicitly:
+
+```bash
+slime server create creative \
+  --project paper \
+  --version 1.21.4 \
+  --channel STABLE \
+  --memory 6144 \
+  --port 25566 \
+  --accept-eula
+```
+
+## Quick start (TUI)
+
+```bash
+slime
+```
+
+| Key | Action |
+| --- | --- |
+| `n` | New server |
+| `j` | Java manager |
+| `d` | Doctor (environment checks) |
+| `r` | Refresh |
+| `q` | Quit (stops servers started by the TUI) |
+| `Enter` | Open the selected server |
+| `Esc` | Back |
+
+The server screen shows live console output, a command input, and Start / Stop /
+Restart / Delete buttons. Servers started from the TUI keep running while you
+navigate between screens, and are stopped gracefully when you quit Slime.
+
+## Commands
+
+### Global
+
+```text
+slime [--home PATH] [--verbose] [--version]
+slime tui
+slime doctor [--server NAME] [--json]
+```
+
+With no arguments, `slime` opens the TUI when stdout is a terminal.
+
+### Servers
+
+```text
+slime server list [--json]
+slime server create NAME [--project paper|folia|velocity|waterfall]
+                          [--version VERSION] [--build N] [--channel STABLE|BETA|ALPHA|ANY]
+                          [--memory MB] [--port PORT] [--java MAJOR]
+                          [--motd TEXT] [--accept-eula]
+slime server info NAME [--checks] [--json]
+slime server run NAME [--memory MB] [--java PATH] [--no-console]
+slime server eula NAME [--accept/--revoke]
+slime server delete NAME [--yes] [--keep-files]
+slime server path NAME
+slime server versions [--project PROJECT] [--limit N] [--json]
+slime server builds VERSION [--project PROJECT] [--channel CHANNEL] [--limit N] [--json]
+```
+
+### Java
+
+```text
+slime java list [--json]
+slime java releases [--json]
+slime java install MAJOR [--force] [--os OS] [--arch ARCH]
+slime java remove MAJOR [--yes]
+slime java which [MAJOR] [--server NAME]
+```
+
+### Configuration
+
+```text
+slime config show [--json]
+slime config set KEY VALUE
+slime config path
+```
+
+Editable settings: `default_memory_mb`, `default_java_major`, `default_port`,
+`accept_eula_default`.
+
+## How Java selection works
+
+Each server records the Java **major** it needs. Slime resolves it in this
+order:
+
+1. An explicit `java_path` on the server (set with `slime server run --java`).
+2. A Temurin runtime managed by Slime with the same major
+   (`~/.slime/java/temurin-<major>-<os>-<arch>`).
+3. A system Java found on `PATH` or via `JAVA_HOME`, but only if its major
+   matches exactly.
+
+If nothing matches, Slime tells you exactly what to run:
+
+```text
+Error: Java 21 is required by survival (Paper 1.21.4), but it is not installed.
+Hint: Install it with: slime java install 21
+```
+
+Install specific runtimes with:
+
+```bash
+slime java install 17
+slime java install 21
+slime java list
+```
+
+Slime never installs a JDK silently. It also never overwrites `eula=true`
+without explicit confirmation (`--accept-eula` or an interactive prompt).
+
+## Where files live
+
+Default home: `~/.slime` (override with `SLIME_HOME` or `--home`).
+
+```text
+~/.slime/
+  config.toml            # settings
+  servers/
+    <name>/
+      slime.json         # Slime metadata (project, build, Java, port, RAM)
+      server.jar         # downloaded PaperMC jar
+      server.properties  # generated for servers
+      eula.txt           # generated for servers
+      world/             # created by Minecraft on first start
+  java/
+    temurin-21-windows-x64/
+      bin/java.exe
+      slime-java.json
+  cache/                 # temporary downloads
+  logs/
+    slime.log
+    <server>.log         # full console log per server
+```
+
+`server.properties` is only created if it is missing: existing user values are
+preserved. Slime warns when the port in `server.properties` disagrees with the
+port recorded in `slime.json`.
+
+## Environment checks
+
+`slime doctor` (or `d` in the TUI) reports:
+
+- Python version (3.11+)
+- Operating system (Windows 10+, Linux, macOS)
+- Writable Slime home directory
+- Free disk space (error below 1 GiB, warning below 5 GiB)
+- Per server: jar, Java runtime, EULA, port, RAM, `server.properties` port
+- Installed Java runtimes
+
+Exit code `2` means at least one check failed, which makes it usable in CI.
+
+## Platform support
+
+| Platform | Status |
+| --- | --- |
+| Windows 10 / 11 | Primary target |
+| Linux x86-64 | Primary target |
+| Linux ARM64 | Supported by Adoptium; lightly tested |
+| macOS | Should work, not a primary target |
+| Windows 8.1 | Not supported by Python 3.11+ |
+| Windows 7 / 8 | Needs a separate legacy build (Python 3.8, older Textual) |
+
+Windows 7 and 8/8.1 support cannot be added to this codebase: Python 3.9+ and
+modern Textual do not run there. A future `0.x-legacy` build may target Python
+3.8 with pinned dependencies. Until then, Slime prints a clear compatibility
+error on unsupported Windows versions.
+
+## Development
+
+```bash
+python -m venv .venv
+source .venv/bin/activate        # Windows: .venv\Scripts\Activate.ps1
+pip install -e ".[dev]"
+
+ruff check .
+pytest
+```
+
+Project layout:
+
+```text
+src/slime/
+  cli.py            # Typer commands
+  tui/              # Textual app, screens, CSS
+  api/papermc.py    # Fill API v3 client
+  api/adoptium.py   # Adoptium API v3 client
+  java.py           # Temurin install/discovery
+  provision.py      # create-server flow
+  process.py        # server process + console
+  checks.py         # environment checks
+  store.py          # ~/.slime/server registry
+  models.py         # data models and validation
+  properties.py     # server.properties / eula.txt
+tests/              # pytest suite (in progress)
+```
+
+The design favours explicit, testable modules: API clients return dataclasses,
+provisioning is separated from process management, and the TUI only orchestrates
+services.
+
+## Roadmap
+
+- [x] Core architecture, models and validation
+- [x] Fill API v3 client (Paper, Folia, Velocity, Waterfall)
+- [x] Adoptium Temurin client and Java manager
+- [x] CLI (servers, Java, diagnostics, config)
+- [x] Textual TUI (dashboard, server console, create wizard, Java, doctor)
+- [x] Full test suite and CI on Windows + Linux
+- [x] First public release (1.0.0)
+- [x] Packaging on PyPI (`slime-mc`)
+- [ ] Backups and restore
+- [ ] Plugin/mod browser (Modrinth / Hangar)
+- [ ] RCON console and cross-process server control
+- [ ] Legacy Windows 7/8.1 build
+- [ ] Standalone binaries via PyInstaller
+
+## Disclaimer
+
+Slime is an unofficial community project. It is not affiliated with Mojang,
+Microsoft, PaperMC, or Eclipse Adoptium. Minecraft is a trademark of Mojang
+Studios. By creating a server you agree to the
+[Minecraft EULA](https://aka.ms/MinecraftEULA); Slime only records your
+explicit acceptance and never accepts it for you.
+
+## License
+
+MIT — see [LICENSE](LICENSE).