xechat idea

XEChat-Idea

Version 1.6.7-beta0

IDEA live chat plug-in based on Netty: allows you to realize chat, play chess, and fight landlords in IDEA! (In theory, support the JetBrains full range of development tools?)

Browser side: XEChat-Web

• Table of contents
  • Project Introduction
    • Project structure
    • Project environment
    • Project development
  • Run & Deploy
    • Server side
      • run
      • deploy
    • IDEA plug-in
      • Modify IDEA version
      • Run locally
      • Plug-in deployment
  • Installation experience
  • Docker runs
  • Disclose your fish pond
  • Learning and Communication

Project Introduction

Main functions:

• Live chat
• Game battles
• To be explored...

Currently implemented:

Games

• Gozi Chess (supports 2-person online and human-computer battles, with built-in "artificial staff")
• Landlord (supports 2~3 people online and human-machine battles)
• Don't eat snakes
• 2048 (Author @光海有海有有有有有有有有有有有有有有有有有有有有有有有有有有有有有有有有有有有
• Sudoku (author @Speciallei, thanks PR?)
• Push the box (author @Speciallei, thanks PR?)
• Chinese chess (supports 2-person online and human-computer battles, author @15738383930, thanks to PR?)
• Tetris (author @SherlockerSun, thanks PR?)
• Minesweeping (author @SherlockerSun, thanks PR?)

Tools

• Read (Author @MINIPuffer, thanks PR?)
• Weather inquiry (Author @河光世界, thanks PR?)
• Browser

learn more...

Project structure

 .
├── 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

Project environment

Server & Public Modules

• JDK8
• Maven 3.6.x

IDEA plug-in

• JDK11
• Gradle 6.x

Project development

• Implement a custom command
• Implement a custom message
• Implement an online battle game
• WebSocket protocol access document

Run & Deploy

Reminder: Public modules need to be packaged first

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

Server side

Create or adjust the log directory src/main/resources/logback.xml

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

run

Run the main method XEChatServer.java directly

deploy

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

Startup parameters:

• Set the port : -p {端口号}
• Set sensitive word file : -swfile {文件路径}
• Set up the windy weather : -weather {和风api key}
• Set Baidu Translation : -fyAppId {appId} -fyAppKey {appKey}
• Set the ip2region file : -ipfile {文件路径}
• Set the administrator token : -token {令牌}
• Specify external configuration file : -path {文件路径}
• Open WS protocol : -enableWS {true|false}

For specific external configuration file information, please refer to: xechat-server/src/main/resources/config.setting

Reference example:

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

Reference for sensitive word related configuration

Reference for configurations related to wind weather

Open WS protocol related configuration reference

IDEA plug-in

Modify IDEA version

Modify the build.gradle configuration file and change the IDEA version number to the version you want to use (only for the development and debugging stage)

 intellij {
    version '2021.3'
}

Run locally

Tasks > intellij > runIde

Plug-in deployment

Reminder: Modify the server address

Enter cn.xeblog.plugin.client.XEChatClient and modify the following variable values

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

Pack

Tasks > build > assemble

The file after packaging build/distributions/xechat-plugin-xxx.zip

Install

IDEA > Preferences > Plugins

Select the packaged file to install build/distributions/xechat-plugin-xxx.zip

Installation experience

Add Plugin Library Plugins > 设置按钮> Manage Plugin Repositories...

 http://plugins.xeblog.cn

Search for "xechat" to install

If possible, please deploy the server yourself.

Docker runs

Thank you @小小小小小小小小小 for your contribution to this part?

Mirror address: https://hub.docker.com/r/anlingyi/xecat-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 

Disclose your fish pond

If you want to disclose your fish pond, please edit the server_list.json file in the project, add your fish pond information, and submit the PR here, and wait for us to review and pass.

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

Learning and Communication

Thanks to @Kagoshima for providing the QQ communication group?

If you are interested in this project, please join our communication group?

• QQ group: 754126966