{"id":19978170,"url":"https://github.com/greenstack/tablecloth-mc","last_synced_at":"2025-11-25T14:04:06.962Z","repository":{"id":74392514,"uuid":"583805498","full_name":"greenstack/tablecloth-mc","owner":"greenstack","description":"A single Python script that helps you manage your Minecraft Fabric mods from the CLI.","archived":false,"fork":false,"pushed_at":"2023-06-10T03:11:25.000Z","size":103,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-12T10:13:07.073Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/greenstack.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-12-31T01:31:18.000Z","updated_at":"2023-09-13T11:48:00.000Z","dependencies_parsed_at":null,"dependency_job_id":"80bd52ee-0edc-47dc-b891-05ee0f8e3e63","html_url":"https://github.com/greenstack/tablecloth-mc","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greenstack%2Ftablecloth-mc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greenstack%2Ftablecloth-mc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greenstack%2Ftablecloth-mc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greenstack%2Ftablecloth-mc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/greenstack","download_url":"https://codeload.github.com/greenstack/tablecloth-mc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241411543,"owners_count":19958753,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T03:31:22.729Z","updated_at":"2025-11-25T14:04:01.941Z","avatar_url":"https://github.com/greenstack.png","language":"Python","readme":"# Tablecloth MC\nTablecloth MC (or more simply, just \"Tablecloth\") is a single Python file\ndesigned to help you manage your [Fabric](https://fabricmc.net)-modded\n[Minecraft](https://www.minecraft.net/) server from the CLI.\n\nTablecloth is still in **early alpha**.\n\n# Installation\nI recommend that you download the raw `tablecloth.py` file and place it in the\ndirectory you'll be running your Minecraft server in. Alternatively, you could\ncreate a symlink in that directory that points to where you've cloned this repo. \nEither way, the repository comes with a `.gitignore` that will ignore all your \nMinecraft-specific folders, so it is - in theory - safe to store this repo and\nyour Minecraft instance in the same folder. I still strongly discourage this,\nhowever.\n\nAfter you run Tablecloth for the first time, it will create a file called\n`tablecloth.json`. This is the configuration file that Tablecloth uses. You can\nedit it yourself or you can use Tablecloth to manage it as well.\n\n# Requirements\nRequires Python 3.\n\n# Usage\nIf in Linux, you can just run Tablecloth as follows: `./tablecloth.py`. Note that\nat present, Tablecloth only supports downloading mods from [Modrinth](https://modrinth.com/). Support for CurseForge isn't planned because it doesn't currently provide API access without an API key, which can be hard to keep secret in this kind of project.\n\n# Quick-Start Guide\nTo install a mod, download required files, and launch the server, do the following:\n\n```\n./tablecloth.py init\n./tablecloth.py mod add lithium mc1.20-0.11.2\n./tablecloth.py serve-up\n./tablecloth.py launch\n```\n\n# Settings\nAt present, these settings can only be modified manually (except current-profile). Items with \\* haven't been implemented yet.\n\n - **Assume Current Profile**: Sets whether Tablecloth should assume that the currently set profile is the profile to execute on. If false, then each command must identify which profile it's using.\n - **Current Profile**: The name of the current profile.\n - **Launch**: Parameters for launching the server using Tablecloth. Note that what you put here will be passed into the JVM, so be **VERY CAREFUL** with what you put here.\n   - **Jar Name**: The name of the Jar to launch. If null, uses the default jar.\n\t - **Java Path**\\*: The path to the Java executable. If null, uses the system value for Java.\n\t - **Java Args**: An array of args to pass to Java.\n   - **Min RAM**: The minimum amount of RAM the JVM should use. Defaults to 1G.\n   - **Max RAM**: The maximum amount of RAM the JVM should use. Defaults to 2G.\n - **Validation**\\*: Settings to validate the integrity of downloaded files.\n   - **Hashes**\\*: Ensures that the hashes match those reported by Modrinth.\n\t - **Size**\\*: Ensures that the file size matches that reported by Modrinth.\n\n# Actions\nNotes:\n - All parameters without `--` are required for the action.\n - Any action marked with `*` is a planned feature.\n - If `--profile` isn't provided and `assume-current-profile` is `true`, then the operations will be performed on the `current-profile`. The exception to this is the `profile` actions. If `assume-current-profile` is false, the user must use either `--current-profile` or pass in a specific profile name.\n\n## `cleanup`\nChecks for mods that have been removed and deletes them (eventually). For now,\nthis will only work with the `--spotless` flag.\n\n**Parameters**\n - Optional:\n   - `--spotless`: Deletes the mods and the server jar, not just removed mods. Passing `--yes` or `-y` will skip the prompt.\n\n**Parameters**  \nNone for now.\n\n## `init`\nCreates `tablecloth.json` with default configuration. If configuration doesn't exist, then the other commands may create it and run just fine. This command won't do anything if `tablecloth.json` doesn't exist.\n\n## `launch`\nStarts the Minecraft Server. This will always use the default profile.\n\n## `mod`\nProvides actions for working with mods in a profile.\n\nIf the mod name is provided as the only argument, this action will give all relevant data.\n\n### `mod add`\nAdds the mod to the profile (but doesn't add the jar file yet).\n\n**Parameters**\n - Required:\n   - Mod Name: The name of the mod to look for.\n   - Mod Version: The version of the mod to use.\n\n### `mod list`\nPrints all mods that are a part of the profile.\n\n**Parameters**  \nNone.\n\n### `mod remove`\nRemoves the specified mod from the profile (but doesn't remove the mod jar itself).\n\n**Parameters**\n - Required:\n   - Mod Name: The name of the mod to remove.\n\n### `mod search`\nReports all profiles that have the mod.\n\n**Parameters**\n - Required:\n   - Mod Name: The name of the mod to look for.\n\n### `mod set-version`\nSets the mod's version.\n\n**Parameters**\n - Required:\n   - Mod Name: The name of the mod to set the version for.\n   - Mod Version: The version of the mod to use.\n\n## `profile`\nManages profiles stored by tablecloth. None of these commands will assume a default profile, regardless of settings.\n\n### `profile add`\nAdds a new profile, taking the user through a wizard to put in the required parameters.\n\n### `profile copy`\nCreates a new profile based on an existing profile.\n\n**Parameters**  \n - Positional:\n    - `source-profile`: The name of the profile to copy.\n\t\t- `destination-profile`: The name of the new profile.\n\n### `profile list`\nLists all profiles.\n\n### `profile override`\nAllows you to set a launch override for the profile.\n\n**Parameters**\n - Optional:\n   - `--jar`: Sets the name of the server .jar that launch will run.\n   - `--java-path`: Sets the path to the Java Runtime Executable (JRE).\n   - `--java-args`: A list of args to pass to the JRE (comma seperated).\n\n### `profile remove`\nRemoves a profile.\n\n**Parameters**  \n - Positional:\n   - `profile-name`: The name of the profile to delete.\n\n### `profile rename`\nRenames a profile. If the profile is the `current-profile`, that setting will be updated.\n\n**Parameters**  \n - Positional:\n   - `old-profile-name`: The name of the profile to rename.\n   - `new-profile-name`: The new name of the profile.\n\n## `serve-up`\nDownloads the registered mods and updates Minecraft and Fabric. Note that at present, this will configure everything to match only the current-profile. If the current profile is changed, `serve-up` must be run again.\n\n## `set-version`\nAllows you to set the versions for Minecraft, Fabric Loader, and Fabric Installer.\n\n**Parameters**\n - Positional:\n   - `--minecraft`, `-m`: The game version to use.\n   - `--fabric-loader`, `-l`: The Fabric Loader version to use.\n   - `--fabric-installer`, `-i`: The Fabric Installer version to use.\n\n## `config`\\*\nManages various config options. With no arguments, `config` will report the default settings.\n\n# Roadmap\n## Basic Functionality\nThese features are needed to say that Tablecloth is in the beta stage.\n - Download mod dependencies\n - `tablecloth.lock.json`: A file that changes are committed to so users have a fallback if server configuration goes haywire.\n\n## Future Features\n - Figure out how to get most current version of Minecraft for default config\n - Figure out how to get most current version of Fabric jars for default config\n - Figure out how to automatically get mod version that matches current profile's Minecraft version\n - Report when a newer version of Minecraft is available that matches the minor version of the profile\n\t - i.e. if 1.19.3 is installed, would report that 1.19.4 is available\n\t - Should check if mods for profile are reported as compatible with current version\n - Report when a newer version of a mod is available that's compatible with the profile's set Minecraft version\n   - `tablecloth update-check` would perform this check.\n\n# License\nTablecloth MC is published under the MIT License.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreenstack%2Ftablecloth-mc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgreenstack%2Ftablecloth-mc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreenstack%2Ftablecloth-mc/lists"}