# retro-aim-server **Repository Path**: Spz2022/retro-aim-server ## Basic Information - **Project Name**: retro-aim-server - **Description**: .......... - **Primary Language**: Go - **License**: MIT - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2024-12-24 - **Last Updated**: 2025-09-01 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # Retro AIM Server
[![codecov](https://codecov.io/gh/mk6i/retro-aim-server/graph/badge.svg?token=MATKPP77JT)](https://codecov.io/gh/mk6i/retro-aim-server) [![Discord](https://img.shields.io/discord/1238648671348719626?logo=discord&logoColor=white)](https://discord.gg/2Xy4nF3Uh9)
**Retro AIM Server** is an open-source instant messaging server that makes classic AIM and ICQ clients work again.

screenshot of retro aim server running next to AIM

| Disclaimer | |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | This project is an independent, open-source initiative and is not affiliated with, endorsed by, or associated with AOL or Yahoo! Inc. This project is entirely non-commercial and does not generate any revenue or accept donations. | The following features are supported: **AIM** - [x] Windows AIM Clients: [v1.x-v5.x](./docs/CLIENT.md), [v6.x-v7.x](docs/AIM_6_7.md) - [x] Away Messages - [x] Buddy Icons (v4.x, v5.x) - [x] Buddy List - [x] Chat Rooms - [x] Public & Private Chat Exchanges - [x] Instant Messaging - [x] User Profiles - [x] Privacy (allow or block specific users) - [x] Warning - [x] User Directory Search - [x] TOC Protocol Clients: Quick Buddy, gaim, [TiK](./docs/CLIENT_TIK.md) - [x] File Sharing - LAN Only: Direct Connect, Get File - Lan/Internet: [Send File](./docs/RENDEZVOUS.md) **ICQ** - [x] Windows ICQ Clients: 2000b (more to come soon) - [x] Instant Messaging - [x] Profiles - [x] User Search - [x] Presence Statuses - [x] Offline Messaging ## 🏁 How to Run Get up and running with Retro AIM Server using one of these handy server quickstart guides: * [Linux (x86_64)](./docs/LINUX.md) * [macOS (Intel and Apple Silicon)](./docs/MACOS.md) * [Windows 10/11 (x86_64)](./docs/WINDOWS.md) Don't have AIM installed yet? Check out the [AIM Client Setup Guide](./docs/CLIENT.md). ...how about ICQ? Check out the [ICQ Client Setup Guide](./docs/CLIENT_ICQ.md). ## 🛠️ Development This project is under active development. Contributions are welcome! Follow [this guide](./docs/BUILD.md) to learn how to compile and run Retro AIM Server. ## 🌍 Community Check out the Retro AIM Server [Discord server](https://discord.gg/2Xy4nF3Uh9) to get help or find out how to get involved. ## 👤 Management API The Management API provides functionality for administering the server (see [OpenAPI spec](./api.yml)). The following shows you how to run these commands via the command line. ### Windows PowerShell > Run these commands from **PowerShell**, *not* **Command Prompt**. #### List Users ```powershell Invoke-WebRequest -Uri http://localhost:8080/user -Method Get ``` #### Create Users ```powershell Invoke-WebRequest -Uri http://localhost:8080/user ` -Body '{"screen_name":"MyScreenName", "password":"thepassword"}' ` -Method Post ` -ContentType "application/json" ``` #### Delete Users ```powershell Invoke-WebRequest -Uri http://localhost:8080/user ` -Body '{"screen_name": "user123"}' ` -Method Delete ` -ContentType "application/json" ``` #### Change Password ```powershell Invoke-WebRequest -Uri http://localhost:8080/user/password ` -Body '{"screen_name":"MyScreenName", "password":"thenewpassword"}' ` -Method Put ` -ContentType "application/json" ``` #### List Active Sessions This request lists sessions for all logged in users. ```powershell Invoke-WebRequest -Uri http://localhost:8080/session -Method Get ``` #### Create Public Chat Room ```powershell Invoke-WebRequest -Uri http://localhost:8080/chat/room/public ` -Body '{"name":"Office Hijinks"}' ` -Method Post ` -ContentType "application/json" ``` #### List Public Chat Rooms ```powershell Invoke-WebRequest -Uri http://localhost:8080/chat/room/public -Method Get ``` ### macOS / Linux / FreeBSD #### List Users ```shell curl http://localhost:8080/user ``` #### Create Users ##### AIM ```shell curl -d'{"screen_name":"MyScreenName", "password":"thepassword"}' http://localhost:8080/user ``` ##### ICQ ```shell curl -d'{"screen_name":"100003", "password":"thepassw"}' http://localhost:8080/user ``` #### Delete Users ```shell curl -X DELETE -d '{"screen_name": "user123"}' http://localhost:8080/user ``` #### Change Password ```shell curl -X PUT -d'{"screen_name":"MyScreenName", "password":"thenewpassword"}' http://localhost:8080/user/password ``` #### List Active Sessions This request lists sessions for all logged in users. ```shell curl http://localhost:8080/session ``` #### Create Public Chat Room ```shell curl -d'{"name":"Office Hijinks"}' http://localhost:8080/chat/room/public ``` #### List Public Chat Rooms ```shell curl http://localhost:8080/chat/room/public ``` ## 🔗 Acknowledgements - [aim-oscar-server](https://github.com/ox/aim-oscar-server) is another cool open source AIM server project. - [NINA Wiki](https://wiki.nina.chat/wiki/Main_Page) is an indispensable source for figuring out the OSCAR API. - [libpurple](https://developer.pidgin.im/wiki/WhatIsLibpurple) is also an invaluable OSCAR reference (especially version [2.10.6-1](https://github.com/Tasssadar/libpurple)). ## 📄 License Retro AIM Server is licensed under the [MIT license](./LICENSE).