README.md

   1 Simple Stage
   2 ============
   3
   4 This repository contains simple Stage situations. The goal is to understand the
   5 [Stage][1] simulator and the [Meson Build system][2].
   6
   7 The project is published under [GPLv3 License][].
   8
   9 [1]: https://playerproject.github.io/stage/
  10 [2]: https://mesonbuild.com/
  11 [GPLv3 License]: ./LICENSE
  12
  13
  14 Generic instructions
  15 ====================
  16
  17 Prerequisities
  18 --------------
  19
  20 - You need to have the [Stage][1] simulator.
  21 - You must set proper paths in the `meson.build` file.
  22
  23 Building
  24 --------
  25
  26     meson setup builddir
  27     cd builddir
  28     ninja
  29
  30 Running
  31 -------
  32
  33 - `STAGEPATH` must be set to directory containing `.so` modules (i.e.
  34   `builddir`.)
  35 - `LD_LIBRARY_PATH` must be set to directory containing `libstage.so`.
  36
  37 It's possible to put all the settings into the script `stage.sh`:
  38
  39     #!/bin/sh
  40     STAGEPATH=. LD_LIBRARY_PATH=/path/to/stg/lib /path/to/stg/bin/stage $@
  41
  42 And run the `stage.sh` from the `build` directory:
  43
  44     stage.sh ../worlds/test_track.world
  45
  46
  47 Simple situations
  48 =================
  49
  50 Test race track
  51 ---------------
  52
  53 - Used world: `worlds/test_track.world`
  54 - Used car: `model/tx2-auto-3.model`
  55 - Used ctrl: `ctrl/goforward.cc`
  56
  57 The _test race track_ and `tx2-auto-3` are used in F1/10 project of [IID][]
  58 group. The `libgoforward` controls the robot to just go straight.
  59
  60 `libgobackward` is the same as `libgoforward` but with the negative speed. It's
  61 written in more OOP way.
  62
  63 `libttpp` implements Pure-Pursuit controller with static target points of test
  64 track. It's based on `libgobackward`.
  65
  66 [IID]: https://iid.ciirc.cvut.cz/