Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/superilu/dostodon
MS-DOS Mastodon client
https://github.com/superilu/dostodon
dojs javascript mastodon mastodon-client ms-dos retrocomputing
Last synced: 13 days ago
JSON representation
MS-DOS Mastodon client
- Host: GitHub
- URL: https://github.com/superilu/dostodon
- Owner: SuperIlu
- License: other
- Created: 2022-11-12T21:48:10.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-05T13:22:04.000Z (7 months ago)
- Last Synced: 2024-04-13T21:01:29.741Z (7 months ago)
- Topics: dojs, javascript, mastodon, mastodon-client, ms-dos, retrocomputing
- Language: JavaScript
- Homepage:
- Size: 41.5 MB
- Stars: 289
- Watchers: 15
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DOStodon
This is the source of DOStodon, a Mastodon client for MS-DOS.
DOStodon is implemented in Javascript and relies on a yet unreleased version of [DOjS](https://github.com/SuperIlu/DOjS) to run.
# Quick start
- **You need a VM, real HW or DOSBox-staging with a network card and a matching packet driver to use it.**
- **A Pentium 133 or faster with at least 32MiB of RAM is recommended.**
- **Packet drivers can e.g. be found on [packetdriversdos.net](http://packetdriversdos.net/) (make sure to download the driver from the "PC/TCP PACKET DRIVERS" section) or on [crynwr.com](http://crynwr.com/drivers/) or [www.georgpotthast.de](http://www.georgpotthast.de/sioux/packet.htm)**
- **You don't need any TCP/IP stack, [Watt32](https://www.watt-32.net/) is compiled into the program and directly uses the packet driver**
- **Make sure you read the section about the limitations!**
- **see "DOSBox-staging config" below for an example config that works (for me) with DOSBox-staging**
Just [download](https://github.com/SuperIlu/DOStodon/archive/refs/heads/main.zip) the whole repository.
Help on this project is very much appreciated, contact me on [Twitter](https://twitter.com/dec_hl), [Mastodon](https://mastodon.social/@dec_hl) or in the [DOjS Discord](https://discord.gg/J7MUTap9fM) if you want to help or have questions...
## Linux version
There is a highly experimental Linux version of DOStodon included. It is based on [DOjS v1.12](https://github.com/SuperIlu/DOjS). You can try it at your own risk. You need to compile DOjS yourself, please look at [this instruction](https://github.com/SuperIlu/DOjS/blob/master/README_Linux.md) how to do that. Fullscreen mode does not get keyboard input on WSL2, you can switch to windowed mode by removing the `-u` option in `dostodon.sh`.
# Usage
## First start
Please run `DOStodon `
- `server`: the URL of the server you want to connect to (e.g. `mastodon.social` or `https://bitbang.social`). Can be with or without `https://` prefix.
- `email`: the email address used for registration (shown on the `Preferences -> Account` page in the web).
- `password`: Your server password. 2FA is not supported. Your password should not contain any non 7bit ASCII characters.
Example: `DOStodon mastodon.social [email protected] 123abcABC`
The access tokens are stored in `CREDS.JSN` if the login is successful.
## subsequent starts
Just run `DOStodon`.
## Proxy support
If you want DOStodon to use a proxy you have to set the following ENV variables:
- `PROXY_HOST`: HTTP proxy to use. The parameter should be a string holding the host name or dotted IP address. To specify port number in this string, append :[port] to the end of the host name. The proxy string may be prefixed with [protocol]:// since any such prefix will be ignored. The proxy's port number may optionally be specified with the separate function SetProxyPort().
- `PROXY_PORT`: Pass a port number with this option to set the proxy port to connect to unless it is specified in the proxy string using PROXY_HOST.
- `PROXY_TYPE`: set this to `SOCKS` to use a SOCKS proxy. If unset or set to anything else a HTTP proxy is asumed.
## NOISE.SYS
DOStodon supports NOISE.SYS, a MS-DOS random number generator. It can be obtained here: https://github.com/robrwo/noise.sys
## Keys
### Common
- `ESC`: Quit DOStodon
- `h/H/?/CTRL-H`: Help screen
- `F1`: Switch to home timeline
- `F2`: Switch to notifications
- `F3`: Switch to hashtag timeline
- `F4`: Switch to local timeline
- `F5`: Switch to global timeline
- `F6`: Switch to bookmarks list (last 40)
- `F7`: Switch to favourites list (last 40)
- `F10`: Switch to Toot composer
- `F11`: Info screen
- `F12`: Poll/Refresh home/notification timelines
- `UP/DOWN, Page UP/DOWN, HOME/END`: scroll entries in home/notifications
- `p`: Show profile of currently selected entry (for boosts the boosters profile)
- `P`: Show profile of currently selected entry (for boosts the original profile)
- `CTRL-S`: Save screenshot as PNG. Screenshots are numbered, starting with `1.PNG`.
- `CTRL-P`: Search for a user/profile. The profile is displayed when pressing `ENTER`.
- `CTRL-C`: Show config dialog
- `DEL`: close dialog
### Timelines
- `b`: Boost/reblog currently selected toot in home screen
- `B`: UN-Boost/reblog currently selected toot in home screen
- `f`: Favorite/like currently selected toot in home screen
- `F`: UN-Favorite/like currently selected toot in home screen
- `m`: Bookmark currently selected toot in home screen
- `M`: UN-Bookmark currently selected toot in home screen
- `R`/`r`: reply to selected toot in home screen
- `D`/`d`: Print JSON of selected toot in home screen to logfile
- `C`/`c`: Toggle toots with content warning
- `1..4`: show media attachment 1 to 4. Any key to close.
- `5`: show show YouTube preview image. Any key to close.
- `CTRL-1..4`: show image description of media attachment 1 to 4. Any key to close.
- `ENTER`: show thread view of current entry, `DEL` or `BACKSPACE` to return to timeline.
- `CTRL-B`: Toggle toots&boosts, boosts only, toots only
- `CTRL-M`: Toggle showing posts with media only
### Tag timeline
- `T`/`t`: change tag
- `ENTER`: confirm tag in tag editor
- `BACKSPACE`: delete character in tag editor
### Notifications
- `L`/`l` : Toggle showing of favorites
- `B`/`b` : Toggle showing of boosts
- `F`/`f` : Toggle showing of follows
- `M`/`m` : Toggle showing of mentions
- `O`/`o` : Toggle showing of other notifications
- `SPACE` : Reset all filters
### Editor
- `CTRL-ENTER`: Send toot in Toot editor
- `CTRL-P`: Open account search, ENTER puts the selected account into the toot
- `BACKSPACE`: delete character
- `DEL`: delete toot composer text and reply-to toot
- `TAB`: switch toot visibility between `public`, `unlisted`, `private` and `direct`.
- `INSERT`: Image selector for image attachments to the toot.
### Profile screen
- `ENTER`: close profile
- `f`: follow
- `F`: unfollow
- `b`: block
- `B`: unblock
- `m`: mute
- `M`: unmute
- `T`: Write toot to account
## General
- DOStodon is busy while the Mastodon logo is displayed in middle of the screen. Don't hit keys like crazy, every keypress will be queued :)
- DOStodon polls home/notifications every 5 minutes for new entries. Countdown is in the lower right corner.
- To add a content warning/spoiler to a toot start the toot with "cw:". The first line of the toot will be the content warning, all subsequent lines will be the body text of the toot.
- If you press DOWN on the last entry in home/notifications older entries are fetched.
- Favourite/boost/bookmark status ([FBM]) is displayed below the profile picture of each toot.
- The selected hashtag is displayed in the upper right corner of the hashtag timeline.
- When first selecting the hashtag timeline you have to enter a hashtag.
## Limitations
- 2FA is not supported right now!
- logging in with passwords that contain characters outside 7bit ASCII might not be possible
- HTTPS requests can take quite a lot of time, be patient!
- Can't play videos/audio
- Image attachements are just drawn at the upper left corner
- No support for HTML tags, they are (badly) filtered out
- No support for emojis (replaced by spaces)
- No support for characters like umlauts, etc.
- The toot composer only supports BACKSPACE, it is not a real text editor.
- You can only remove the whole editor content. You can't undo adding an image.
- You can only add ALT text for the last image added.
- Bookmarks and favourites do not support pagination (yet).
- **NO REAL TESTING/QUALITY ASSURANCE!** Folks, this is a **fun project**, if you need a production ready client contribute or use something real! If it works for you, it works, but don't blame me for broken commits or missing features...
# Hacking/contributions
The source is split into several files right now:
- `dstdn.js` the "application"
- `home.js` the home timeline
- `imgcache.js` image fetching/caching
- `info.js` info screen display
- `splash.js` splash screen
- `mstdn.js` contains the Mastodon REST API
- `notific.js` the notification timeline
- `profile.js` profile viewer
- `toot.js` toot creation
- `util.js` support code
- `dialogs.js` all input fields
- `filsel.js` image file selector
DOStodon is implemented using DOjS native API (no p5js emulation). Network operations block the input processing/rendering.
# DOSBox-staging config
I use [DOSBox Staging](https://github.com/dosbox-staging/dosbox-staging/releases/tag/v0.79.1) to test this version of DOStodon. A NE2000 packet driver can be found on [this](http://www.georgpotthast.de/sioux/packet.htm) page [here](http://www.georgpotthast.de/sioux/pktdrv/ne2000.zip).
**DO NOT use DOSBox-X right now, it has a known bug in file io which creates broken SQLite databases**
**DOSBox-staging has a problem with mouse support, thats why I disabled that in the example config!**
My `dosbox-staging.conf` looks like this:
```
[sdl]
capture_mouse = nomouse
[dosbox]
memsize = 64
[cpu]
cputype = pentium_slow
cycles = max
[ethernet]
ne2000 = true
nicbase = 300
nicirq = 3
macaddr = AC:DE:48:88:99:AA
[autoexec]
mount c E:\_DEVEL\GitHub\DOStodon
PATH=d:;%PATH%
c:
ne2000 0x60 3 0x300
```
# TODO
- Busy indicator is missing for some network operations
- Some network errors lead to an endless loop
- Color themes?
- invert timeline (oldest post on top)
- Fix bugs
- Have fun
# Changelog
## 20. October 2024
- Updated curl to 8.10.1
- Updated mbedTLS to 3.6.2
- Updated jpeg from 9e to 9f
- Updated SQLite to 3.46.1 (thanks to https://mastodon.social/@[email protected])
## 18. August 2024
- Fixed a small bug when viewing threads in notification screem.
- Implemented setting for CW toots (default collapsed or visible)
- Fixed date calculation
- Fixed an issue with image viewing
- Added help screen to toot editor
- Changed some colors for better contrast
- Updated curl to 8.9.1
- Added ALT text for image uploads
## 14. June 2024
- Updated curl to 8.8.0
- Updated mbedTLS to 3.6.0
- Added support for [NOISE.SYS](https://github.com/robrwo/noise.sys)
## 5. April 2024
- Updated curl to 8.7.1
- Updated mbedTLS to 2.28.8
- Updated zip to 0.3.2
## 01. February 2024
- Updated mbedTLS and cURL for the DOS version
- removed Linux binaries, added link to the compilation instructions of DOjS v1.12
## 26. January 2024
- Added Linux version for Ubuntu 20.04 and ArchLinux
## 16. January 2024
- Display votes with results in the notifications
- Improve single choice voting dialog
- Implemented multiple choice voting
## 13. January 2024
- Improved handling of Unicode characters (displaying German Umlauts and other diacritic characters)
- Finally display votes in the timeline
- Enable voting in single-choice votes (sorry, no multiple choice votes yet)
## 06. January 2024
- Updated curl to 8.5.0
- Updated mbedTLS to 2.28.6
- Updated zip to 0.3.1
- Added example proxy config to `DOSTODON.BAT``
## 16. Oktober 2023
- Some tiny fixes after helpful comments from @[email protected]
## 14. Oktober 2023
- Added webp image format
## 11. Oktober 2023
- Security update to curl 8.4.0 and mbedTLS 2.28.5
- Fixed tag selection in tag screen display
## 23. august 2023
- highlight DMs in timeline and notifications
- added visibility options to toot editor
- added visibility to toot display
## 05. august 2023
- Added proxy support through ENV variables
## 19. july 2023
- Updated DOjS to curl-8.2.0
## 8. july 2023
- fixed drive letter detection in the file selector
- file selector cursor start position is between drives and files now
- fixed 'parent' handling in file selector
- accept HTTP status 206 for home timeline
## 25. june 2023
- recompiled DOjS with GCC 12.2 and DJGPP CVS (fixes SSL/date bug _AGAIN_)
- added YouTube video preview
## 21. june 2023
- added image upload/attachment to toots
## 14. may 2023
- newly polled entries in home and notifications screens are now highlighted red
## 10. may 2023
- Fixed a bug with displaying boosted toots when they had a content warning
- Moved filter display in notifications to lower left
- Added filtering of Toot-types to timelines: boosts, original toots and media attachments
## 7. apr 2023
- Updated to DOjS 1.11alpha with mbedTLS 2.28.3 and curl 8.0.1
## 4. mar 2023
- view the timeline of an account by pressing `F3` on the profile screen
- updated DOjS, now using mbedTLS 2.28.2
## 4. feb 2023
- Help pages will now also be displayed when pressing `?`.
- Enabled auto_vacuum for SQLite image cache.
- Added rainbow colors to the thread view.
- Reduced indentation in thread view.
- Added highligting of "root" entry in thread view.
- You can now press `RETURN` in thread view to see details of displayed children.
- Added configuration dialog (press `CTRL-C`) and config saving to `CFG.JSN`.
- Changed some colors
- `CTRL-L` and `CTRL-W` to load/save the timeline position is still work in progress!
## 14. jan 2023
- Profile view now shows the header image as well
- You can toot to the profile owner now by pressing `T`
- DOStodon now returns to the calling screen after replying to a toot
- CTRL-P in the editor lets you search for an account
- Added "reply" marker `<`
- Improved thread view and search dialog
## 13. jan 2023
- Implemented indentation and lines for toot context view (threads)
## 12. jan 2023
- Toots and notifications now show the time in a more readable fashion as a relative time.
- Added type filter for notifications
## 8. jan 2023
- Updated DOjS, new curl, new jpeg decoder and bugfixes
- Tinkered a little bit on the splash screen
- You can now press `t` to select a hashtag from the current toot and display the hashtags timeline
- You can now press `F1`/`F2` in profile view to show a list of followers/following accounts.
## 7. jan 2023
- Added 'LOCKED' and 'BOT' info to profile screen.
- Used a smaller font for timeline timestamps and toot stats
- You can now search for a user (profile) by pressing `CTRL-P`
- Lots of small internal optimizations, especially text rendering
## 6. jan 2023
- New, experimental word wrapping algorithm with support for coloring hashtags and handles
## 1. jan 2023
- Reworked the "login" section in the README
- You can now save PNG screenshots using `CTRL-S`
## 29. Dec 2022
- Added scroll indicators `^` and `v` at the very right of the screen
- Added thread view for toots.
- Fixed bug with toggling content warnings on toots with no spoiler text
- Added image description viewing
- Added help screen when pressing `H`
## 28. Dec 2022
- Added local timeline
- Added global timeline
- Added hashtag timeline
- Added 'view bookmarks'
- Added 'view favorites'
- Added text input field
- Reworked sidebar
- Added auto refresh countdown
## 26. Dec 2022
- Fixed issue with the image cache
- Fixed issue with profile screen follow/block/mute function
- Fixed wrong sound being played
- Added Makefile to create DOSTODON.ZIP
## 22. Dec 2022
- Added follow/mute/block info to profile screen
- Added (un) follow/mute/block keys to profile screen (yet untested)
## 20. Dec 2022
- Updated README regarding DOSBox (switched from DOSBox-X to DOSBox-staging)
- Added UnBoost and UnFav
- Added Bookmarks
- Added boost/fav/bookmark markers
- Added splash screen
- Added SQLite based image cache. Images are deleted from cache after 28 days.
## 19. Dec 2022
- Updated README regarding DOSBox-X
- Added debug timestamp during startup
- Fixed 486 incompatibility (hopefully)
## 17. Dec 2022
- Switched compiler for DOjS from GCC 7.2.0 to 12.2.0
- Added UTC date of toots
## 15. Dec 2022
- Fixed a time() bug in DOjS and re-enabled certificate validation.
## 14. Dec 2022
- Switched from nanojpeg to libjpeg to be able to load progressive JPEGs
- Added toot stat display to home screen
## 13. Dec 2022
- Disabled TLS/SSL certificate verification for now. DOStodon is not able to verify the certificate of https://mastodon.social anymore and I need to dive deeper into the reason for that.
- Added Page UP/DOWN and HOME/END to home and notifications
- Added content warnings/spoilers to the toot composer
- Added fetching of older entries when viewing home/notifications
## 11. Dec 2022
- Fixed a memory corruption in DOjS
- Images are no longer saved into TMP files
- Images are now scaled to fit the screen when displayed
## 4. Dec 2022
- implemented LRU cache for images
- fixed some quirks with key handlings
- DOjS now uses cURL 7.86.0
## 2. Dec 2022
- Blurhash is now implemented in C
## 1. Dec 2022
- added `` for content warnings, you can toggle the toot with `C`
- added media indicator for non-images (e.g. ``)
## 30. Nov 2022
- added JS based blurhash
## 27. Nov 2022
- implemented connection reuse
- you can now reply to toots by pressing R
- you can now clear the toot-composer by pressing DEL
- improved display of boosted toots
- added sounds
## 26. Nov 2022
- DOjS now uses mbedTLS instead of OpenSSL
- changed display of user handles
- added info screen
- reworked Mastodon-API, prepared it to re-use cURL objects (doesn't work yet)
- now shows a busy indicator when fetchingt iages during scrolling
- disabled alpha channel to speed up rendering
## 18. Nov 2022
- code cleanup
- several fixes all over the place
- added splash screen
- added entry scrolling
- added manual reload with F5
- changed polling time from 1min to 5min
- added profile viewer
- added media preview
- added media showing
- added liking
- added boosting
- added "busy" indicator
## 16. Nov 2022
- added some help in README.md
- first working version
## 14. Nov 2022
- first public release
- didn't work