# Spritegen
Easily generate placeholder sprites sheets for your game.
## Installation
Install package using pip
```bash
pip install spritegen
```
## Usage
This script generates a sprite sheet image, which is a single image file containing a grid of smaller images (sprites).
A row in the sprite sheet consist of multiple sprites with the same reference text and an increasing number.
For example a row can be 10 sprites with text "Idle 0", "Idle 1", "Idle 2" etc.
Each row can have different number of sprites and sprite size.
## How to use
To use spritegen, you will need to provide it with some information about the sprites you want it to include. Specifically, for each row you can specify
- The reference text
- The sprite size
- The number of sprites
You can specify multiple rows of sprites by providing this information multiple times.
The script can be executed from the command line, or you can import it as a module use it in your own python code.
### Command line usage
```bash
spritegen --sprite text size number [-o OUTPUT]
```
For example:
```bash
spritegen --sprite Idle 32 5 --sprite Left 32 3 --sprite Right 32 3 --sprite Boss 128 3
```
This will generate a sprite sheet with 4 rows of sprites. The first row will contain 5 sprites with the text "Idle 0", "Idle 1", "Idle 2" etc. The second row will contain 3 sprites with the text "Left 0", "Left 1", "Left 2". The third row will contain 3 sprites with the text "Right 0", "Right 1", "Right 2". The fourth row will contain 3 sprites with the text "Boss 0", "Boss 1", "Boss 2". First three rows will have sprites of size 32x32 and the last row will have sprites of size 128x128.
Raw data
{
"_id": null,
"home_page": "https://github.com/demestav/spritegen",
"name": "spritegen",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Demetris Stavrou",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/59/f2/08e6e9f4baa8ce7b441a637dfc24391a00c89aa195db31ebebfc67154e6a/spritegen-0.1.0.tar.gz",
"platform": null,
"description": "# Spritegen\nEasily generate placeholder sprites sheets for your game.\n\n## Installation\nInstall package using pip\n```bash\npip install spritegen\n```\n\n## Usage\nThis script generates a sprite sheet image, which is a single image file containing a grid of smaller images (sprites).\n\nA row in the sprite sheet consist of multiple sprites with the same reference text and an increasing number.\n\nFor example a row can be 10 sprites with text \"Idle 0\", \"Idle 1\", \"Idle 2\" etc.\n\nEach row can have different number of sprites and sprite size.\n\n## How to use\n\nTo use spritegen, you will need to provide it with some information about the sprites you want it to include. Specifically, for each row you can specify\n\n- The reference text\n- The sprite size\n- The number of sprites\n\nYou can specify multiple rows of sprites by providing this information multiple times.\n\nThe script can be executed from the command line, or you can import it as a module use it in your own python code.\n\n### Command line usage\n\n```bash\nspritegen --sprite text size number [-o OUTPUT]\n```\n\nFor example:\n\n```bash\nspritegen --sprite Idle 32 5 --sprite Left 32 3 --sprite Right 32 3 --sprite Boss 128 3\n```\n\nThis will generate a sprite sheet with 4 rows of sprites. The first row will contain 5 sprites with the text \"Idle 0\", \"Idle 1\", \"Idle 2\" etc. The second row will contain 3 sprites with the text \"Left 0\", \"Left 1\", \"Left 2\". The third row will contain 3 sprites with the text \"Right 0\", \"Right 1\", \"Right 2\". The fourth row will contain 3 sprites with the text \"Boss 0\", \"Boss 1\", \"Boss 2\". First three rows will have sprites of size 32x32 and the last row will have sprites of size 128x128.\n",
"bugtrack_url": null,
"license": "",
"summary": "A tool for generating placeholder spritesheets",
"version": "0.1.0",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ed8af35364fd9dbce7743655ede3fdcf6f8614c4bbbdf7eae6ab09d64a172588",
"md5": "8aab022cd50de7d65945ffa995d6b50d",
"sha256": "985f46d9345c4fe9927a4c32403f0cecfc17603b181e6c3a1d58ca13ba86c9cf"
},
"downloads": -1,
"filename": "spritegen-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8aab022cd50de7d65945ffa995d6b50d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 3581,
"upload_time": "2023-01-02T19:13:22",
"upload_time_iso_8601": "2023-01-02T19:13:22.927687Z",
"url": "https://files.pythonhosted.org/packages/ed/8a/f35364fd9dbce7743655ede3fdcf6f8614c4bbbdf7eae6ab09d64a172588/spritegen-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "59f208e6e9f4baa8ce7b441a637dfc24391a00c89aa195db31ebebfc67154e6a",
"md5": "330d72be900cc008cc8532cbc1f57edc",
"sha256": "1df72231030f18c80511eed481024703d03c57bbbf047a79c48da0783f76b4b3"
},
"downloads": -1,
"filename": "spritegen-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "330d72be900cc008cc8532cbc1f57edc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3133,
"upload_time": "2023-01-02T19:13:24",
"upload_time_iso_8601": "2023-01-02T19:13:24.373107Z",
"url": "https://files.pythonhosted.org/packages/59/f2/08e6e9f4baa8ce7b441a637dfc24391a00c89aa195db31ebebfc67154e6a/spritegen-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-02 19:13:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "demestav",
"github_project": "spritegen",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "spritegen"
}
JSON
