| Name | ars-magica JSON |
| Version |
0.1.3
JSON |
| download |
| home_page | None |
| Summary | A Python implementation of Ars Magica 5th Edition mechanics |
| upload_time | 2024-11-27 06:21:14 |
| maintainer | None |
| docs_url | None |
| author | bjornaer |
| requires_python | >=3.10 |
| license | MIT |
| keywords |
ars magica
rpg
game
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Ars Magica Python Implementation
A Python implementation of the Ars Magica 5th Edition mechanics. This project provides a framework for managing Ars Magica sagas, characters, covenants, and magical activities.
> Note: This is a fan-made implementation of the game mechanics and is not affiliated with or endorsed by Atlas Games. Ars Magica is a trademark of Trident, Inc. d/b/a Atlas Games.
## Features
- Character creation and management
- Covenant management
- Laboratory activities
- Spell research system
- Seasonal activities
- Vis and aura management
- Magic item creation
- Command-line interface for all features
## Installation
You can install the package from PyPI:
```bash
pip install ars-magica
```
## Usage
To use the CLI, run `ars` in your terminal. You can see the available commands by running `ars --help`.
### Quick Start
To get started quickly, you can use the following commands:
1. Create a character:
```bash
ars character create "Bonisagus Wizardus" --house Bonisagus --player "Your Name"
```
2. Create a covenant:
```bash
ars covenant create "The Order of Hermes" --size small --aura 1
```
3. Start a seasonal activity:
```bash
ars season schedule "Bonisagus Wizardus" --activity research --subject "Arcane Lore"
```
For more detailed usage and examples, see the [CLI Usage](docs/cli.md) documentation.
## Development
Clone the repository:
```bash
git clone https://github.com/bjornaer/ars.git
```
Install poetry if you haven't already:
```bash
curl -sSL https://install.python-poetry.org | python3 -
```
Install the dependencies:
```bash
poetry install
```
### Running tests
```bash
poetry run pytest
```
Use the makefile for ease of use:
```bash
make test
```
## Project Structure
TBD
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
Note about Ars Magica:
Ars Magica is a trademark of Trident, Inc. d/b/a Atlas Games. This software is not affiliated with or endorsed by Atlas Games. This is a fan-made implementation of the game mechanics and does not include any copyrighted content from the Ars Magica books.
---
_"We are the ancient shapeshifters, guardians of the old ways. Our magic flows from the heart-beast within."_
*- A common saying among House Bjornaer magi*
Raw data
{
"_id": null,
"home_page": null,
"name": "ars-magica",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "ars magica, rpg, game",
"author": "bjornaer",
"author_email": "max.schulkin@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c6/15/c30aba310555cf1ebadb1ace8decaf5191b95505ac0f1acebbd2dcf33e23/ars_magica-0.1.3.tar.gz",
"platform": null,
"description": "# Ars Magica Python Implementation\n\nA Python implementation of the Ars Magica 5th Edition mechanics. This project provides a framework for managing Ars Magica sagas, characters, covenants, and magical activities.\n\n> Note: This is a fan-made implementation of the game mechanics and is not affiliated with or endorsed by Atlas Games. Ars Magica is a trademark of Trident, Inc. d/b/a Atlas Games.\n\n## Features\n\n- Character creation and management\n- Covenant management\n- Laboratory activities\n- Spell research system\n- Seasonal activities\n- Vis and aura management\n- Magic item creation\n- Command-line interface for all features\n\n## Installation\n\nYou can install the package from PyPI:\n\n```bash\npip install ars-magica\n```\n\n## Usage\n\nTo use the CLI, run `ars` in your terminal. You can see the available commands by running `ars --help`.\n\n### Quick Start\n\nTo get started quickly, you can use the following commands:\n\n1. Create a character:\n\n```bash\nars character create \"Bonisagus Wizardus\" --house Bonisagus --player \"Your Name\"\n\n``` \n\n2. Create a covenant:\n\n```bash\nars covenant create \"The Order of Hermes\" --size small --aura 1\n```\n\n3. Start a seasonal activity:\n\n```bash\nars season schedule \"Bonisagus Wizardus\" --activity research --subject \"Arcane Lore\"\n```\n\nFor more detailed usage and examples, see the [CLI Usage](docs/cli.md) documentation.\n\n## Development\n\nClone the repository:\n\n```bash\ngit clone https://github.com/bjornaer/ars.git\n```\n\nInstall poetry if you haven't already:\n\n```bash\ncurl -sSL https://install.python-poetry.org | python3 -\n```\n\nInstall the dependencies:\n\n```bash\npoetry install\n```\n\n### Running tests\n\n```bash\npoetry run pytest\n```\n\nUse the makefile for ease of use:\n\n```bash\nmake test\n```\n\n## Project Structure\n\nTBD\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n\nNote about Ars Magica:\nArs Magica is a trademark of Trident, Inc. d/b/a Atlas Games. This software is not affiliated with or endorsed by Atlas Games. This is a fan-made implementation of the game mechanics and does not include any copyrighted content from the Ars Magica books.\n\n---\n\n_\"We are the ancient shapeshifters, guardians of the old ways. Our magic flows from the heart-beast within.\"_\n\n*- A common saying among House Bjornaer magi*\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python implementation of Ars Magica 5th Edition mechanics",
"version": "0.1.3",
"project_urls": {
"Bug Tracker": "https://github.com/bjornaer/ars/issues",
"Homepage": "https://github.com/bjornaer/ars",
"Repository": "https://github.com/bjornaer/ars.git"
},
"split_keywords": [
"ars magica",
" rpg",
" game"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7d2c327a55e2c3777673155ff0d6b1a1d6bc410bab4b3b32684443e923b0844a",
"md5": "7b19f475256a3600f9b95077424cb944",
"sha256": "94b20556f42dac9692d3521d2442c988ee94047b8fad81b72ea2aa0c8ae87784"
},
"downloads": -1,
"filename": "ars_magica-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7b19f475256a3600f9b95077424cb944",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 80265,
"upload_time": "2024-11-27T06:21:13",
"upload_time_iso_8601": "2024-11-27T06:21:13.018139Z",
"url": "https://files.pythonhosted.org/packages/7d/2c/327a55e2c3777673155ff0d6b1a1d6bc410bab4b3b32684443e923b0844a/ars_magica-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c615c30aba310555cf1ebadb1ace8decaf5191b95505ac0f1acebbd2dcf33e23",
"md5": "04a6c0575084b7f0cec39f8e5c015454",
"sha256": "73df43142203c45ed6556e286a3d55016ab84adbb452048bcaade6891d0466e0"
},
"downloads": -1,
"filename": "ars_magica-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "04a6c0575084b7f0cec39f8e5c015454",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 61677,
"upload_time": "2024-11-27T06:21:14",
"upload_time_iso_8601": "2024-11-27T06:21:14.053521Z",
"url": "https://files.pythonhosted.org/packages/c6/15/c30aba310555cf1ebadb1ace8decaf5191b95505ac0f1acebbd2dcf33e23/ars_magica-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-27 06:21:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bjornaer",
"github_project": "ars",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ars-magica"
}
