Skip to content

Commit e590542

Browse files
committed
Update README
1 parent bd80f63 commit e590542

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

README.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# arpchat
22

3-
so... you know arp? the protocol your computer uses to find other computers on the network? yeah. that.
3+
so... you know arp? the protocol your computer uses to find the mac addresses of other computers on your network? yeah. that.
44

5-
i thought it would be a great idea to hijack it to make a tui chat app :)
5+
i thought it would be a great idea to hijack it to make a chat app :)
66

7-
![screenshot of the tool in action](https://doggo.ninja/We4N7T.png)
7+
![screenshot of the tool in action](https://doggo.ninja/RJGHYH.png)
88

99
## motivation
1010

@@ -18,24 +18,28 @@ i thought it would be a great idea to hijack it to make a tui chat app :)
1818

1919
yes
2020

21+
## things i made arpchat do
22+
23+
you can send messages tens of thousands of characters long because i implemented a (naive) generalizable transport protocol on top of arp. there's also a bit of compression.
24+
25+
if you wanted, you could probably split off the networking part of this and use it instead of udp. please don't do this.
26+
27+
not only are join and leave notifications a thing, i built an entire presence discovery system to see a list of other online users. ironically, this serves a similar purpose to arp itself.
28+
29+
i'm planning on experimenting with and adding settings for different arp packet types, since some routers might filter out the malformed ip packets i'm currently using.
30+
2131
## running
2232

2333
if you actually want to install this for some reason, you can get it from [the releases page](https://github.com/kognise/arpchat/releases/latest).
2434

2535
on windows, you probably need [npcap](https://npcap.com/#download). make sure you check "Install Npcap in WinPcap API-compatible Mode" in the installer!
2636

37+
![interface selector](https://doggo.ninja/tvFJ2A.png)
38+
2739
then just run the binary in a terminal. you know it's working properly if you can see your own messages when you send them. if you *can't* see your messages, try selecting a different interface!
2840

2941
have any issues? that really sucks. you can make an issue if it pleases you.
3042

31-
## things i made arpchat do
32-
33-
you can send messages tens of thousands of characters long because i implemented a naive chunked transport protocol and added some compression.
34-
35-
join and leave messages are a thing as well.
36-
37-
i'm planning on experimenting with and adding settings for different arp packet types, since some routers might filter out the malformed ip packets i'm currently using.
38-
3943
![banner](https://doggo.ninja/fH9GKt.png)
4044

4145
## building

0 commit comments

Comments
 (0)