Easily generate any FGO expression sheets from an id, powered by AtlasAcademy
Find a file
2024-10-20 21:38:22 +02:00
.forgejo/workflows
skyeweave
tests
.gitignore
pyproject.toml
README.md

skyeweave

Easily generate any FGO expression sheets from an id

Developed by Firq and powered by the AtlasAcademy API

Installation

The CLI can be installed by using pip. Python >= 3.10 is required.

pip install --extra-index-url https://forgejo.neshweb.net/api/packages/Firq/pypi/simple/ skyeweave

Note: Specifying the additional index of forgejo.neshweb.net is necessary, as I don't host my packages on PyPI. Using --extra-index-url is necessary as the specified depencencies are not hosted on that index.

Usage

commandline

skyeweave is primarily a CLI application.

The following options are available:

  • --help / -h: Shows helpful information about the other arguments
  • --version: Shows the version number
  • --output: Sets the output file path. This can be a relative path (./out or an absolute path C:/files/out)
  • --id: Specify a servantId or charaId. This will skip the user prompt afterwards (useful in CI applications)
  • --filter: Specify which spritesheets will actually be used. Useful if you want multiple spritesheets, but not all
  • --timeout: Sets the timeout for any requests towards the Atlas Academy API. The default is 10 seconds
  • --no-cache: Clear cache for this id, keeping all other files
  • --reset: Delete any already downloaded assets
  • --quiet / -q: Mute the output and hide progress bars

Typical usage:

skyeweave --output out --id 70

This would generate the expressions for Scathach (Servant Id 70) in the folder out, using subfolders to better separate the outputs of multiple runs.

python scripts [EXPERIMENTAL]

skyeweave can also be used in other Python scripts.

from skyeweave import SkyeWeave
SkyeWeave().compose(70)

This feature will be expanded upon in future releases.

Issues / Support

If there are any issues with skyeweave, feel free to reach out to me using the AtlasAcademy discord (#dev-corner) or create an issue in this repo.

If you want to help me debug when an issue occurs, set the environment variable SKYEWEAVE_STDOUT_LEVEL to debug and send me a copy of the log

Example on Windows:

$env:SKYEWEAVE_STDOUT_LEVEL="debug"

skyeweave --output out --id 70 > log.log