README.md (1363B)
1 2 # LNvis 3 4 A Lightning Network Visualizer 5 6 <img src="https://jb55.com/s/a50cb0ae69cd2032.png"/> 7 8 ## Usage 9 10 LNvis requires a json dump of nodes and channels. Currently only clightning 11 channel/node output is supported 12 13 lightning-cli listnodes > clightning-nodes.json && \ 14 lightning-cli listchannels > clightning-channels.json && \ 15 ./lnvis --channels clightning-channels.json \ 16 --nodes clightning-nodes.json \ 17 --filter <starting-node-id> 18 19 ## Controls 20 21 ``` 22 b view multiple channels between nodes 23 t toggle dark/light theme 24 f toggle fps 25 a toggle aliases 26 g toggle grid 27 s toggle stroked nodes (small perf boost) 28 left click move + focus node 29 right click filter node 30 ``` 31 32 ## How it works 33 34 LNvis renders the Lightning Network channel gossip, which include nodes and the 35 edges (channels) between those nodes. 36 37 * Channels are colored by the node that opened the channel 38 39 * Channel widths are rendered proportional to the capacity 40 41 * Right clicking a node filters the view to that node and its neighbors 42 43 * Dragging a node in any view will focus that node and its neihbors 44 45 ## Building 46 47 Install dependencies (`glfw3`, `pkg-config`) 48 49 # Debian / Ubuntu 50 $ sudo apt-get install libglfw3-dev pkg-config 51 52 # MacOS 53 brew install glfw3 54 55 Build 56 57 $ make