diff --git a/sim/README.md b/sim/README.md index e7c00c85341ff9f348ca1a421f8431ce95ca45a7..325088b9213ff67e989fde8052978747ceafc6de 100644 --- a/sim/README.md +++ b/sim/README.md @@ -18,6 +18,11 @@ If not using nix-shell, you'll need Python3 with the following libraries: - wasmer - wasmer-compiler-cranelift +For full functionality you'll also need: + + - requests + - pymad + All of these should be available in PyPI. Installing in a venv @@ -26,10 +31,16 @@ Installing in a venv ``` python -m venv venv source venv/bin/activate -pip install wasmer wasmer-compiler-cranelift pygame +pip install wasmer wasmer-compiler-cranelift pygame requests pymad ``` -Note: The simulator currently does no work with python3.11. Make sure to use python ≤3.10. +Note: The wasmer python module from PyPI [doesn't work with Python version 3.11](https://github.com/wasmerio/wasmer-python/issues/539). +You will get `ImportError: Wasmer is not available on this system` when trying to run the simulator. Instead, install our [rebuilt wasmer wheels](https://flow3r.garden/tmp/wasmer-py311/) using: + +``` +venv/bin/pip install https://flow3r.garden/tmp/wasmer-py311/wasmer_compiler_cranelift-1.2.0-cp311-cp311-manylinux_2_34_x86_64.whl +venv/bin/pip install https://flow3r.garden/tmp/wasmer-py311/wasmer-1.2.0-cp311-cp311-manylinux_2_34_x86_64.whl +``` Running --- @@ -43,7 +54,7 @@ python3 sim/run.py Known Issues --- -No support for audio yet. +No support for most audio APIs or positional captouch yet. Hacking ---