great_asset


Namegreat_asset JSON
Version 1.2.0 PyPI version JSON
download
home_pagehttps://github.com/AbstractUmbra/great_asset
SummaryA small headless library for editing Lethal Company save files.
upload_time2024-01-20 15:03:46
maintainer
docs_urlNone
authorAlex Nørgaard
requires_python>=3.8,<4.0
licenseMIT
keywords save-editor wrapper lethal-company
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <div align="center">
    <h1 align="center">
        <b>GreatAsset</b>
        <br>
    </h1>
    <a href='https://github.com/AbstractUmbra/great_asset/actions/workflows/build.yaml'>
        <img src='https://github.com/AbstractUmbra/great_asset/actions/workflows/build.yaml/badge.svg' alt='Build status'/>
    </a>
    <a href='https://github.com/AbstractUmbra/great_asset/workflows/coverage_and_lint.yaml'>
        <img src='https://github.com/AbstractUmbra/great_asset/actions/workflows/coverage_and_lint.yaml/badge.svg' alt='Linting and Typechecking'/>
    </a>
</div>
<div align="center">
    <a href='https://great-asset.readthedocs.io/en/latest/?badge=latest'>
        <img src='https://readthedocs.org/projects/great_asset/badge/?version=latest' alt='Documentation Status'/>
    </a>
    <a href="https://discord.gg/aYGYJxwqe5">
        <img src='https://img.shields.io/discord/705500489248145459?color=blue&label=Discord&logo=Discord%20Server&logoColor=green' alt='Discord Server'>
    </a>
</div>
<br>

Welcome, great assets to The Company!

---

This project is a small thin wrapper to edit save files for the [Lethal Company](https://store.steampowered.com/app/1966720/Lethal_Company/) video game.

Our documentation can be found [here](https://great-asset.readthedocs.io/en/latest/index.html).

## Example usage

Add 6000 credits and unlock all possible (found) ship upgrades.

```py
import os

import great_asset

def main() -> None:
    # The classmethod here will resolve the full path to the save file and use save number `1`
    with great_asset.SaveFile.resolve_from_file(1) as save:
        # update credits to 6000
        save.update_credits(6000)

        # unlock all items within `great_asset.ShipUnlock` enum.
        save.unlock_all_ship_upgrades()

        # normally without the context manager you'd call the `save.write()` method but this is not necessary
        # as it is called upon exiting the context manager if there are no errors
```


## Disclaimer

This project is not affiliated with Lethal Company, [its creator](https://store.steampowered.com/search/?developer=Zeekerss&snr=1_5_9__2000) or affiliates in any way.
Use of this project within public games without players consent is likely going to remove a lot of the fun from the game and is discouraged.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/AbstractUmbra/great_asset",
    "name": "great_asset",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8,<4.0",
    "maintainer_email": "",
    "keywords": "save-editor,wrapper,lethal-company",
    "author": "Alex N\u00f8rgaard",
    "author_email": "umbra@abstractumbra.dev",
    "download_url": "https://files.pythonhosted.org/packages/54/52/1f1821cac1bc7f96669e0a4fffa9debba1609ddd2e3398d604718e227e65/great_asset-1.2.0.tar.gz",
    "platform": null,
    "description": "<div align=\"center\">\n    <h1 align=\"center\">\n        <b>GreatAsset</b>\n        <br>\n    </h1>\n    <a href='https://github.com/AbstractUmbra/great_asset/actions/workflows/build.yaml'>\n        <img src='https://github.com/AbstractUmbra/great_asset/actions/workflows/build.yaml/badge.svg' alt='Build status'/>\n    </a>\n    <a href='https://github.com/AbstractUmbra/great_asset/workflows/coverage_and_lint.yaml'>\n        <img src='https://github.com/AbstractUmbra/great_asset/actions/workflows/coverage_and_lint.yaml/badge.svg' alt='Linting and Typechecking'/>\n    </a>\n</div>\n<div align=\"center\">\n    <a href='https://great-asset.readthedocs.io/en/latest/?badge=latest'>\n        <img src='https://readthedocs.org/projects/great_asset/badge/?version=latest' alt='Documentation Status'/>\n    </a>\n    <a href=\"https://discord.gg/aYGYJxwqe5\">\n        <img src='https://img.shields.io/discord/705500489248145459?color=blue&label=Discord&logo=Discord%20Server&logoColor=green' alt='Discord Server'>\n    </a>\n</div>\n<br>\n\nWelcome, great assets to The Company!\n\n---\n\nThis project is a small thin wrapper to edit save files for the [Lethal Company](https://store.steampowered.com/app/1966720/Lethal_Company/) video game.\n\nOur documentation can be found [here](https://great-asset.readthedocs.io/en/latest/index.html).\n\n## Example usage\n\nAdd 6000 credits and unlock all possible (found) ship upgrades.\n\n```py\nimport os\n\nimport great_asset\n\ndef main() -> None:\n    # The classmethod here will resolve the full path to the save file and use save number `1`\n    with great_asset.SaveFile.resolve_from_file(1) as save:\n        # update credits to 6000\n        save.update_credits(6000)\n\n        # unlock all items within `great_asset.ShipUnlock` enum.\n        save.unlock_all_ship_upgrades()\n\n        # normally without the context manager you'd call the `save.write()` method but this is not necessary\n        # as it is called upon exiting the context manager if there are no errors\n```\n\n\n## Disclaimer\n\nThis project is not affiliated with Lethal Company, [its creator](https://store.steampowered.com/search/?developer=Zeekerss&snr=1_5_9__2000) or affiliates in any way.\nUse of this project within public games without players consent is likely going to remove a lot of the fun from the game and is discouraged.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A small headless library for editing Lethal Company save files.",
    "version": "1.2.0",
    "project_urls": {
        "Discord": "https://discord.gg/aYGYJxwqe5",
        "Homepage": "https://github.com/AbstractUmbra/great_asset",
        "Issue Tracker": "https://github.com/AbstractUmbra/GreatAsset/issues",
        "Repository": "https://github.com/AbstractUmbra/great_asset"
    },
    "split_keywords": [
        "save-editor",
        "wrapper",
        "lethal-company"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0479138209384cb65d2775c1f5ef9de0f0d518425d3cc8153720a648173a7a2d",
                "md5": "bc3114f22d96df2f7636fbf52f937975",
                "sha256": "f909fe3c5e28aa812c6e1606178b7edc7d74d09b53b89f22cdb4e0adcb89e8ff"
            },
            "downloads": -1,
            "filename": "great_asset-1.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "bc3114f22d96df2f7636fbf52f937975",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8,<4.0",
            "size": 26251,
            "upload_time": "2024-01-20T15:03:43",
            "upload_time_iso_8601": "2024-01-20T15:03:43.058562Z",
            "url": "https://files.pythonhosted.org/packages/04/79/138209384cb65d2775c1f5ef9de0f0d518425d3cc8153720a648173a7a2d/great_asset-1.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "54521f1821cac1bc7f96669e0a4fffa9debba1609ddd2e3398d604718e227e65",
                "md5": "6f635c5aa6d7a1434c9969abd4d9000d",
                "sha256": "f35db4883ffa792862655a8a04d73de097dfbe8b026870dc748ceb7979bc3da8"
            },
            "downloads": -1,
            "filename": "great_asset-1.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "6f635c5aa6d7a1434c9969abd4d9000d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8,<4.0",
            "size": 16506,
            "upload_time": "2024-01-20T15:03:46",
            "upload_time_iso_8601": "2024-01-20T15:03:46.058534Z",
            "url": "https://files.pythonhosted.org/packages/54/52/1f1821cac1bc7f96669e0a4fffa9debba1609ddd2e3398d604718e227e65/great_asset-1.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-20 15:03:46",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "AbstractUmbra",
    "github_project": "great_asset",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "great_asset"
}
        
Elapsed time: 0.17142s