xechat idea

XEChat-Idea

Version 1.6.7-beta0

基於Netty的IDEA即時聊天插件：讓你能夠在IDEA裡實現聊天、下棋、斗地主！ (理論上支持JetBrains全系列開發工具?)

瀏覽器端：XEChat-Web

• 目錄
  • 項目介紹
    • 項目結構
    • 項目環境
    • 項目開發
  • 運行& 部署
    • 服務端
      • 運行
      • 部署
    • IDEA插件端
      • 修改IDEA版本
      • 本地運行
      • 插件部署
  • 安裝體驗
  • Docker運行
  • 公開你的魚塘
  • 學習交流

項目介紹

主要功能：

• 即時聊天
• 遊戲對戰
• 待探索...

目前已實現：

遊戲類

• 五子棋（支持2人聯機、人機對戰，內置"人工製杖"）
• 斗地主（支持2~3人聯機、人機對戰）
• 不貪吃蛇
• 2048（作者@濃睡不消殘酒，感謝PR?）
• 數獨（作者@Speciallei ，感謝PR?）
• 推箱子（作者@Speciallei ，感謝PR?）
• 中國象棋（支持2人聯機、人機對戰，作者@15738383930 ，感謝PR?）
• 俄羅斯方塊（作者@SherlockerSun ，感謝PR?）
• 掃雷（作者@SherlockerSun ，感謝PR?）

工具類

• 閱讀（作者@MINIPuffer ，感謝PR?）
• 天氣查詢（作者@獵隼丶止戈，感謝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

項目開發

• 實現一個自定義命令
• 實現一個自定義消息
• 實現一個聯機對戰遊戲
• WebSocket協議接入文檔

運行& 部署

提醒：公共模塊需優先打包

 # 进入公共模块根目录
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 {文件路径}
• 設置和風天氣： -weather {和风api key}
• 設置百度翻譯： -fyAppId {appId} -fyAppKey {appKey}
• 設置ip2region文件： -ipfile {文件路径}
• 設置管理員令牌： -token {令牌}
• 指定外部配置文件： -path {文件路径}
• 開放WS協議： -enableWS {true|false}

具體的外部配置文件信息請看： xechat-server/src/main/resources/config.setting

參考示例：

 java -jar target/xechat-server-xxx.jar -p 1024 -swfile /Users/anlingyi/local/test/words.txt -weather {和风天气api key}

敏感詞相關配置參考

和風天氣相關配置參考

開放WS協議相關配置參考

IDEA插件端

修改IDEA版本

修改build.gradle配置文件，將IDEA版本號改為你想使用的版本（僅限開發調試階段）

 intellij {
    version '2021.3'
}

本地運行

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運行

感謝@獵隼丶止戈對此部分做的貢獻?

鏡像地址：https://hub.docker.com/r/anlingyi/xechat-server/tags

docker-compose.yml

 version : ' 3 '
services :
  xechat :
    image : anlingyi/xechat-server:1.6.7-beta
    container_name : xechat-server
    restart : always
    ports :
      - 1024:1024
      - 1025:1025
    volumes :
      - /home/xechat/logs:/var/log/xechat-server
      - /home/xechat/config/config.setting:/home/xechat/config/config.setting
      - /home/xechat/db:/home/xechat/db 

公開你的魚塘

如果你想公開你的魚塘，請編輯項目中的server_list.json文件，添加上你的魚塘信息，然後提交PR到這裡，待我們審核通過後即可。

    {
        "name" : " xxx " , //鱼塘名
        "ip" : " 127.0.0.1 " , //你的服务器IP或域名
        "port" : 1024 //端口号
    }

學習交流

感謝@鹿兒島提供的QQ交流群?

如果大家對這個項目感興趣，歡迎加入我們的交流群?

• QQ群：754126966