Home

Welcome to Stencil2's manual!

Last updated for: v2.2.0

Stencil2 is a software maintained and built by the MRT Mapping Organisation to edit map data for the street map of the MRT City Map.

Universal
- Cargo
  - Run cargo toolchain install nightly if the nightly compiler isn't installed
  - Run cargo +nightly install --git https://github.com/MRT-Map/stencil2
  - Launch stencil2 with stencil2
Windows
- Scoop (untested)
  - scoop install "https://raw.githubusercontent.com/MRT-Map/stencil2/master/build/windows/scoop.json"
- msi
  - Download the .msi file in the assets folder of the latest GitHub release
  - Open the .msi file and follow the instructions
  - Launch stencil2 in file explorer in either [Drive]:\Program Files\stencil2\bin or [Drive]:\Program Files (x86)\stencil2\bin
  - Remember to pin it to start/taskbar if it isn't indexed in the search bar ;)
MacOS
- dmg
  - Download the .dmg file in the assets folder of the latest GitHub release
  - Open the .dmg file and drag the application into the folder
  - Launch stencil2
- Homebrew
  - brew install --cask mrt-map/mrt-map/stencil2
Linux
- deb
  - Download the .deb file in the assets folder of the latest GitHub release
  - Extract & install the file... TODO write instructions
- via PKGBUILD (Arch et al)
  - Create a new folder name and cd into it
  - curl "https://raw.githubusercontent.com/MRT-Map/stencil2/master/build/linux/PKGBUILD" -Lo PKGBUILD
  - makepkg -si

Can I use Stencil2 for general purpose map annotating?
- You technically can, though it's not recommended
I found a bug / problem! / Stencil2 crashed on me!
- In the data directory, check under the TODO folder for the latest panic log for an error message.
  - If it's to do with toml deserialisation, check that your toml files are syntactically correct.
- Otherwise, open an issue in this repository, and check if your issue is a duplicate of another one
- (You can also DM me on Discord, but if you have a GitHub account please use issues)
Tiles don't show up!
- Try reopening Stencil2. This is known to fix the issue on macOS
- If not, open up the window settings / window_settings.toml and try disabling one of the backends and then restarting to see if it fixes the issue. This is known to fix the issue on Windows
- Otherwise, raise an issue (recommended) or contact 7d