crossoverJie/cim is tracked by TopGit as an open-source project, with 9.5k stars on GitHub, written primarily in Java. 📲cim(cross IM) 适用于开发者的分布式即时通讯系统
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
Support single node startup(Contains no components).
Third-party components support replacement(Redis/Zookeeper, etc.).
Support web client(websocket).
Support docker container.
Support kubernetes operation.
Supports binary client(build with golang).
Introduction
CIM(CROSS-IM) is an IM (instant messaging) system for developers; it also provides some components to help developers build their own scalable IM.
Using CIM, you can achieve the following requirements:
IM instant messaging system.
Message push middleware for APP.
Message middleware for IOT massive connection scenarios.
If you have any questions during use or development, you can contact the author.
Video Demo
Click the links below to watch the video demo.
YouTube
Bilibili
Group Chat Private Chat
Group Chat Private Chat
TODO LIST
Group Chat
Private Chat
Built-in Commands
Chat History Query
AI Mode
Efficient encoding/decoding with Google Protocol Buffer
Flexible horizontal scaling based on actual needs
Server-side automatic removal of offline clients
Client automatic reconnection
Delayed Messages
SDK development package
Group categorization
Offline messages
Message encryption
Architecture
Each component in CIM is built using SpringBoot
Client build with cim-client-sdk
Use Netty to build the underlying communication.
MetaStore is used for registration and discovery of IM-server services.
cim-server
IM server is used to receive client connections, message forwarding, message push, etc.
Support cluster deployment.
cim-route
Route server; used to process message routing, message forwarding, user login, user offline, and some operation tools (get the number of online users, etc.).
cim-client
IM client terminal, a command can be started and initiated to communicate with others (group chat, private chat).
Flow Chart
Server register to MetaStore
Route subscribe MetaStore
Client login to Route
Route get Server info from MetaStore
Client open connection to Server
Client1 send message to Route
Route select Server and forward message to Server
Server push message to Client2
Quick Start
Docker
The allin1 image comes with Zookeeper, Redis, cim-server, and cim-forward-route pre-installed, all managed by Supervisor for an out-of-the-box experience.
# Start local client
cp /cim/cim-client/target/cim-client-1.0.0-SNAPSHOT.jar /xx/work/route0/
cd /xx/work/route0/
java -jar cim-client-1.0.0-SNAPSHOT.jar --server.port=8084 --cim.user.id=<userId-from-above> --cim.user.userName=<username> --cim.route.url=http://<route-server>:8083/
Built-in Commands
Command
Description
:q!
Quit the client
:olu
List all online users
:all
Show all available commands
:q [keyword]
Search chat history by keyword
:ai
Enable AI mode
:qai
Disable AI mode
:pu
Fuzzy search users
:info
Show client information
:emoji [option]
Browse emoji list [option: page number]
:delay [msg] [delayTime]
Send a delayed message
:
More commands are under development...
Chat History Query
Use the command :q keyword to search chat history related to you.
Client chat history is stored in /opt/logs/cim/ by default, so write permission is required for this directory. You can also customize the directory by adding --cim.msg.logger.path=/custom/path to the startup command.
AI Mode
Use the command :ai to enable AI mode. After that, all messages will be responded to by AI.
Use :qai to exit AI mode.
Prefix Match Username
Use the command :qu prefix to search user information by prefix.
This feature is primarily designed for searching users in input fields on mobile clients.
Group Chat/Private Chat
Group Chat
For group chat, simply type a message in the console and press Enter to send. All online clients will receive the message.
Private Chat
To send a private message, you need to know the recipient's userID.
Use the command :olu to list all online users.
Then use the format userId;;message content to send a private message.
Meanwhile, the other account will not receive the message.
Emoji Support
Use the command :emoji 1 to list all available emojis. Use the emoji alias to send an emoji.
Delayed Messages
Send a message with a 10-second delay:
:delay delayMsg 10
Contact
Contributing
We welcome contributions! Before submitting a PR, please ensure your code passes the Checkstyle check.
Code Style
This project uses Checkstyle to enforce code style. The rules are defined in checkstyle/checkstyle.xml.
Run Checkstyle locally before committing:
mvn checkstyle:check
Key rules:
Use spaces around {, }, and operators
No trailing whitespace
Files must end with a newline
Remove unused imports
Constants (static final) must be UPPER_SNAKE_CASE
Use Java-style array declarations: String[] args (not String args[])
The most recent commit recorded on crossoverJie/cim was 7 months ago, based on the GitHub push timestamp. The repository has 2.9k forks — one of the better signals of community interest.
How many stars does crossoverJie/cim have?
crossoverJie/cim has 9.5k GitHub stars — refresh the page for the live number, or check github.com/crossoverJie/cim. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
Is crossoverJie/cim open source?
Yes — crossoverJie/cim ships under the MIT license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/crossoverJie/cim.
What is crossoverJie/cim?
crossoverJie/cim (crossoverJie/cim) is a Java project on GitHub. From the project's own README: 📲cim(cross IM) 适用于开发者的分布式即时通讯系统
Where do I read more about crossoverJie/cim?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/crossoverJie/cim is the definitive source.
Read full README in the tab above.
Want a second opinion on cim?
Ask an AI that can read this page — one click and you get its take on cim.