Skip to content
<awesome-gh-repos>
vic

mk6i/open-oscar-server

Self-hostable instant messaging server compatible with classic AIM and ICQ clients. (Independently developed, not affiliated with or endorsed by AOL) Formerly known as Retro AIM Server.
Source code at GitHub https://discord.gg/2Xy4nF3Uh9
mk6i/open-oscar-server.json
{
  "createdAt": "2023-06-17T03:16:14Z",
  "defaultBranch": "main",
  "description": "Self-hostable instant messaging server compatible with classic AIM and ICQ clients. (Independently developed, not affiliated with or endorsed by AOL) Formerly known as Retro AIM Server.",
  "fullName": "mk6i/open-oscar-server",
  "homepage": "https://discord.gg/2Xy4nF3Uh9",
  "language": "Go",
  "name": "open-oscar-server",
  "pushedAt": "2025-11-20T05:01:09Z",
  "stargazersCount": 959,
  "topics": [
    "aim",
    "chat",
    "golang",
    "icq",
    "instant-messaging",
    "retrocomputing"
  ],
  "updatedAt": "2025-11-24T10:34:10Z",
  "url": "https://github.com/mk6i/open-oscar-server"
}

Open OSCAR Server

Section titled “Open OSCAR Server”

codecov Discord

Open OSCAR Server (formerly known as Retro AIM Server) is an open-source instant messaging server compatible with classic AIM and ICQ clients.

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

  • Windows AIM Clients: [v1.x-v5.x]!(./docs/CLIENT.md), [v6.x-v7.x]!(docs/AIM_6_7.md)
  • Away Messages
  • Buddy Icons (v4.x, v5.x)
  • Buddy List
  • Chat Rooms
  • Public & Private Chat Exchanges
  • Instant Messaging
  • User Profiles
  • Privacy (allow or block specific users)
  • Warning
  • User Directory Search
  • TOC Protocol Clients: Quick Buddy, gaim, [TiK]!(./docs/CLIENT_TIK.md)
  • File Sharing
    • LAN Only: Direct Connect, Get File
    • Lan/Internet: [Send File]!(./docs/RENDEZVOUS.md)

ICQ

  • Windows ICQ Clients: 2000b (more to come soon)
  • Instant Messaging
  • Profiles
  • User Search
  • Presence Statuses
  • Offline Messaging

🏁 How to Run

Section titled “🏁 How to Run”

Get up and running with Open OSCAR 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

Section titled “🛠️ Development”

This project is under active development. Contributions are welcome!

Follow [this guide]!(./docs/BUILD.md) to learn how to compile and run Open OSCAR Server.

🌍 Community

Section titled “🌍 Community”

Check out the Open OSCAR Server Discord server to get help or find out how to get involved.

👤 Management API

Section titled “👤 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

Section titled “Windows PowerShell”

Run these commands from PowerShell, not Command Prompt.

List Users

Section titled “List Users”
Terminal window
Invoke-WebRequest -Uri http://localhost:8080/user -Method Get

Create Users

Section titled “Create Users”
Terminal window
Invoke-WebRequest -Uri http://localhost:8080/user `
  -Body '{"screen_name":"MyScreenName", "password":"thepassword"}' `
  -Method Post `
  -ContentType "application/json"

Delete Users

Section titled “Delete Users”
Terminal window
Invoke-WebRequest -Uri http://localhost:8080/user `
  -Body '{"screen_name": "user123"}' `
  -Method Delete `
  -ContentType "application/json"

Change Password

Section titled “Change Password”
Terminal window
Invoke-WebRequest -Uri http://localhost:8080/user/password `
  -Body '{"screen_name":"MyScreenName", "password":"thenewpassword"}' `
  -Method Put `
  -ContentType "application/json"

List Active Sessions

Section titled “List Active Sessions”

This request lists sessions for all logged in users.

Terminal window
Invoke-WebRequest -Uri http://localhost:8080/session -Method Get

Create Public Chat Room

Section titled “Create Public Chat Room”
Terminal window
Invoke-WebRequest -Uri http://localhost:8080/chat/room/public `
  -Body '{"name":"Office Hijinks"}' `
  -Method Post `
  -ContentType "application/json"

List Public Chat Rooms

Section titled “List Public Chat Rooms”
Terminal window
Invoke-WebRequest -Uri http://localhost:8080/chat/room/public -Method Get

macOS / Linux / FreeBSD

Section titled “macOS / Linux / FreeBSD”

List Users

Section titled “List Users”
Terminal window
curl http://localhost:8080/user

Create Users

Section titled “Create Users”
AIM
Section titled “AIM”
Terminal window
curl -d'{"screen_name":"MyScreenName", "password":"thepassword"}' http://localhost:8080/user
ICQ
Section titled “ICQ”
Terminal window
curl -d'{"screen_name":"100003", "password":"thepassw"}' http://localhost:8080/user

Delete Users

Section titled “Delete Users”
Terminal window
curl -X DELETE -d '{"screen_name": "user123"}' http://localhost:8080/user

Change Password

Section titled “Change Password”
Terminal window
curl -X PUT -d'{"screen_name":"MyScreenName", "password":"thenewpassword"}' http://localhost:8080/user/password

List Active Sessions

Section titled “List Active Sessions”

This request lists sessions for all logged in users.

Terminal window
curl http://localhost:8080/session

Create Public Chat Room

Section titled “Create Public Chat Room”
Terminal window
curl -d'{"name":"Office Hijinks"}' http://localhost:8080/chat/room/public

List Public Chat Rooms

Section titled “List Public Chat Rooms”
Terminal window
curl http://localhost:8080/chat/room/public

🔗 Acknowledgements

Section titled “🔗 Acknowledgements”
  • aim-oscar-server is another cool open source AIM server project.
  • NINA Wiki is an indispensable source for figuring out the OSCAR API.
  • libpurple is also an invaluable OSCAR reference (especially version 2.10.6-1).

📄 License

Section titled “📄 License”

Open OSCAR Server is licensed under the [MIT license]!(./LICENSE).