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)编译

### Gui

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

### Maven

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

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

### 帮助

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

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

## 依赖

## 其他

### Git

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)

### 界面

![蜗牛](./docs/gui/main.png "蜗牛")
![统计](./docs/gui/statistics-piece.png "统计")

[界面操作](./docs/GUI.md)

### 贡献

提交PR前请阅读[代码规范](./CODE_OF_CONDUCT.md)、[贡献规范](./CONTRIBUTING.md)

问题和建议请提交到[Issues](https://gitee.com/acgist/snail/issues)，提交前请阅读[贡献规范](./CONTRIBUTING.md)。

谢谢！

### 捐赠

[捐赠](https://www.acgist.com/sponsor)

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

阿泽今天秃头了么/snail

简介

发行版

贡献者

近期动态

阿泽今天秃头了么/snail .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

阿泽今天秃头了么/snail