| Name | cursely JSON |
| Version |
0.8.0
JSON |
| download |
| home_page | https://github.com/Julynx/cursely |
| Summary | Cross-platform mod management for Minecraft. |
| upload_time | 2024-07-12 09:52:07 |
| maintainer | None |
| docs_url | None |
| author | Julynx |
| requires_python | <4.0,>=3.10 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# cursely
*Cross-platform mod management for Minecraft.*
### `pip install cursely`
<br>
<br>
<h4 align="center">Get search results from CurseForge and Modrinth.</h4>
<p align="center">
<img width="600" src="https://i.imgur.com/SrDRMxY.png">
</p>
<br>
<h4 align="center">View mod details, dependencies and download links.</h4>
<p align="center">
<img width="600" src="https://i.imgur.com/gdgnnyt.png">
</p>
<br>
<h4 align="center">Deploy a modpack with its configuration.</h4>
<p align="center">
<img width="600" src="https://i.imgur.com/mitqY4c.png">
</p>
<br>
## Usage
```
cursely [MOD_ID] Get a brief description of a mod and its download link.
cursely [KEYWORD] Search for a mod by its name or author.
cursely [MODPACK] Install all listed mods and their dependencies.
cursely --help Show this help message.
```
<br>
## Modpacks
A modpack file is a plain text file with the ```.mods``` extension and the following format:
`example_modpack.mods`
```
game minecraft == 1.20.1
loader fabric == 0.15.1
config example_modpack_config.zip
# Mod ID Comments (optional) File version (optional)
mod 325471 Inventory Sorting == 5455951
mod 429084 Limited Spawners
mod 551140 Furnace Recycle
# Download URL Mod (optional)
download https://manual_mod_download_url
download https://manual_mod_download_url for mod 917292
# ...
```
Running ```cursely example_modpack.mods``` will:
1) Download and install the listed mods.
2) Download and install their required dependencies.
3) Copy the config files from the zip archive to the minecraft installation folder.
4) Print any errors that might have occurred.
You can find examples for modpacks in [cursely/modpacks/](https://github.com/Julynx/cursely/tree/main/cursely/modpacks).
<br>
## Resolution files
Resolution files contain all the mods and their dependencies for a modpack, fixed to the
specific versions downloaded by the installer when the build was created.
This enables reproducible builds, providing the option to replicate the exact
same modpack in the future, preventing the incompatibilities that can arise
as mods get updated and their versions change over time.
When installing a modpack:
- If no resolution file exists, a new one will be
created with the same name and the `.resolved-mods` extension.
- If a resolution file exists, the program will try to use it
as long as it has the same name as the requested modpack (except for the
extension).
To build a modpack using the latest compatible version of each mod,
simply delete the resolution file and rerun `cursely your_modpack.mods`.
<br>
## Disclaimer
_Modrinth and CurseForge are registered trademarks owned by their respective owners. Any references to these brands within this repository are for descriptive purposes only and do not imply endorsement or affiliation with said trademarks._
Raw data
{
"_id": null,
"home_page": "https://github.com/Julynx/cursely",
"name": "cursely",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Julynx",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/8e/03/e4c19d98ecf3c11903ed374a9e6e89282458bea5e927080b77528f256e4a/cursely-0.8.0.tar.gz",
"platform": null,
"description": "# cursely\n\n*Cross-platform mod management for Minecraft.*\n\n### `pip install cursely`\n\n<br>\n<br>\n\n<h4 align=\"center\">Get search results from CurseForge and Modrinth.</h4>\n<p align=\"center\">\n <img width=\"600\" src=\"https://i.imgur.com/SrDRMxY.png\">\n</p>\n<br>\n\n<h4 align=\"center\">View mod details, dependencies and download links.</h4>\n<p align=\"center\">\n <img width=\"600\" src=\"https://i.imgur.com/gdgnnyt.png\">\n</p>\n<br>\n\n<h4 align=\"center\">Deploy a modpack with its configuration.</h4>\n<p align=\"center\">\n <img width=\"600\" src=\"https://i.imgur.com/mitqY4c.png\">\n</p>\n<br>\n\n## Usage\n\n```\ncursely [MOD_ID] Get a brief description of a mod and its download link.\ncursely [KEYWORD] Search for a mod by its name or author.\ncursely [MODPACK] Install all listed mods and their dependencies.\ncursely --help Show this help message.\n```\n\n<br>\n\n## Modpacks\n\nA modpack file is a plain text file with the ```.mods``` extension and the following format:\n\n`example_modpack.mods`\n\n```\ngame minecraft == 1.20.1\nloader fabric == 0.15.1\nconfig example_modpack_config.zip\n\n# Mod ID Comments (optional) File version (optional)\nmod 325471 Inventory Sorting == 5455951\nmod 429084 Limited Spawners\nmod 551140 Furnace Recycle\n\n# Download URL Mod (optional)\ndownload https://manual_mod_download_url\ndownload https://manual_mod_download_url for mod 917292\n\n# ...\n```\n\nRunning ```cursely example_modpack.mods``` will:\n1) Download and install the listed mods.\n2) Download and install their required dependencies.\n3) Copy the config files from the zip archive to the minecraft installation folder.\n4) Print any errors that might have occurred.\n\nYou can find examples for modpacks in [cursely/modpacks/](https://github.com/Julynx/cursely/tree/main/cursely/modpacks).\n\n<br>\n\n## Resolution files\n\nResolution files contain all the mods and their dependencies for a modpack, fixed to the\nspecific versions downloaded by the installer when the build was created.\nThis enables reproducible builds, providing the option to replicate the exact\nsame modpack in the future, preventing the incompatibilities that can arise\nas mods get updated and their versions change over time.\n\nWhen installing a modpack:\n\n- If no resolution file exists, a new one will be\ncreated with the same name and the `.resolved-mods` extension.\n\n- If a resolution file exists, the program will try to use it\nas long as it has the same name as the requested modpack (except for the\nextension).\n\nTo build a modpack using the latest compatible version of each mod,\nsimply delete the resolution file and rerun `cursely your_modpack.mods`.\n\n<br>\n\n## Disclaimer\n\n_Modrinth and CurseForge are registered trademarks owned by their respective owners. Any references to these brands within this repository are for descriptive purposes only and do not imply endorsement or affiliation with said trademarks._\n",
"bugtrack_url": null,
"license": null,
"summary": "Cross-platform mod management for Minecraft.",
"version": "0.8.0",
"project_urls": {
"Homepage": "https://github.com/Julynx/cursely"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "99dc11adc604812fa3526eb7831b5c4e9408242262e24fa75c55f2f9ce3dcffd",
"md5": "d7895bc3bb1ff79a5d7252a65fd0e053",
"sha256": "1f92826b697a43bc73b9a344d0cdc99803a40708170f97eceb515504503b85b2"
},
"downloads": -1,
"filename": "cursely-0.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d7895bc3bb1ff79a5d7252a65fd0e053",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 67476900,
"upload_time": "2024-07-12T09:51:54",
"upload_time_iso_8601": "2024-07-12T09:51:54.606696Z",
"url": "https://files.pythonhosted.org/packages/99/dc/11adc604812fa3526eb7831b5c4e9408242262e24fa75c55f2f9ce3dcffd/cursely-0.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8e03e4c19d98ecf3c11903ed374a9e6e89282458bea5e927080b77528f256e4a",
"md5": "b09b78860355c977779b2b450aead73f",
"sha256": "66895e805db439fe8a0e8dfb35d89caaf83863e8043caf1c9e12166c6f743a6c"
},
"downloads": -1,
"filename": "cursely-0.8.0.tar.gz",
"has_sig": false,
"md5_digest": "b09b78860355c977779b2b450aead73f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 67465061,
"upload_time": "2024-07-12T09:52:07",
"upload_time_iso_8601": "2024-07-12T09:52:07.664444Z",
"url": "https://files.pythonhosted.org/packages/8e/03/e4c19d98ecf3c11903ed374a9e6e89282458bea5e927080b77528f256e4a/cursely-0.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-12 09:52:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Julynx",
"github_project": "cursely",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "cursely"
}
