# Topola [Topola](https://topola.dev) is a work-in-progress interactive topological router for printed circuit boards (PCBs) in Rust. ## Chat Join the official [Matrix chatroom](https://matrix.to/#/%23topola:tchncs.de) or [IRC channel](https://webchat.oftc.net/?channels=#topola) to talk with the developers. Both chatrooms are bridged, so it does not matter which one you join. ## Installation To install Topola, follow our [Installation guide](INSTALL.md). ## Contributing *Anyone* can contribute to Topola, including you. If you want to help us out, please follow our [Contribution guide](CONTRIBUTING.md). The easiest way to contribute is by reporting issues on our [issue tracker](https://codeberg.org/topola/topola/issues). If you know any language other than English, you can help by translating Topola on [Codeberg's Weblate](https://translate.codeberg.org/engage/topola/). ![](https://translate.codeberg.org/widget/topola/topola/multi-auto.svg) Our official repository is on [Codeberg](https://codeberg.org/topola/topola). We also have a mirror repository on [GitHub](https://github.com/mikwielgus/topola). ## Licence Topola is licensed under the [MIT licence](LICENSES/MIT.txt). Files present in the `assets/` directory are dual-licensed as under MIT or [Creative Commons Attribution 4.0 International](LICENSES/CC-BY-4.0.txt) licence. The file `crates/planar-incr-embed/src/math.rs` is dual-licensed as under MIT or [Apache 2.0](LICENSES/Apache-2.0.txt) licence. ### Inbound licence is outbound licence Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you will be licensed as described above, without any additional terms or conditions. ## Acknowledgements This project is funded through the NGI0 Entrust Fund, a fund established by NLnet with financial support from the European Commission's Next Generation Internet programme, under the aegis of DG Communications Networks, Content and Technology under grant agreement No 101069594. NLnet Foundation banner NGI0 Entrust banner ## Gallery ![Screenshot of a PCB layout of an IR remote with a 3x4 tactswitch keyboard, displayed in KiCad.](./assets/screenshots/3x4_tactswitch_ir_remote.png "3x4 tactswitch IR remote PCB layout in KiCad") ![Screenshot of a PCB layout of a THT DB-25 to THT DB-25 gender changer adapter board, displayed in KiCad](./assets/screenshots/tht_db25_to_tht_db25.png "THT DB-25 to THT DB-25 gender changer adapter PCB layout in KiCad") ![Screenshot of a PCB layout of a 4x4 1206 LED matrix breakout board, displayed in KiCad](./assets/screenshots/4x4_1206_led_matrix_breakout.png "4x4 1206 LED matrix breakout PCB layout in KiCad") ![Animation. There is a rubber band-like trace following cursor, navigating a very simple maze. The maze and the trace are red, the background is solid black but also very slightly white and dark blue.](./assets/screencasts/pre-egui_interactive_routing.gif "Interactive routing") ![Animation showing a trace, behaving like a rubber band, routed around obstacles step by step. Attempted alternative paths and a guiding mesh are shown.](./assets/screencasts/pre-egui_debug_visualization.gif "Debug visualization") ![Animation. There are two upward barriers, with some space between tem, around which four rubberband traces, one over another, are wrapped. Enter mouse cursor. The cursor begins to stretch the left barrier to the right. As it's stretched, the traces cease to be wrapped around the right barrier, becoming "free". The traces and the barrier are two-dimensional and all solid red. The background is black but also very slightly white and blue.](./assets/screencasts/pre-egui_unwrapping_bends.gif "Unwrapping bends") ![This animation shows four traces wrapped around a vertical barrier like rubberbands. Computer cursor appears and starts dragging the barrier's top end left and right, up and down, elastically stretching the barrier and having the traces continue being wrapped on the barrier regardless of its position. The traces and the barrier are all solid red. The background is black but also very slightly white and blue.](./assets/screencasts/pre-egui_dragging_with_bends.gif "Dragging with bends") ![Animation. There is an upward barrier in the middle and dots on the left and right of it, four each. A trace is drawn from the leftmost dot on the left to the rightmost dot on the right. Then a trace is drawn from the second leftmost dot on the left to the second rightmost dot on the right, displacing the previous trace so that there's space for the new one. Same happens for the remaining dots. The dots, traces and barrier are all solid red. The background is black but also very slightly white and blue.](./assets/screencasts/pre-egui_squeezing_through_under_bends.gif "Squeezing through under bends") ![Animation showing three red-colored traces pass around a barrier. Trace bends are not aligned to a grid unlike most PCB layouts these days (this is called "topological routing"). The traces and the barrier are all solid red. The background is black but also very slightly white and blue.](./assets/screenshots/pre-egui_stacked_bends.png "Stacking bends") ![Animation showing a trace zigzagging around two barriers. The trace and the barriers are all solid red. The background is black but also very slightly white and blue.](./assets/screenshots/pre-egui_zigzag.png "Zigzag")