Skip to main content

A small example package

Project description

satori

satori is a tool that generates a Gensokyo-style spellcard fight purely randomly.

Usage

Clone this repository, and run main.py.

# Install dependencies
pip3 install tomlkit
# Clone and run
git clone https://github.com/Ravenclaw-OIer/satori
python3 satori/satori.py reimu marisa # change reimu and marisa to whoever you want

Rules

satori reads spellcard data from your mind characters.toml file.

Rounds

A spellcard fight is consisted of several rounds, it will continue until one of the players has her hp strictly lower than 0.

In each round, the following events happen in chronological order:

  1. A random number is generated between 0 and the atk value of both players. This value is the atk value used for comparison in this round.
  2. The one with the higher atk value for this round will be the attacker. A spellcard is randomly picked from her spellcards.
  3. A number is randomly picked between the two values specified in the spellcard's harm field. This is the harm (hp drop) caused by this spellcard. This value may be 0.
  4. The harm is applied.
  5. If the spellcard comes with shields, hp boosts or atk boosts, it is applied.
  6. The round ends, if both player have their hp >= 0, return to step 1.

Spellcards

Each spellcard has the following fields:

  • name: a string, the name used to refer to the spellcard within the program
  • display_name: a string, the displayed name of the spellcard.

Contributing

You can contribute by

  • Writing more spellcards
  • Implementing complex spellcard behaviors
  • Simply playing around and report bugs

Note

TOML sanity is not checked, so be extra careful with the format.

Sanity check will be implemented in a future release (at least I hope so)

Features I will implement some day (a.k.a to-do list)

  • Complex spellcard trigger conditions
  • Complex spellcard effects
  • Chinese docs

License

This program is free software, you can redistribute it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3, or, at your option, any later version.

Touhou Project is Copyright(C) Team Shanghai Alice, usage of their IP should follow their guidelines

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

satori-gensokyo-0.1.0.tar.gz (14.5 kB view hashes)

Uploaded Source

Built Distribution

satori_gensokyo-0.1.0-py3-none-any.whl (14.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page