Perigee Demos

This is a living showcase of what can be made with Perigee. If there's a demo or possibility you'd like to see here, let me know and I'll look into adding it.

Requirements

• Git Large File Storage
• Rust and its Cargo package manager to build the core game simulation
• just task runner to make complex or long commands easier to run and remember
• Deno for testing JavaScript WASM wrappers and miscellaneous scripting
• Watchexec for realtime development of web builds (WASM auto-recompiles on changes to Rust code).

Get started

Once all of the above requirements are installed, run just setup to install some language-specific add-ons (Clippy, static file server, etc). After, run just to discover the available tasks.

> just
Available recipes:
    build CRATE         # Build a specific crate (e.g. `just build single_player`)
    build-wasm          # Build single player sims to WASM. Set the RELEASE envar to anything to build in release mode
    build_blender_addon # Generate a .zip file from the Blender addon code to be installed into Blender
    clippy CRATE        # Run clippy on a specific crate (e.g. `just clippy single_player`)
    dev-web             # Rebuild and re-serve the web interface on changes to Rust code
    format              # Format code
    lint                # Lint code
    prepare-web         # Prepare all needed assets for immediate use by the web interface
    serve-prepare-web   # Build and serve the web interface
    serve-web           # Serve the web interface
    setup               # Install language-specific add-ons
    test CRATE          # Test a specific crate (e.g. `just test single_player`)
    test-all            # Test everything
    test-wasm           # Test the JavaScript wrappers around the WASM sims

Licensing

Licensed under the MIT license.

Copyright © 2023 Gerald Nash