XEChat-Idea

基于Netty的IDEA即时聊天插件：让你能够在IDEA里实现聊天、下棋、斗地主！

项目介绍

主要功能：

即时聊天
游戏对战
待探索...

目前已实现：

五子棋（支持2人联机、人机对战，内置"人工制杖"）
斗地主（支持2~3人联机、人机对战）
阅读（作者 @MINIPuffer ，感谢PR😊）

项目结构

.
├── LICENSE
├── README.md
├── xechat-commons //公共模块
│   ├── pom.xml
│   └── src
├── xechat-plugin //IDEA插件端
│   ├── build.gradle
│   ├── gradle
│   ├── gradle.properties
│   ├── gradlew
│   ├── gradlew.bat
│   ├── settings.gradle
│   └── src
└── xechat-server //服务端
    ├── pom.xml
    └── src

项目环境

服务端 & 公共模块

JDK8
Maven 3.6.x

IDEA 插件端

JDK11
Gradle 6.x

项目开发

运行 & 部署

提醒：公共模块需优先打包

# 进入公共模块根目录
cd xechat-commons
# 打包到本地仓库
mvn install

服务端

创建或调整日志目录 src/main/resources/logback.xml

<property name="ROOT_LOG_PATH" value="/var/log/xechat-server"/>

运行

直接运行主方法 XEChatServer.java

部署

# 进入服务端根目录
cd xechat-server
# 打包
mvn package
# 启动服务端
java -jar target/xechat-server-xxx.jar

启动参数：

设置端口：-p {端口号}
设置敏感词文件：-swfile {文件路径}

参考示例：

java -jar target/xechat-server-xxx.jar -p 1024 -swfile /Users/anlingyi/local/test/words.txt

敏感词相关配置参考

IDEA插件端

修改IDEA版本

修改 build.gradle 配置文件，将 IDEA 版本号改为你想使用的版本

intellij {
    version '2021.2'
}

本地运行

Tasks > intellij > runIde

插件部署

提醒：修改服务端地址

进入到 cn.xeblog.plugin.client.XEChatClient ，修改以下变量值

    private static final String HOST = "localhost"; // 服务端IP
    private static final int PORT = 1024; // 服务端端口

打包

Tasks > build > assemble

打包完成后的文件 build/distributions/xechat-plugin-xxx.zip

安装

IDEA > Preferences > Plugins

选择打包后的文件安装 build/distributions/xechat-plugin-xxx.zip

安装体验

添加插件库 Plugins > 设置按钮 > Manage Plugin Repositories...

http://plugins.xeblog.cn

搜索 “xechat” 安装

如有条件，还请自行部署服务端。

Docker部署

感谢 @猎隼丶止戈对此部分做的贡献 😊

镜像打包

FROM openjdk:8-jre-slim
MAINTAINER "安凌毅 https://xeblog.cn"

ENV JAVA_OPTS=""
ENV PARAMS="-p 1024"
ENV TZ="Asia/Shanghai"

EXPOSE 1024

RUN ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone
ADD server.jar /home/xechat/server.jar

WORKDIR /home/xechat/

CMD java -jar JrebelBrains.jar -p $OPTIONS
ENTRYPOINT ["sh","-c","java -jar $JAVA_OPTS server.jar $PARAMS"]

运行

不想自己打包可下载第三方镜像。https://hub.docker.com/r/nn200433/xechat

# 下载镜像，一定要指定版本
docker pull nn200433/xechat:1.5.8-beta

# 运行
docker run -itd -p 1024:1024 --restart=always --name=xechat nn200433/xechat:1.5.8-beta

docker-compose.yml 方式：

version: '3'
services:
  xechat:
    image: nn200433/xechat:1.5.8-beta
    container_name: xechat
    restart: always
    ports:
      - 1024:1024
    volumes: 
      - /home/xechat/logs:/home/xechat/logs

插件编译请参考上方文档

学习交流

感谢 @鹿儿岛提供的QQ交流群 😊

如果大家对这个项目感兴趣，欢迎加入我们的交流群🎉

QQ群：754126966

EscapeeX / xechat-idea