Home

Stencil3 Manual

Last updated for: v3.0.0-alpha.7

This manual is best viewed in MdBook: [https://mrt-map.github.io/stencil3/docs]. (It is also still available on GitHub Wiki for historical purposes.)

Stencil3 is an application maintained and built by MRT Mapping Services to edit PLA3 map data for the street map of the MRT City Map.

Installation

• Universal
  • Cargo
    • Run cargo install --git https://github.com/MRT-Map/stencil3
    • Launch stencil3 with stencil3
• Windows
  • Scoop (untested)
    • scoop install "https://raw.githubusercontent.com/MRT-Map/stencil3/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 stencil3 in file explorer in [Drive]:\Program Files\stencil3\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 stencil3
  • Homebrew
    • brew install --cask mrt-map/mrt-map/stencil3
• Linux
  • deb
    • Download the .deb file in the assets folder of the latest GitHub release
    • Extract & install the file... TODO write instructions
  • Arch PKGBUILD
    • Add to /etc/pacman.conf:

      [arch-mrt-map]
      Server = https://mrt-map.github.io/arch-mrt-map/x86_64
      SigLevel = Optional TrustAll

    • sudo pacman -Sy stencil3

FAQ & Troubleshooting

1. Can I use Stencil3 for general purpose map annotating?
   • You technically can, though it's not recommended
2. I found a bug / problem! / Stencil3 crashed on me!
   • Check the logs folder for the latest panic log.
     • Check here (TODO) to see where your logs folder is.
     • 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)
3. CJK characters aren't showing / I see black boxes as text
   • The default font only supports Latin, Greek and Cyrillic letters. You may need to import custom fonts from your system at Settings > UI > Custom Fonts.
     • Set your custom font as Lowest if you do not want your custom font to override the default font.