diff --git a/README.md b/README.md index 2e7ad39..3560323 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,11 @@ A text adventure game using @askmarvinai ```console pip install git+https://github.com/waylonwalker/marvin-sw-text-adventure.git -# or +# or with pipx pipx install git+https://github.com/waylonwalker/marvin-sw-text-adventure.git +# or with hatch +git clone https://github.com/waylonwalker/marvin-sw-text-adventure/ +hatch run game ``` ## Run @@ -18,6 +21,41 @@ run the game sw-adventure game run ``` +## Example Mission + +```console +[19:45:13] Starting game game.py:30 +generating your character +╭─ Kara Bright's Mission Card ─────────────────────────────────────────────────╮ +│ Kara Bright │ Kara Bright was born in the │ +│ health │ 100 │ bustling city planet of Coruscant. │ +│ imperial credits │ 500 │ Growing up, she witnessed the │ +│ fuel level │ 100 │ corruption and greed of the │ +│ │ Imperial government. Despite the │ +│ │ danger, she joined an underground │ +│ │ resistance movement at a young age, │ +│ │ fighting to overthrow the │ +│ │ oppressive regime. She quickly rose │ +│ │ through the ranks and became a │ +│ │ skilled fighter and leader. Her │ +│ │ ultimate goal is to bring peace and │ +│ │ justice to the galaxy. │ +│ │ │ +│ Firefly │ A small, speedy ship with enough │ +│ year built │ 10 │ cargo space to transport a small │ +│ capacity │ 4 │ crew and their gear. │ +│ fuel level │ 100 │ │ +│ │ │ +│ Operation Shadow Hand │ The Empire is developing a new │ +│ place │ Imperial Base on Kashyyyk │ weapon on Kashyyyk. We need to │ +│ year │ 4 │ infiltrate the base and destroy it │ +│ risk │ 50 hp │ before they can use it against the │ +│ reward │ 1000 credits │ Rebellion. Watch out for Imperial │ +│ leader │ General Rieekan │ troops and dangerous wildlife on │ +│ │ the planet. │ +╰──────────────────────────────────────────────────────────────────────────────╯ +``` + ## License `marvin-sw-text-adventure` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license. diff --git a/pyproject.toml b/pyproject.toml index 3201e89..5367205 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -58,19 +58,7 @@ dependencies = [ "black", ] [tool.hatch.envs.default.scripts] -test = "coverage run -m pytest" -cov = "coverage-rich" -lint = "ruff marvin_sw_text_adventure" -format = "black marvin_sw_text_adventure" -format-check = "black --check marvin_sw_text_adventure" -build-docs = "markata build" -lint-test = [ - "lint", - "format-check", - "test", - "cov", -] -test-lint = "lint-test" +game = 'marvin-sw-text-adventure game run' [[tool.hatch.envs.test.matrix]] python = ["37", "38", "39", "310", "311"]