Commit ff3197c4 authored by Ahmad Reza Cheraghi's avatar Ahmad Reza Cheraghi
Browse files

Replace README.md

parent d76ff3b2
# Setting up the project
# Setting up and running the project the project
1. Install python 3.6
- Linux/Ubuntu: https://tecadmin.net/install-python-3-6-ubuntu-linuxmint/#
2. Use pip to install pyglet 1.2.4
- Linux/Ubuntu: $ sudo pip3.6 install pyglet
. Download the actual project from:
URL: https://gitlab.cs.uni-duesseldorf.de/cheraghi/SwarmNetworkSimulator/-/archive/master/SwarmNetworkSimulator-master.zip
. Unzip it:
-Linux/Ubuntu: $ unzip DownloadDirectory/SwarmNetworkSimulator-master.zip
3. Run the project
- - Linux/Ubuntu:
$ cd SwarmNetworkSimulator-maste
$ python3.6 main.py
# Usage
## Keyboard Shortcuts
- space: pause / unpause simulation
- ctrl+mouseclick: add/remove tile at mouse position
- cmd+s: take screenshot
- cmd+v: toggle video mode, see below
## Creating Videos
- use cmd+v to toggle video mode which takes a screenshot of every frame
- you can use ffmpeg to create a videos from your screenshots
```shell
ffmpeg -framerate 90 -pattern_type glob -i '*.png' -c:v libx264 -pix_fmt yuv420p -r 30 out.mov
```
#Config the project:
# Troubleshooting
- if you are on mac os and get an error message stating something along the lines of `ApplePersistenceIgnoreState: Existing state will not be touched.` when starting the simulator, open a terminal and execute the following command
```
defaults write org.python.python ApplePersistenceIgnoreState NO
```
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment