Quick Start#

Try LychSim with our Quick Start Package – without Unreal Engine 5 installation!

  1. Install the LychSim Python package straight from GitHub:

    pip install git+https://github.com/wufeim/LychSim.git

  2. Download the demo scene package built for Linux from here.

  3. Unpack the zip, then register and launch the demo with the lychsim CLI:

    lychsim env add /path/to/demo        # accepts the unpacked directory, or the .sh / .exe directly
lychsim run demo                     # detached background launch; prints ip:port once ready

  4. Test the connection and rendering: pytest tests --server_name=0.0.0.0 -v. Rendered images will be written to the test_outputs/ folder.

  5. Explore the demo scene with our LychSim Python API!

Use lychsim ps to inspect running instances, lychsim logs <handle> -f to tail the UE log, and lychsim stop all to tear everything down when you are done. If anything looks off, run lychsim doctor to flag missing paths, plugin issues, or port conflicts.

../_images/quick_start_01.png

Example rendering from the demo scene.#