# entyty
**entyty** is a Python module that defines a framework for managing entities in a game or simulation environment. Entities are objects that can exist on a grid, occupy cells, and perform various actions within the system. The module provides base classes for creating and managing entities in a game or simulation. It also includes a set of subclasses that extend the framework to support grid-based entities. The module relies on the [pyglet](https://github.com/pyglet/pyglet) library for event dispatching/handling.
## Package Structure
The "entyty" package consists of the following classes:
- '_AbstractEntity'
- '_BaseEntity'
- 'Entity'
- 'LogicalEntity'
- 'VisualEntity'
- '_AbstractGridEntity'
- 'GridEntity'
## Entities
### Entity
- `Entity` is a subclass of `BaseEntity` representing general entities.
### LogicalEntity
- `LogicalEntity` is a subclass of `BaseEntity` representing logical entities.
### VisualEntity
- `VisualEntity` is a subclass of `BaseEntity` representing visual entities.
- It includes additional properties for managing an element and a position.
### GridEntity
- `GridEntity` is a concrete subclass of `AbstractGridEntity`.
- It represents grid-based entities and includes methods and properties for managing their movement and actions.
- Grid entities can occupy cells, move on a grid, and perform actions.
## Usage
To use the "entyty" package, you can create subclasses of the provided base classes to define specific entity types in your game or simulation. Customize the properties and methods to suit your needs.
Here's a simple example of how to create an entity:
```python
from entyty import LogicalEntity
class MyEntity(LogicalEntity):
def __init__(self):
super().__init__(name='MyEntity', **kwargs)
my_entity = MyEntity()
```
Raw data
{
"_id": null,
"home_page": "https://github.com/primal-coder/entyty",
"name": "entyty",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "entity game development grid",
"author": "James Evans",
"author_email": "joesaysahoy@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/da/3c/5cc7d7e215828c1b89bf47584f92dfd52a94c683c760363ba77b9fc43a8f/entyty-0.0.54.tar.gz",
"platform": null,
"description": "# entyty\n\n**entyty** is a Python module that defines a framework for managing entities in a game or simulation environment. Entities are objects that can exist on a grid, occupy cells, and perform various actions within the system. The module provides base classes for creating and managing entities in a game or simulation. It also includes a set of subclasses that extend the framework to support grid-based entities. The module relies on the [pyglet](https://github.com/pyglet/pyglet) library for event dispatching/handling.\n\n## Package Structure\n\nThe \"entyty\" package consists of the following classes:\n\n- '_AbstractEntity'\n- '_BaseEntity'\n\n- 'Entity'\n- 'LogicalEntity'\n- 'VisualEntity'\n\n- '_AbstractGridEntity'\n\n- 'GridEntity'\n\n\n## Entities\n\n### Entity\n\n- `Entity` is a subclass of `BaseEntity` representing general entities.\n\n### LogicalEntity\n\n- `LogicalEntity` is a subclass of `BaseEntity` representing logical entities.\n\n### VisualEntity\n\n- `VisualEntity` is a subclass of `BaseEntity` representing visual entities.\n- It includes additional properties for managing an element and a position.\n\n### GridEntity\n\n- `GridEntity` is a concrete subclass of `AbstractGridEntity`.\n- It represents grid-based entities and includes methods and properties for managing their movement and actions.\n- Grid entities can occupy cells, move on a grid, and perform actions.\n\n## Usage\n\nTo use the \"entyty\" package, you can create subclasses of the provided base classes to define specific entity types in your game or simulation. Customize the properties and methods to suit your needs.\n\nHere's a simple example of how to create an entity:\n\n```python\nfrom entyty import LogicalEntity\n\nclass MyEntity(LogicalEntity):\n def __init__(self):\n super().__init__(name='MyEntity', **kwargs)\n\nmy_entity = MyEntity()\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python library for creating and managing entities.",
"version": "0.0.54",
"project_urls": {
"Homepage": "https://github.com/primal-coder/entyty"
},
"split_keywords": [
"entity",
"game",
"development",
"grid"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "da3c5cc7d7e215828c1b89bf47584f92dfd52a94c683c760363ba77b9fc43a8f",
"md5": "009b10ffb706bd8afd99e5187c39cd68",
"sha256": "4c9d712e9fc8f04afb4d2ea38b5f8fba0e7174f257c2bb85719a7e47bd4f787d"
},
"downloads": -1,
"filename": "entyty-0.0.54.tar.gz",
"has_sig": false,
"md5_digest": "009b10ffb706bd8afd99e5187c39cd68",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 9035,
"upload_time": "2024-07-01T03:36:26",
"upload_time_iso_8601": "2024-07-01T03:36:26.277919Z",
"url": "https://files.pythonhosted.org/packages/da/3c/5cc7d7e215828c1b89bf47584f92dfd52a94c683c760363ba77b9fc43a8f/entyty-0.0.54.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-01 03:36:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "primal-coder",
"github_project": "entyty",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "entyty"
}
JSON
