mcserver-cli 3.0.0__tar.gz → 4.0.0__tar.gz

{mcserver_cli-3.0.0 → mcserver_cli-4.0.0}/CHANGELOG.md

@@ -5,13 +5,41 @@ All notable changes to this project will be 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]
+## [4.0.0] - 2026-10-31
 
 ### Added
 
-- Paper and Purpur as server software
+- Working `show` command
+- Working `search` command
+- New `--game-version` and `--loader` options to the `search` command
+- New `--search-sort` and `--search-limit` options to the `init` command
+
+### Changed
+
+- Moved `slug_index.json` to global `.mcserver` cache
+- More information that the `show` command output
+- Better `search` info message
+- slug_index.json is now a global cache
+
+### Fixes
+
+- Typo in the `add` command help
+
+## [3.0.0] - 2026-08-18
+
+### Added
+
+- Command to stop the Minecraft server
+- Paper and Purpur server software
 - Metadata to keep information of what version of MCServer is used
-- State to keep information of a running MCServer to avoid conflict
+- State to keep information of a running MCServer to avoid conflicting command
+- Listing whitelisted players
+- Listing operator players
+
+### Changed
+
+- Uh... add, search, and show, are being worked on (they're not available for now)
+- The codebase is now bigger with small gain (for the user)
 
 ## [2.0.0] - 2026-06-14
 
@@ -187,7 +215,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Better mod conflict error
 - Faster mod resolving
 
-[unreleased]: https://github.com/Othecat35/MCServer/compare/v2.0.0...HEAD
+[unreleased]: https://github.com/Othecat35/MCServer/compare/v4.0.0...HEAD
+[4.0.0]: https://github.com/Othecat35/MCServer/compare/v3.0.0...v4.0.0
+[3.0.0]: https://github.com/Othecat35/MCServer/compare/v2.0.0...v3.0.0
 [2.0.0]: https://github.com/Othecat35/MCServer/compare/v1.13.16...v2.0.0
 [1.13.16]: https://github.com/Othecat35/MCServer/compare/v1.13.15...v1.13.16
 [1.13.15]: https://github.com/Othecat35/MCServer/compare/v1.13.14...v1.13.15

mcserver_cli-4.0.0/CONTRIBUTING.md

@@ -0,0 +1,16 @@
+# License
+
+By submitting a pull request, you agree that your contribution is licensed under the MIT License.
+
+# Development
+
+- Python >= 3.12 (3.14 is recommended)
+- Install with `pip install -e .`
+- Use `ruff format` to reformat code
+
+# Release
+
+1. Bump version in `src/mcserver/__init__.py`
+2. `python zip_app.py`
+3. Tag: `git tag vX.Y.Z && git push --tags`
+4. Create GitHub release, attach `dist/mcserver`

mcserver_cli-4.0.0/LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Othecat35
+
+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.

{mcserver_cli-3.0.0 → mcserver_cli-4.0.0}/NOTES.txt

@@ -119,22 +119,27 @@ mod indexing, don't forget! don't remind me the... 3rd time?
 Gemini suggest adding "status" command and get ram usage info, sure but not now. oh good idea I guess
 
 Things that MCServer can touch (In theory):
+
+XDG Cache
+- mcserver
+  - slug_index.json
+
+
+Home Directory
+- .cache # Failback if XDG Cache is not set
+  - mcserver
+    - slug_index.json
+
+
 Server Root
 - .mcserver/
-  - caches/
-    - modrinth/
-      - versions/
-        - <project_id>.json
   - configs/
     - launcher.json
     - modrinth.json
     - server.json
   - modrinth/
-    - slug_index.json
-    - projects/
-      - <project_id>
-        - metadata.json
-        - relationships.json
+    - projects_records/
+      - <project_id>.json
   - tempfiles/
     - <file_hash>
     - <url_hash> #if file hash does not exist, use hash from digesting the URL
@@ -178,7 +183,9 @@ check_dependency_conflicts: no
 resolve_dependencies: ok... what are dependencies of mod b?
 (some dialogue later)
 resolve_dependencies: ok, there's no more dependency. here you go "return the list of dependencies"
-user: why are there 29 mods including dependencies 0_0
+user: why are there 29 mods including dependencies 0_0 (basucally the resolver works)
+
+on second thought, the caller is the one that handle conflict.
 
 thx chatgpt but I can't prove it yet
 
@@ -194,7 +201,15 @@ thx chatgpt but I can't prove it yet
 - Review codes, especially TypedDict, because why not
 - Avoid making myself suffer in this project, potentially abandoning this cool project
 - I hate CurseForge personally.
+
+
+
 - And yet I still have no friend (to talk about my weird hobby of computer, including this)
+
+- Oh hi Finjer! idk if you are reading this, cool. so uh... idk I added stuff I guess, or remove stuff.
+
+
+
 - Add command such as 'whitelist add/remove/list', 'ban/unban/ban-list', and probably 'op/deop <player> <level>'
 
 MCServer™ Naming Convention: (the Trademark is just a joke)
@@ -239,32 +254,135 @@ I definitely broke my promise. (oops)
 - init command could take some sort of "target dir"
 - make src/mcserver/modrinth/projects.py into a dir, ans inside it we have metadata.py and relationship.py
 - flowchart TD
-    A[Did you fix a bug?]
-    A -- Yes --> B[It's fix]
-    A -- No --> C[Did you change functionality or affect UI?]
+  A[Did you fix a bug?]
+  A -- Yes --> B[It's fix]
+
+  A -- No --> C[Did you change functionality or affect UI?]
+  C -- Yes --> D[It's feat]
 
-    C -- Yes --> D[It's feat]
-    C -- No --> E[Did you add or change tests?]
+  C -- No --> E[Did you add or change tests?]
+  E -- Yes --> F[It's test]
 
-    E -- Yes --> F[It's test]
-    E -- No --> G[Did you change code style or formatting?]
+  E -- No --> G[Did you change code style or formatting?]
+  G -- Yes --> H[It's style]
 
-    G -- Yes --> H[It's style]
-    G -- No --> I[Did you make changes to documentation?]
+  G -- No --> I[Did you make changes to documentation?]
+  I -- Yes --> J[It's docs]
 
-    I -- Yes --> J[It's docs]
-    I -- No --> K[Did you change things related to build or deploy operations?]
+  I -- No --> K[Did you change things related to build or deploy operations?]
+  K -- Yes --> L[It's build]
 
-    K -- Yes --> L[It's build]
-    K -- No --> M[Did you change something related to devops, infrastructure or backups?]
+  K -- No --> M[Did you change something related to devops, infrastructure or backups?]
+  M -- Yes --> N[It's ops]
 
-    M -- Yes --> N[It's ops]
-    M -- No --> O[Did you complete a maintenance task or other non-code task?]
+  M -- No --> O[Did you complete a maintenance task or other non-code task?]
+  O -- Yes --> P[It's chore]
 
-    O -- Yes --> P[It's chore]
-    O -- No --> Q[Did you rewrite or restructure code specifically for performance?]
+  O -- No --> Q[Did you rewrite or restructure code specifically for performance?]
+  Q -- Yes --> R[It's perf]
+
+  Q -- No --> S[It's refactor]
 
-    Q -- Yes --> R[It's perf]
-    Q -- No --> S[It's refactor]
 - commit convention reference: https://gist.github.com/qoomon/5dfcdf8eec66a051ecd85625518cfd13
-- or more "official" looking: https://www.conventionalcommits.org/en/v1.0.0/
+- or more "official" looking: https://www.conventionalcommits.org/en/v1.0.0/
+
+Othecat35's Development Setup (For anyone if wondering):
+- VSCodium
+  - Extensions:
+    Pyright
+    Python
+
+that's all lol
+
+
+so, Modrinth has new way to represent which mod go to which environment right?
+so it make the older 'server_side' and 'client_side' obselete.
+but, most of my code rely on them.
+what if, I make a 'translator' between the new 'environment' and the old '*_side'?
+"How can you do that?" said Othecat35.
+well, just convert one value into two values. like if the environment is 'client_and_server',
+then the server_side is required and server_side is required
+required = you need this mod on this side
+recommended = this mod is recommended to be installed on this side
+optional = you can have this mod in this side, or not
+unsupported = basically this side is a side effect (it works but uh...)
+incompatible = this mod may crash on this side
+unknown = the dev doesn't even know their mod, wth
+the mapping table (as for 2026-09-05, basically the time I wrote this):
+| environment                   | server side   | client side   |
+|-------------------------------|---------------|---------------|
+| client_and_server             | required      | required      |
+| client_only                   | unsupported   | required      |
+| client_only_server_optional   | optional      | required      |
+| singleplayer_only             | incompactible | required      |
+| server_only                   | required      | unsupported   |
+| server_only_client_optional   | required      | optional      |
+| dedicated_server_only         | required      | incompactible |
+| client_or_server              | optional      | optional      |
+| client_or_server_prefers_both | recommended   | recommended   |
+| unknown                       | unknown       | unknown       |
+
+todo: move src/mcserver/server to src/mcserver/minecraft/server
+because it make more sense I think
+
+the export command... ".mcserver" and ".mrpack" format.
+.mrpack is Modrinth Modpack format, I already know that.
+.mcserver? what's this? a custom format? why?
+idk, maybe it can store the actual configs of the server
+the mod relationships, the metadata, etc
+the pros is can contain more metadata of the server.
+okay. but why? idk, maybe it looks cool? yea sure.
+
+warning for those who want to interact with .properties,
+consider bring your own module and don't use my parser.
+why? its not perfect, and, basically don't. I only make it
+to work with Minecraft, properties files like server.properties
+and eula.txt.
+
+4.0.0:
+no add/remove for whitelist yet
+no grant/revoke for op yet
+no update command yet
+and actually, no import command
+
+for the remove command, I would use the resolver I already had. But it would be more complicated once we're dealing with mod that shared dependencies with other. I don't know ;-; I haven't even finished the add commad yet, but it is in incremental so don't rush me >:c
+make a visualize command to visualize installed projects that output to graphviz format seems really cool
+we should merge the metadata.json and relationships.json back into one file :o
+
+look at myterious.py, idk why yiu thought it would be a good idea to make it more fun, and dynamic even.
+mcserver export --client-setup seems nice
+mcserver add thdilos-fox-origin -y is better
+mcserver add jade --include-optional make sense, but for specifically requested mod that is client_only_server_optional, include them. otherwise, put them into "suggested" mods.
+
+yo the get_project_informations() is broken because moderator_message can be null
+as for every API interface/client, we can instead return parsed (for those who we already know the structure), and then another, extra (just a dict[str, Any]). call the new typeddict, *Data.
+
+About lazy loading imports... what if I make it so that imports that are required regardless, just
+import it on the module instead? because if you do import it, you must have a reason to do so. Like,
+you don't import a module and not use it at all, right? so just move the imports outside the function.
+init.py:
+import argparse
+
+def init(args: argparse.Namespace):
+    import logging
+    ...
+
+
+init.py:
+import argparse
+import logging
+
+def init(args: argparse.Namespace):
+    ...
+
+so, if you import init, you of course want to run init() right? so lazy-laoding it is not just useless,
+it also make the code a bit more unreadable.
+When do we lazy-loading stuff? imports that aren't always needed. Like command invocation in cli.py
+with match case, because you don't need any to print the help message (except the help command itself),
+or if you did, like init, you don't neccesearily need to import the stop command right? and also other
+case is in init.py and start.pt. it import the appropriate loader and not other.
+
+hmmm yes, global .mcserver config, just like cache.
+it can be the default config of all your new Minecraft server derived from
+and yea
+

{mcserver_cli-3.0.0 → mcserver_cli-4.0.0}/PKG-INFO

@@ -1,15 +1,14 @@
 Metadata-Version: 2.5
 Name: mcserver-cli
-Version: 3.0.0
+Version: 4.0.0
 Summary: A CLI tool to manage Minecraft: Java Edition servers.
 Project-URL: Homepage, https://github.com/Othecat35/MCServer
 Project-URL: Repository, https://github.com/Othecat35/MCServer.git
 Project-URL: Changelog, https://github.com/Othecat35/MCServer/blob/main/CHANGELOG.md
 Author-email: Othecat35 <othecat35@gmail.com>
-Maintainer-email: Othecat35 <othecat35@gmail.com>
 License-Expression: MIT
 License-File: LICENSE
-Requires-Python: >=3.14
+Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 
 # MCServer
@@ -22,10 +21,13 @@ Supported platforms:
 - and Termux.
 
 ## Requirements
-- Python 3.14 or newer
+- Python 3.12 or newer (Python 3.14 is recommended)
 - JRE (depends on Minecraft version)
 
 ## How to install
+- Using pip:
+1. Run `pip install mcserver-cli`
+
 - System-wide (Requires root): 
 1. Download the `mcserver` script file from GitHub releases
 2. Move the file to `/usr/local/bin`
@@ -40,24 +42,31 @@ Supported platforms:
    - Run `fish_add_path ~/bin` if you're using FISH
 
 ## Usage
-- Add mods (and its dependencies): `mcserver add <mods>`
-- Import a modpack: `mcserver import [file]`
-- Initialize the server: `mcserver init [options]`
-- Manage operator status: `mcserver op`
-- Search mods from Modrinth: `mcserver search [<query>] [options]`
-- Show mod information from Modrinth: `mcserver show <mods>`
+- Initialize a server: `mcserver init [options]`
+- List operator players: `mcserver op list`
+- Show information about projects: `mcserver show <projects>`
 - Start the server: `mcserver start`
-- Stop the server: `mcserver stop`
-- Manage the whitelist: `mcserver whitelist`
+- Stop the server: `mcserver stop [--force-stop]`
+- List whitelisted players: `mcserver whitelist list`
 
 ### Example
+- Create and start a Fabric 1.20.1 server on current directory
 ```bash
-mcserver init --mc-version=1.20.1 --loader=fabric --loader-version=0.19.3
-mcserver search --no-filter thdilos
-mcserver show thdilos-fox-origin thdilos-fox-origin-expanded
-mcserver add thdilos-fox-origin-expanded lithium tick-stasis ferrite-core krypton
+mcserver init --game-version=1.20.1 --loader=fabric
 mcserver start
 ```
 
+- List all operator and whitelisted players on current directory
+```bash
+mcserver op list
+mcserver whitelist list
+```
+
+- Stop (sigterm) a server on current directory
+```bash
+mcserver stop
+```
+
 ## Note
 This is a **Personal Project**, things may be unstable.
+Please do not feed my creation into AI :>

{mcserver_cli-3.0.0 → mcserver_cli-4.0.0}/README.md

@@ -8,10 +8,13 @@ Supported platforms:
 - and Termux.
 
 ## Requirements
-- Python 3.14 or newer
+- Python 3.12 or newer (Python 3.14 is recommended)
 - JRE (depends on Minecraft version)
 
 ## How to install
+- Using pip:
+1. Run `pip install mcserver-cli`
+
 - System-wide (Requires root): 
 1. Download the `mcserver` script file from GitHub releases
 2. Move the file to `/usr/local/bin`
@@ -26,24 +29,31 @@ Supported platforms:
    - Run `fish_add_path ~/bin` if you're using FISH
 
 ## Usage
-- Add mods (and its dependencies): `mcserver add <mods>`
-- Import a modpack: `mcserver import [file]`
-- Initialize the server: `mcserver init [options]`
-- Manage operator status: `mcserver op`
-- Search mods from Modrinth: `mcserver search [<query>] [options]`
-- Show mod information from Modrinth: `mcserver show <mods>`
+- Initialize a server: `mcserver init [options]`
+- List operator players: `mcserver op list`
+- Show information about projects: `mcserver show <projects>`
 - Start the server: `mcserver start`
-- Stop the server: `mcserver stop`
-- Manage the whitelist: `mcserver whitelist`
+- Stop the server: `mcserver stop [--force-stop]`
+- List whitelisted players: `mcserver whitelist list`
 
 ### Example
+- Create and start a Fabric 1.20.1 server on current directory
 ```bash
-mcserver init --mc-version=1.20.1 --loader=fabric --loader-version=0.19.3
-mcserver search --no-filter thdilos
-mcserver show thdilos-fox-origin thdilos-fox-origin-expanded
-mcserver add thdilos-fox-origin-expanded lithium tick-stasis ferrite-core krypton
+mcserver init --game-version=1.20.1 --loader=fabric
 mcserver start
 ```
 
+- List all operator and whitelisted players on current directory
+```bash
+mcserver op list
+mcserver whitelist list
+```
+
+- Stop (sigterm) a server on current directory
+```bash
+mcserver stop
+```
+
 ## Note
 This is a **Personal Project**, things may be unstable.
+Please do not feed my creation into AI :>