# CustomSprays

**Repository Path**: pixelmc/CustomSprays

## Basic Information

- **Project Name**: CustomSprays
- **Description**: 让玩家在服务器"喷涂"自定义图片！
Let players "spray" custom pictures on your server!
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 13
- **Forks**: 0
- **Created**: 2021-12-05
- **Last Updated**: 2025-08-07

## Categories & Tags

**Categories**: game-dev

**Tags**: Spigot, Minecraft, 我的世界, Bukkit, 我的世界服务器

## README

![CustomSprays](media/banner.png)

# **CustomSprays** | 花样喷漆 🎉

> 👇**大概是一些用法 | bla bla usages**
> ![use](https://s1.ax1x.com/2022/04/18/Ldo6SK.gif)

## （＾∀＾●）ﾉｼ
![Visits](https://count.getloli.com/get/@CustomSprays?darkmode=0)  

## 📢 介绍 | Introduce
___

|          *Name*           | *Content*                                                |
|:-------------------------:|----------------------------------------------------------|
| ![logo](media/logo64.png) | CustomSprays <br> 花样喷漆                                   |
|      作者 <br> Author       | LSDog                                                    |
|      版本 <br> Version      | 1.5.20                                                   |
|      支持 <br> Support      | **1.7.10 ~ 1.21.8** (Bukkit Spigot Paper ...)            |
|        指令 <br> Cmd        | `/sprays` - 主命令 <br>`/spray` - 喷漆<br>`/spray big` - 喷大喷漆 |
|       权限 <br> Perm        | 请见 "config.yml" / see "config.yml"                       |
> 
> Links:
> [Modrinth](https://modrinth.com/plugin/customsprays)
> | [Spigot](https://www.spigotmc.org/resources/customsprays-upload-image-and-spray-it-on-the-wall.98979/)
> | [PlanetMinecraft](https://www.planetminecraft.com/mod/customsprays-spray-your-image-like-in-source-games/)

## ⏬ **下载 | Download** → [发布页 | Releases](https://github.com/LSDog/CustomSprays/releases) !!
(上面Github打不开? → [Gitee发布页](https://gitee.com/pixelmc/CustomSprays/releases))


**🎶 [喷漆音效资源包](https://github.com/LSDog/CustomSprays/blob/master/spray_sound_pack.zip?raw=true) / [Spray sound resource pack](https://github.com/LSDog/CustomSprays/blob/master/spray_sound_pack.zip?raw=true) !**

**⭐ [ItemsAdder 支持 | ItemsAdder Support](https://github.com/LSDog/CustomSprays/tree/itemsadder) ⭐**

**⭐ [oraxen 支持 | oraxen Support](https://github.com/LSDog/CustomSprays/tree/oraxen) ⭐**

**💬 English message config is also in config.yml (commented out by #)**



## ✨ 用法 | Usage
___
### 步骤

    1 | 将 CustomSprays.jar 放入 plugins 文件夹，重启服务器
      |
      | (现在去复制图片链接)
      |
    2 | 输入指令: /sprays upload <url>  -  上传图片
    3 | 输入指令: /spray                -  对着墙喷漆
      |
    4 | 🎇 如果服务器版本 ≥ 1.9，【快速双击F键】也可以喷漆！🎇

### Steps:

    1 | Put "CustomSprays.jar" in "plugins" folder，restart the server.
      |
      | (now get ur image link)
      |
    2 | Send command: /sprays upload <url>  -  Upload image
    3 | Send command: /spray                -  Spray at wall
      |
    4 | 🎇 If server version ≥ 1.9，【Quick double click "F"】can also spray！🎇



### 💻 更多指令发送 "/sprays" | Send "/sprays" for more commands  

### 💻 更多设置请见 "config.yml" | See "config.yml" for more configurations


## 🎮 版本支持 | Version Support
___

> 📏 支持的 **"领域"** 插件 | Supported **"region"** plugins:
> - [x] Residence .......... [ *?* ~ 5.0.1.3+ ]
> - [x] WorldGuard ......... [ 6.*?* ~ 7.*x* ]
> - [x] GriefDefender ...... [ *?* ~ 2.1.4+ ]
> 
> (理论上支持更新的版本 | newer versions should be ok)

## 🏆 特性 | Features
___

- 🙅‍ 无 Bungeecord 端插件，所有数据皆由 MySQL / yml 进行存储   
- 🙅‍ NO Bungeecord-side plugin，all the data storage in MySQL / yml  


- 📦 纯发包实现喷漆【避免交互 | 不生成垃圾】    
- 📦 100% use packets【no interact with spray | no junk generated】  


- 📐 限制喷漆的世界或区域！ 
- 📐 Disable spraying in specific worlds or regions! 


- 📺 自定义喷漆物品/音效！   
- 📺 Custom spray item / sound effect！ 


- 👋 复制别人的喷漆，或者禁止别人喷漆！
- 👋 Copy others spray or prevent others from copying yours!


- ☕ 无需前置API，发包纯手搓
- ☕ No API required ，making NMS sh-t by myself


- 🔗 玩家上传图片链接 >> 压缩存储图片 >> 喷漆后自动消失   
- 🔗 Player uploads link >> Zip & save image >> Spray self-destruct 


- 💴 或者使用 Vault 经济花钱喷漆！
- 💴 Or use Vault cost players money for spraying！


## ⚡ 注意事项 | Warning
___

> 🔺 已知问题 ***[仅限版本1.7~1.12]***：当某一世界地图数量 >32467 时 (最多为32767) 喷漆会导致某些原生地图被暂时替换  
> 🔺 Known problem ***[Only in version 1.7~1.12]***: When the map count is >32467 in a world (max 32767), spraying will make some original map replaced by spray image temporarily.
>
>> **原因:** 这些版本中插件使用 id [32467~32767] 对地图图案(MapView)进行标识，喷漆时对图案会被替换  
>> **Reason:** In these versions plugin uses id [32467~32767] to target the Mapview, so map with that id will be replaced.

## 💻 开发 | for Developers
___
### 你只需要...
- **1.9+ 服务端** 作为库 (推荐1.12.2)
- 直接构建！构建结果可用于全部适用版本
### You only need...
- **1.9+ server jar** as the library (1.12.2 recommended)
- Build the jar! the build results can be used for all applicable versions

## ✍ TODO
___
- [x] 左键喷漆删除喷漆 (因为不想用protocol lib所以需要研究手写pack listener)
- [ ] 自动获取NMS中用到的混淆名称，这样就不用随版本更新手动添加case了
- [x] 喷漆动画 (粒子效果；颜色可以与图像颜色稍微对应←貌似这一点做不到欸)
- [ ] folia 支持 (需要更多研究)
- [ ] 粒子喷漆 (用粒子效果组成图像)
- [ ] gif 动图支持 (需要更多研究)
- [ ] SQLite 支持
- [ ] 商店版 (购买预制的喷漆)
- [ ] 喷漆仓库，实际上跟上面这个设想有相通的地方，问题是如果单个玩家仓库过大加载单个玩家yaml时间会很长，所以应该要搞成分文件的，直接把384*384转成的bytearray存到奇怪后缀的文件里，sql就不管了，该扩展扩展



##  💖 DONATE ME 💖 喜欢我就给我发电！！
___

### 打赏 | Donate: [爱发电 | Aifadian](https://afdian.com/@LSDog)

![who use? I use!](https://bstats.org/signatures/bukkit/CustomSprays.svg)

本项目由 [PixelMC](http://pixelmc.cn/) 团队提供长期支持与维护

![logo](media/banner_logo.png)