Metadata-Version: 2.1
Name: pywowgen
Version: 0.0.27
Summary: Generate and configure Workadventure worlds, maps and resources
Home-page: https://git.cccwi.de/2dwt/wowgen
Author: tigabeatz
Author-email: tigabeatz@cccwi.de
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 3 - Alpha
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# pywowgen

Create Workadventure maps and worlds (set of interconnected maps) suitable for "rc3" or "vanilla" Workadventure
instances.

- Generate maps from templates and generator scripts.
- Check maps for errors and missing resources and display this in an interactive graph view.
- Fix map errors using the graph view.
- Apply some overwrites and fixes to generate maps which will run in default workadventure and / or the community / rc3
  edition.
- Merge resources metadata (licenses, ...) into a single file info to be used in maps.

## Use the CLI

    # Optionally set the env WOWGEN_EXTRA prior execution to define where all the resources go. If not set, its will be set to the operating systems temp dir
    # E.g. WOWGEN_EXTRA=/tmp/wowgen_extra

    # Load external resources from git and verify installation
    pywowgen test

    # Run the api
    pywowgen api --res ${WOWGEN_EXTRA}\wowgen.git\res --tmp ${WOWGEN_EXTRA}\TMP --fin ${WOWGEN_EXTRA}\sites --force True
    
    # Check a resource folder
    pywowgen overview --path ${WOWGEN_EXTRA}\wowgen.git\res 
    
    # Run a world build
    pywowgen world --file . ${WOWGEN_EXTRA}\wowgen.git\examples\default_pipeline.json --res ${WOWGEN_EXTRA}\wowgen.git\res --tmp .${WOWGEN_EXTRA}\wowgen.git\sites\default_pipeline --fin ${WOWGEN_EXTRA}
    
    # Analyze a world build
    pywowgen check --path  ${WOWGEN_EXTRA}\wowgen.git\sites\default_pipeline

    
    
