Documentation

Installation

Linux: download the proper tar.gz file and run tar -xvzf nightfox_x86-64.tar.gz, cd into the folder and execute the binary like ./nightfox.
You may need to run chmod u+x nightfox so you'll be able to execute the binary.

Windows: download the proper zip file for your system architecture, use something like Winzip or equivalent to extract, and execute nightfox.exe.

⮤Back up!

Hotkeys

F1 - Home screen with general information
F2 - List of joined networks with details
F3 - List of predefined multicast IPs to join(LAN)
F4 - List of channels with details (Main and DMs)
F5 - List of peers from last selected network
F6 - List of all downloads in current session
F7 - List of all uploads in current session
F8 - Last opened channel

⮤Back up!

Commands

/join <ip addr> - join a network (or directIP DM)
/rj - try to rejoin a directIP network if offline
/nets - list of joined networks
/peers - list of peers from last selected network
/chs - list of channels (Main and DMs)
/uname <username> - change username
/snd <path to file> - send a file (only DM)
/dl - list of downloads
/ul - list of uploads
/addrs - list of predefined IPs (use as networks)
/help - help page

⮤Back up!

Networks

There are 3 types of networks, Multicast, Broadcast and DirectIP

Multicast networks are based on the multicast capability of the router, meaning the router will relay information to computers/devices that subscribe to that particular multicast address (ex:239.0.0.1).

Broadcast networks work the same way as multicast networks do except for the fact that information is relayed to all computers/devices that are connected to the router without the any of them subscribing.

DirectIP networks are based on direct addressing, no router in the middle but the peers IP towards you are connecting to needs to be accessible. If you are unsure try to see if you can ping the host. This will open a private communication channel between you and your peer.

Use /join <ip> to join a multicast network or use the predefined list under /addrs command or F3 key and select an address using UP/DOWN arrow keys and press ENTER to join. To view the list of joined networks use /nets command or press F2 key and use UP/DOWN arrow keys.

You can leave a network at any time by navigating to it with arrow keys and pressing DELETE. Beware if you have a transfer running and you leave the network on which you connected with the peer for the transfer, that transfer will not complete and will fail.

⮤Back up!

Peers

Clients that join the same network (multicast address) will be visible to each other and be able to communicate. Peers can be viewed using /peers command or by pressing F5 key. To view peers of a particular network first select the network. Browse the list using UP/DOWN arrow keys and initiate a private channel with a peer from this list by pressing ENTER key (more about this in the next section).

⮤Back up!

Channels

Channels are the means to commuicate with the other peers from a given network.
There are three types of channels, Main, NetDM and DM.

Main channel, is implicitly created for you when joining a multicast network, for example from the predefiend list of multicast addresses. This channels is formed by all the peers connected to the network in case. Messages sent on this channel get relayed by the router to all peers connected to this network(multicast address).

NetDM channel is opened when you select a peer from a network's peer list. Messages sent on this channel are directed only to the peer in case. This type of channel also support file transfers (more on this in the transfer section).

DM channel is opened implicitly when you connect to an address of another computer/device on the LAN. Messages are directed only to that computer. This type of channel also supports file transfers (more on this in the transfer section).

View channels with /chs command or F4 key.

⮤Back up!

Messaging

Use channels to exchange messages between peers. Message history on a channel is saved up to 100 sent/received messages back. You can browse the messages exchanged on a channel using UP/DOWN arrow keys. Messages are presented in different colors based on their provenance or success of being sent.

Cyan - received message.
Green - message sent, and received by all participants of the channel (complete success).
Yellow - message sent, and received by part of the participants of the channel (partial success).
Red - message sent, but not received at all by any participants of the channel (failure).
White - message sent, but not yet received by participants (and still retrying) or no peer on the channel to receive the message (applicable to multicast/broadcast channels). This could happen when joining a network and immediately writing to main channel before we collect beacons from the subscribed peers.

⮤Back up!

Uploading/Downloading Files

Transfering files are supported on two types of channels, NetDM and DM. Transfers are split into UPLOAD or DOWNLOAD depending on who is the sender and who is the receiver of the file.

Upload files using /snd <path-to-file> command. The file in case will appear in the upload list and will be analyzed before it can be advertised and sent over. To view the upload list use the /ul command or F7 key. After it has been analyzed the file will pe advertised to the peer and will become available in his download list.
NOTE: I recommend that /snd <path-to-file> command contains the absolute path of the file, filename and file extension.
Example: /snd D:\some_dir\some_file.zip

Download files by accepting the file from the download list available through the /dl command or F6 key. You accept a file to be downloaded by selecting it using UP/DOWN arrow keys and pressing ENTER key.

Remove or abort the upload/download any time using DELETE key.

⮤Back up!