README.md · 在我裑贬/snail

<h1 align="center">Snail（蜗牛）</h1>

<p align="center">
基于Java、JavaFX开发的下载工具，支持下载协议：BT（BitTorrent、磁力链接、种子文件）、HLS（M3U8）、FTP、HTTP。
</p>

----

## 结构

|项目|描述|
|:--|:--|
|snail|下载核心|
|snail-javafx|电脑界面|

> 电脑界面只是方便操作，下载核心包含所有下载协议，完全可以独立使用。

## 使用

[稳定版本下载](https://gitee.com/acgist/snail/attach_files)

### 编译

```bash
mvn clean package -P release -D skipTests
```

> 推荐使用[Release](https://gitee.com/acgist/snail/releases)版本编译

### 界面

```bash
java -server -Xms128m -Xmx256m -jar snail.javafx-{version}.jar
```

> 界面使用参考[界面使用帮助](./docs/GUI.md)

### 代码

```xml
<dependency>
	<groupId>com.acgist</groupId>
	<artifactId>snail</artifactId>
	<version>{release.version}</version>
</dependency>
```

```java
final Snail snail = SnailBuilder.newBuilder()
	.enableAllProtocol()
	.buildSync();
// BT任务需要注册文件选择事件
// GuiContext.register(new MultifileEventAdapter());
snail.download("https://www.acgist.com");
snail.lockDownload();
```

> 代码二次开发参考[开发帮助](./docs/API.md)

### 帮助

使用快捷键`F12`进入统计页面可以查看当前下载任务的统计信息

[开发帮助](./docs/API.md)

[使用帮助](./docs/HELP.md)

[界面使用帮助](./docs/GUI.md)

## 其他

### 仓库

GITEE：[https://gitee.com/acgist/snail](https://gitee.com/acgist/snail)

GITHUB：[https://github.com/acgist/snail](https://github.com/acgist/snail)

### 协议

[下载协议](./docs/PROTOCOL.md)

### 依赖

|项目|许可|
|:--|:--|
|[JavaFX](https://wiki.openjdk.java.net/display/OpenJFX)|[GPLv2 + CE](https://openjdk.java.net/legal/gplv2+ce.html)|
|[OpenJDK](https://openjdk.java.net)|[GPLv2 + CE](https://openjdk.java.net/legal/gplv2+ce.html)|

### 界面

![蜗牛](./docs/gui/main.png "蜗牛")

### 贡献

提交PR、问题建议[Issues](https://gitee.com/acgist/snail/issues)前请阅读[代码规范](./CODE_OF_CONDUCT.md)、[贡献规范](./CONTRIBUTING.md)

谢谢！

### 白嫖

[阿里云服务器](https://www.acgist.com/collect/server)

> 确实便宜

在我裑贬/snail

简介

发行版

贡献者

近期动态

在我裑贬/snail .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

在我裑贬/snail