This is a LAN chatroom made by your beloved Ornithopter747. It is made to be used in a completely decentralised way on a single network, allowing peer-to-peer chatting without any (external) servers.
This software is no longer being updated, at least not frequently.
The setting up is a bit long. Sorry for the inconvenience, but I do recommend reading all of this document up until Updating.
Download this repository by running the following command in your terminal.
git clone https://github.com/ornitongithub/lan-chatroomOpen the folder you just downloaded.
Install Flask by running:
pip3 install flaskIf that doesn't work, try:
pip3 install --trusted-host pypi.org --trusted-host pypi.python.org --trusted-host files.pythonhosted.org flask --userThere is a configuration file called settings.json that looks like this:
{
"username": "YourUsernameHere",
"port": 12345,
"colour": "black",
"open_browser": true,
"browser": null
}This is where you can change different settings. To edit them, simply edit the field after the : like this:
[...]
"username" : "My new cool username",
[...] |
|
This was changed. <---'If you messed up or for any other reason want to reset, run
git reset --hardusername: a legal username is between 3-20 characters, and contains no newline characters.
port: the port you're chatting on. Think of this as a room. You only send and recieve messages from a certain port. Either use the default port 12345 or agree on a new port with your friends.
colour: the colour your messages will appear. Possible colours are:
- red
- orange
- gold
- green
- blue
- purple
- black
(and other info)
Skip this part if you're not running into errors.
open_browser dictates wether the program will automatically open the browser for you (this is a web app). If you set it to false, you'll have to start your browser and visit localhost:5000 yourself.
browser is the browser that gets open by default. null will open your default browser. If it doesn't work, or if you want to set the browser manually, change it like in these examples:
"browser" : "firefox", "browser" : "safari",By the way, the port number is always odd, as the following even port is used for other parts of the script (pinging users. If you set the port to an even number, it will be rounded up to the next odd number).
If you were to use an even port, the program would just round it up to the next odd port.
Also, some ports are reserved for other activity by your computer. The free ports generally are 49152 - 65535.
Keep in mind ports are not a security measure. Encyption is.
This program supports symmetric encryption. When sending a message, it gets encrypted with the encryption key. The default one is "default". It can be found in key.txt.
Any messages that cannot be decrypted (with your encryption key) will simply not be displayed. Make sure you and all your chatmates use the same key.
By the way, the key can be pretty much anything you can fit into that text file.
Run main.py. Either by running it in VSCode or by running
python3 main.pyin your terminal. Make sure you're using python interpret 3.10+
Normally a browser window should open automatically. If it does not, ckeck Extra config.
Now that your browser opened the app, you can start chatting.
If your browser says "page not found" or anything along those lines, just try reloading the page.
To close the app, press ctrl+c in your terminal.
You can run the update script:
python3 update.pyThis script updates and saves your config file. It however does not save key.txt.
We are now in the final release. There are not so many plans anymore.
(NOTE: Everything is in docs/todo.md)
You can make a pull request. I will only accept clean bug fixes and small patches of the sort. No big features, sorry.
Make sure you respect the LICENSE please. Thank you.
Check the release notes, thank you.