# xLand

**Repository Path**: dreamworldhost/xLand

## Basic Information

- **Project Name**: xLand
- **Description**: No description available
- **Primary Language**: C++
- **License**: CC0-1.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2024-03-06
- **Last Updated**: 2024-04-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# xLand

xdreamLand
筱梦领地插件

## 前置
- 请先确保已安装以下插件
- [LegacyMoney](https://github.com/LiteLDev/LegacyMoney)
- [GMLib](https://github.com/GroupMountain/GMLIB)
- [ParticleAPI](https://github.com/LiteLDev/LegacyParticleAPI) 如果你希望显示领地的边界，请仔细浏览这个

## 如何安装插件？

## 如何使用？
- 通过指令 /xland 打开GUI表单

## API服务器
- 插件加载完成后会在控制台输出如 “INFO [XLand] API服务器已部署到 http://192.168.43.12:8080” 字样
- 通过输出的网址 （以下简称 URL）,我们可访问配置文件中 WebPath 路径下的静态网页 （目前没做）管理领地数据
- 后台API如下
- URL/land/list       --列出所有领地
- URL/search/{value}  --按关键字 {value} 搜索领地

## 配置文件解释
```json
{
    "version": 1,                           // 配置文件版本
    "ratioPopulation": 0.5,                 // 人口倍率，用于计算 保护费
    "ratioArea": 0.5,                       // 面积倍率，用于计算 领地费用 或 保护费 
    "maxDebt": 90,                          // 最大债务，领地欠债超过则失去保护
    "loop": 1000,                           // 全局计时器循环间隔时长
    "port": 8080,                           // API服务器端口
    "maxLandNum": 10,                       // 用户最大能拥有的领地数量
    "tpLandRange": 10,                      // 传送到领地时的浮动范围
    "DBPath": "./plugins/XDream/DB/",       // 领地数据库的路径
    "WebPath": "./plugins/XDream/Web",      // API前端路径 （前端还没写，访问404）
    "occupyMode": "2D",                     // 占领模式 （建议2D）
    "occupyItem": "wooden_axe",             // 占领选点工具
    // 以下内容不建议修改，除非你知道你在做什么
    "messType": [                           // 发送消息的列表
        "留言",
        "入驻申请"
    ],
    "useItems": [                           // 可操作的物品列表
        "不操作",
        "全部允许",
        "全部禁用",
        "弩",
        // ...
    ],
    "useBlocks": [                          // 可交互的方块列表
        "不操作",
        "全部允许",
        "全部禁用",
        "熔炉",
        // ...
    ],
    "useEntitys": [                         // 可交互的实体列表
        "不操作",
        "全部允许",
        "全部禁用",
        // ...
    ],
    "itemRealType": {                       // 消息类型ID翻译
        "入驻申请": 1,
        "留言": 0
    },
    "itemRealName": {                       // 项目真名翻译
        "TNT": "tnt",
        "三叉戟": "thrown_trident",
        "不操作": "null",
        // ...
    }
}
```

## 插件截图
<details>
  <summary>点击展开/折叠</summary>
  <img src="img/addland.png"    alt="图片">
  <img src="img/sendmess.png"   alt="图片">
  <img src="img/lookmess.png"   alt="图片">
  <img src="img/1000004602.png" alt="图片">
  <img src="img/1000004598.png" alt="图片">
  <img src="img/1000004600.png" alt="图片">
  <img src="img/image.png" alt="图片">
</details>

## 指令语法
    `
    * PS: -非必填 | ！管理员 | <>变参 |
    *
    * xland start | stop                        // 开始占领模式 | 停止占领模式
    * xland setPt1|setPt2    -<Vec3>            // 选择占领对角点
    * xland buy                                 // 购买领地
    * xland list  -!<player>                    // 列出自己的所有领地 | !列出相应玩家的所有领地
    * xland remove  <landId>                    // 移除领地
    * xland tp      <landId>                    // 传送到领地
    * xland set     <landId>  <player> <json>   // 设置玩家在该领地的权限
    * xland set     <landId>  <json>            // 设置领地默认权限
    `

# 开发者须知

## 第三方库
- libhv 用于API服务器
- sqlite 用于存储领地数据

## 原理

## 命名空间 
- Util
- XLand
- LandPerm
- PlayerDate