Open OSCAR Server
Open OSCAR Server is an open-source instant messaging server compatible with classic AIM and ICQ clients written in golang.
Above: Pidgin IM connected to Open OSCAR Server
| 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, v6.x-v7.x
- 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
- TOC1 Protocol Clients: Quick Buddy, gaim, TiK
- TOC2 Protocol Clients: vAIM, Miranda ~v0.4.0.3, iEM 1.0.1
- File Sharing
- LAN Only: Direct Connect, Get File
- Lan/Internet: Send File
ICQ
- Windows ICQ Clients: 98x, 99x, 2000x, 2001x, 2002x, 2003x, 4, 5
- Instant Messaging
- Profiles
- User Search
- Presence Statuses
- Offline Messaging
🏁 How to Run
Get up and running with Open OSCAR Server using one of these handy server quickstart guides:
Don't have AIM installed yet? Check out the AIM Client Setup Guide.
...how about ICQ? Check out the ICQ Client Setup Guide.
🛠️ Development
This project is under active development. Contributions are welcome!
Follow this guide to learn how to compile and run Open OSCAR Server.
🌍 Community
Check out the Open OSCAR Server Discord server to get help or find out how to get involved.
Tooling Provided By
👤 Management API
The Management API provides functionality for administering the server (see OpenAPI spec). 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
Invoke-WebRequest -Uri http://localhost:8080/user -Method Get
Create Users
Invoke-WebRequest -Uri http://localhost:8080/user ` -Body '{"screen_name":"MyScreenName", "password":"thepassword"}' ` -Method Post ` -ContentType "application/json"
Delete Users
Invoke-WebRequest -Uri http://localhost:8080/user ` -Body '{"screen_name": "user123"}' ` -Method Delete ` -ContentType "application/json"
Change Password
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.
Invoke-WebRequest -Uri http://localhost:8080/session -Method Get
Create Public Chat Room
Invoke-WebRequest -Uri http://localhost:8080/chat/room/public ` -Body '{"name":"Office Hijinks"}' ` -Method Post ` -ContentType "application/json"
List Public Chat Rooms
Invoke-WebRequest -Uri http://localhost:8080/chat/room/public -Method Get
macOS / Linux / FreeBSD
List Users
curl http://localhost:8080/user
Create Users
AIM
curl -d'{"screen_name":"MyScreenName", "password":"thepassword"}' http://localhost:8080/userICQ
curl -d'{"screen_name":"100003", "password":"thepassw"}' http://localhost:8080/userDelete Users
curl -X DELETE -d '{"screen_name": "user123"}' http://localhost:8080/userChange Password
curl -X PUT -d'{"screen_name":"MyScreenName", "password":"thenewpassword"}' http://localhost:8080/user/passwordList Active Sessions
This request lists sessions for all logged in users.
curl http://localhost:8080/session
Create Public Chat Room
curl -d'{"name":"Office Hijinks"}' http://localhost:8080/chat/room/publicList Public Chat Rooms
curl http://localhost:8080/chat/room/public
📄 License
Open OSCAR Server is licensed under the MIT license.