MessagesForMacintosh/README.md

36 lines
3.4 KiB
Markdown
Raw Permalink Normal View History

2021-09-11 06:16:21 +00:00
# Messages For Macintosh
2022-02-12 00:50:07 +00:00
Messages for Macintosh is a software suite for classic Macintosh (System 2.0 through MacOS 9.2.2) systems to interoperate with Apple iMessages via a familiar interface, with [supporting software](https://github.com/CamHenlin/imessagegraphqlserver) running on a newer Mac computer.
2022-02-12 00:41:45 +00:00
2022-02-24 06:05:03 +00:00
![messages for macintosh](https://henlin.net/images/messagesformacintosh.png)
2022-02-12 00:41:45 +00:00
2022-02-12 00:53:37 +00:00
## How to use Messages for Macintosh
There are two setup guides for Messages for Macintosh:
2022-02-27 07:51:37 +00:00
- [the user-facing setup guide](https://henlin.net/2022/02/26/Introducing-Messages-for-Macintosh/), for users not interested in exploring the development workflow. This is the article you want if you just want to use your old Mac to chat.
- [the developer-facing setup guide](https://henlin.net/2022/02/26/Messages-for-Macintosh-Developer-Guide/), which explains how to set Messages for Macintosh up in such a way that you can make modifications to its different pieces
2022-02-12 00:53:37 +00:00
2022-02-12 00:41:45 +00:00
## Technologies
Messages for Macintosh is built on a lot of technologies. The READMEs of each of these is each worth familiarizing yourself with if you would like to contribute to Messages for Macintosh:
- [Retro68](https://github.com/autc04/Retro68) - a GCC-based cross compilation env for classic Macintosh systems
2022-02-24 06:07:39 +00:00
- [Nuklear Quickdraw](https://github.com/CamHenlin/nuklear-quickdraw) - a heavily modified, classic Macintosh-specific version of [Nuklear](https://github.com/Immediate-Mode-UI/Nuklear) allowing a simple way to provide GUI services
2022-02-26 07:46:19 +00:00
- [CoprocessorJS](https://github.com/CamHenlin/coprocessor.js) - a library that allows us to handle nodejs workloads sent over a serial port to talk to [supporting software](https://github.com/CamHenlin/imessagegraphqlserver)
2022-02-27 06:51:11 +00:00
- [serialperformanceanalyzer](https://github.com/CamHenlin/serialperformanceanalyzer) - used to analyze the performance of many different parts of the application during its development lifecycle
2022-02-12 00:41:45 +00:00
## Limitations / areas for improvement
2022-02-27 07:05:24 +00:00
Messages for Macintosh is not perfect, but it is usable. Here are some known limitations and things that could be improved:
2022-02-12 00:41:45 +00:00
2022-02-26 07:46:19 +00:00
- 10 conversations at a time, with the ability to open a new conversation if you know the recipient's address book entry. Nuklear supports scrolling and we could likely add more to the list, but the performance may begin degrading on 68000-based systems.
- Up to the most 15 recent messages are displayed in your selected chat. No pagination. Nuklear supports scrolling so we could add more messages, but again it may be slow on 68000-based systems if we do that
2022-02-12 00:41:45 +00:00
- No image / emoji support (although emojis are generally translated to text)
2022-02-27 06:51:11 +00:00
- Performance can still be improved. We set a good baseline here, but there is still more that can be done. There are lots of traces in the codebase supporting [serialperformanceanalyzer](https://github.com/CamHenlin/serialperformanceanalyzer) if someone would like to take a stab at further improving performance.
2022-02-27 07:04:18 +00:00
- All updates are based on polling and can sometimes be slow
2022-02-12 00:41:45 +00:00
## Pull requests and issues welcome
If you make any improvements or run into any issues, please feel free to bring them back to this repo with pull requests or issue reports. Both are welcome and will help Messages for Macintosh to be more useful in the future.
## Animated demo
Here is a short demo of the classic Mac app in operation:
![messages for macintosh demo animation](https://henlin.net/images/messagesformacdemo.gif)