https://github.com/adaxi/bencode

Encode and decode B-encoded content
https://github.com/adaxi/bencode

bencode java torrent

Last synced: about 2 months ago
JSON representation

Encode and decode B-encoded content

• Host: GitHub
• URL: https://github.com/adaxi/bencode
• Owner: adaxi
• License: other
• Created: 2016-06-21T18:56:21.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-03-19T19:13:41.000Z (almost 8 years ago)
• Last Synced: 2024-05-01T13:35:55.044Z (8 months ago)
• Topics: bencode, java, torrent
• Language: Java
• Homepage:
• Size: 84 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
B-Encode

========

[![Build Status](https://travis-ci.org/adaxi/Bencode.svg?branch=master)](https://travis-ci.org/adaxi/Bencode) [![Coverage Status](https://coveralls.io/repos/github/adaxi/Bencode/badge.svg?branch=master)](https://coveralls.io/github/adaxi/Bencode?branch=master) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/be.adaxisoft/Bencode/badge.svg)](http://adaxi.github.io/Bencode/dependency-info.html)

This library allows you to encode and decode B-encoded documents.

Before:

```java

Map document = new HashMap() {{

    put("string", new BEncodedValue("value"));

    put("number", new BEncodedValue(123456));

    put("list", new BEncodedValue(new ArrayList() {{

        add(new BEncodedValue("list-item-1"));

        add(new BEncodedValue("list-item-2"));

    }}));

    put("dict", new BEncodedValue(new HashMap() {{

        put("123", new BEncodedValue("test"));

        put("456", new BEncodedValue("thing"));

    }}));

}};

ByteArrayOutputStream baos = new ByteArrayOutputStream();

BEncoder.encode(document, baos);

String encodedDocument = new String(baos.toByteArray());

```

After:

```

d

	4:dict		d

					3:123	4:test

					3:456	5:thing

				e

	4:list		l

					11:list-item-1

					11:list-item-2

				e

	6:number	i123456e

	6:string	5:value

e

```

The library can do the reverse operation as well: decode.

I want to decode a torrent file. How can I do that?

---------------------------------------------------

First you need to read the torrent and decode it:

```java

File torrentFile = "file.torrent";

FileInputStream inputStream = new FileInputStream(torrentFile);

BDecoder reader = new BDecoder(inputStream);

Map document = reader.decodeMap().getMap();

```

Then you can start extracting information from it:

```java

String announce = document.get("announce").getString(); // Strings

Map info = document.get("info").getMap(); // Maps

List files = info.get("files").getList(); // Lists

```

You can check if a key exists using the 'containsKey' method as such:

```java

if (document.containsKey("info")) {

    System.out.println("The info field exists");

}

```

Use the library

--------------

The [documentation page](http://adaxi.github.io/Bencode/dependency-info.html) lists how you can add this library

as a dependency of your project.

Credit

------

This library was created since no other viable libraries existed, and the ttorrent

project contains a bunch of unecessary content. It is based on the work of [Maxime Petazzoni](https://github.com/mpetazzoni/ttorrent).