| Name | pgaddons JSON |
| Version |
1.2
JSON |
| download |
| home_page | None |
| Summary | A collection of additions to pygame. |
| upload_time | 2024-12-16 20:55:16 |
| maintainer | None |
| docs_url | None |
| author | iamdeedz |
| requires_python | >=3 |
| license | MIT License |
| keywords |
gui
pygame
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pygame-addons
Contains classes and functions to help make games and guis with pygame
# Notes
I don't know what version of python is needed for this package to work.
Anywhere in the documentation where it says `pg`, it is referring to `pygame`.
This is mainly just a passion project/project to help future projects, but it would be nice if it had some use.
# Features
Here's a list of features that are currently available in this package:
## Classes
Examples of how to use these classes can be found in the examples folder.
### Button
A class that creates a button that can be clicked on.
Parameters:
- pos - The position of the button
- size - The size of the button
- colour - The colour of the button
- text - The text that will be displayed on the button - Default: ""
- text_colour - The colour of the text - Format: str, tuple[int, int, int] or pg.Color - Default: pg.Color("white")
- font - The font of the text - Format: str, pg.font.Font or pg.font.SysFont - Default: "freesansbold"
- font_size - The size of the font - Default: 30
### Input Field
A class that creates an input field that can be typed in.
Parameters:
- pos - The position of the input field
- size - The size of the input field
- colour - The colour of the input field
- active_colour - The colour of the input field when it is active
- background_text - The text that will be displayed when the input field is empty - Format: str or list - Default: ""
- font_colour - The colour of the text - Format: str, tuple[int, int, int] or pg.Color - Default: pg.Color("white")
- font - The font of the text - Format: str, pg.font.Font or pg.font.SysFont - Default: "freesansbold"
- font_size - The size of the font - Default: 30
- max_length - The maximum length of the text in the input field - Default: 10
### Slider
A class that creates a slider that can be used to go through numbers.
Parameters:
- pos - The position of the slider
- size - The size of the slider
- colour - The colour of the slider
pos, size, colour: tuple[int, int, int] | pg.Color, border_colour: tuple[int, int, int] | pg.Color, min_value: int, max_value: int, start_value: int, border_size: int = 3, background_text: str = "", font: str | type[pg.font.Font] | type[pg.font.SysFont] = "freesansbold", font_size=25, font_colour: str | tuple[int, int, int] | pg.Color = pg.Color("white"))
Raw data
{
"_id": null,
"home_page": null,
"name": "pgaddons",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": null,
"keywords": "gui, pygame",
"author": "iamdeedz",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/b7/31/56a9a60793cb0ce2fe7333c233930d04143e3dda2b3be41bff59f40fa0a0/pgaddons-1.2.tar.gz",
"platform": null,
"description": "# pygame-addons\nContains classes and functions to help make games and guis with pygame\n\n# Notes\nI don't know what version of python is needed for this package to work.\n\nAnywhere in the documentation where it says `pg`, it is referring to `pygame`.\n\nThis is mainly just a passion project/project to help future projects, but it would be nice if it had some use.\n\n# Features\n\nHere's a list of features that are currently available in this package:\n\n## Classes\n\nExamples of how to use these classes can be found in the examples folder.\n\n### Button\nA class that creates a button that can be clicked on.\n\nParameters:\n- pos - The position of the button\n- size - The size of the button\n- colour - The colour of the button\n- text - The text that will be displayed on the button - Default: \"\"\n- text_colour - The colour of the text - Format: str, tuple[int, int, int] or pg.Color - Default: pg.Color(\"white\")\n- font - The font of the text - Format: str, pg.font.Font or pg.font.SysFont - Default: \"freesansbold\"\n- font_size - The size of the font - Default: 30\n\n\n### Input Field\nA class that creates an input field that can be typed in.\n\nParameters:\n- pos - The position of the input field\n- size - The size of the input field\n- colour - The colour of the input field\n- active_colour - The colour of the input field when it is active\n- background_text - The text that will be displayed when the input field is empty - Format: str or list - Default: \"\"\n- font_colour - The colour of the text - Format: str, tuple[int, int, int] or pg.Color - Default: pg.Color(\"white\")\n- font - The font of the text - Format: str, pg.font.Font or pg.font.SysFont - Default: \"freesansbold\"\n- font_size - The size of the font - Default: 30\n- max_length - The maximum length of the text in the input field - Default: 10\n\n\n### Slider\nA class that creates a slider that can be used to go through numbers.\n\nParameters:\n- pos - The position of the slider\n- size - The size of the slider\n- colour - The colour of the slider\n\npos, size, colour: tuple[int, int, int] | pg.Color, border_colour: tuple[int, int, int] | pg.Color, min_value: int, max_value: int, start_value: int, border_size: int = 3, background_text: str = \"\", font: str | type[pg.font.Font] | type[pg.font.SysFont] = \"freesansbold\", font_size=25, font_colour: str | tuple[int, int, int] | pg.Color = pg.Color(\"white\"))\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "A collection of additions to pygame.",
"version": "1.2",
"project_urls": {
"Homepage": "https://github.com/iamdeedz/pygame-addons",
"Issues": "https://github.com/iamdeedz/pygame-addons/issues"
},
"split_keywords": [
"gui",
" pygame"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "639b9a315f05b9c4420fee042599fd1402e6429aae9c9a31e67fbc8cd6ed7118",
"md5": "3a3b164dbaa92693786d9c9646d6f550",
"sha256": "0157f62a6f67cf102f7c9008aabd860f284a8f65179c765e014c907447ec5a67"
},
"downloads": -1,
"filename": "pgaddons-1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3a3b164dbaa92693786d9c9646d6f550",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3",
"size": 7951,
"upload_time": "2024-12-16T20:55:15",
"upload_time_iso_8601": "2024-12-16T20:55:15.075709Z",
"url": "https://files.pythonhosted.org/packages/63/9b/9a315f05b9c4420fee042599fd1402e6429aae9c9a31e67fbc8cd6ed7118/pgaddons-1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b73156a9a60793cb0ce2fe7333c233930d04143e3dda2b3be41bff59f40fa0a0",
"md5": "56a8bcb22c738b7a2db12eae06bfab59",
"sha256": "6211b1f9f3f34c06c37839816843cbd70053dac59b5a4019f295ba2d47317e62"
},
"downloads": -1,
"filename": "pgaddons-1.2.tar.gz",
"has_sig": false,
"md5_digest": "56a8bcb22c738b7a2db12eae06bfab59",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3",
"size": 5736,
"upload_time": "2024-12-16T20:55:16",
"upload_time_iso_8601": "2024-12-16T20:55:16.110850Z",
"url": "https://files.pythonhosted.org/packages/b7/31/56a9a60793cb0ce2fe7333c233930d04143e3dda2b3be41bff59f40fa0a0/pgaddons-1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-16 20:55:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "iamdeedz",
"github_project": "pygame-addons",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pgaddons"
}
