Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/up9cloud/ios-libtdjson

Prebuilt [TDLib](https://github.com/tdlib/td) shared lib (libtdjson.dylib) for iOS and macOS
https://github.com/up9cloud/ios-libtdjson

cocoapods dylib ios libtdjson macos prebuilt tdjson tdlib telegram telegram-api

Last synced: 24 days ago
JSON representation

Prebuilt [TDLib](https://github.com/tdlib/td) shared lib (libtdjson.dylib) for iOS and macOS

Host: GitHub
URL: https://github.com/up9cloud/ios-libtdjson
Owner: up9cloud
License: mit
Created: 2021-07-22T10:48:49.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2024-06-27T23:47:52.000Z (4 months ago)
Last Synced: 2024-06-28T02:13:06.688Z (4 months ago)
Topics: cocoapods, dylib, ios, libtdjson, macos, prebuilt, tdjson, tdlib, telegram, telegram-api
Language: Shell
Homepage:
Size: 47.9 KB
Stars: 5
Watchers: 2
Forks: 2
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # ios-libtdjson

[![Version](https://img.shields.io/cocoapods/v/libtdjson.svg?style=flat)](https://cocoapods.org/pods/libtdjson)

[![License](https://img.shields.io/cocoapods/l/libtdjson.svg?style=flat)](https://cocoapods.org/pods/libtdjson)

[![Platform](https://img.shields.io/cocoapods/p/libtdjson.svg?style=flat)](https://cocoapods.org/pods/libtdjson)

## Lib versions

|  pod  |                                        tdlib                                          |

| ----- | ------------------------------------------------------------------------------------- |

| 0.4.2 | [1.8.31](https://github.com/tdlib/td/commit/8f19c751dc296cedb9a921badb7a02a8c0cb1aeb) |

| 0.4.1 | [1.8.30](https://github.com/tdlib/td/commit/fab354add5a257a8121a4a7f1ff6b1b9fa9a9073) |

| 0.3.0 | [1.8.7](https://github.com/tdlib/td/commit/a7a17b34b3c8fd3f7f6295f152746beb68f34d83)  |

| 0.2.2 | [1.8.1](https://github.com/tdlib/td/commit/92c2a9c4e521df720abeaa9872e1c2b797d5c93f)  |

| 0.2.1 | [1.7.9](https://github.com/tdlib/td/commit/7d41d9eaa58a6e0927806283252dc9e74eda5512)  |

| 0.2.0 | [1.7.0](https://github.com/tdlib/td/tree/v1.7.0)                                      |

## Supported architectures

|      Platform      | Architecture |     |

| ------------------ | ------------ | --- |

| iOS                | armv7        | ❌   |

|                    | armv7s       | ❌   |

|                    | arm64        | ✅   |

| iOS simulator      | i386         | ❌   |

|                    | x86_64       | ✅   |

|                    | arm64 (M1↑)  | ✅   |

| macOS              | i386         | ❌   |

|                    | x86_64       | ✅   |

|                    | arm64 (M1↑)  | ✅   |

| watchOS            | armv7k       | ❌   |

|                    | arm64_32     | ❌   |

|                    | arm64        | ❌   |

| watchOS simulator  | x86_64       | ❌   |

|                    | arm64        | ❌   |

| tvOS               | arm64        | ❌   |

| tvOS simulator     | x86_64       | ❌   |

|                    | arm64        | ❌   |

| visionOS           | arm64        | ❌   |

| visionOS simulator | x86_64       | ❌   |

|                    | arm64        | ❌   |

## Installation

### CocoaPods

libtdjson is available through [CocoaPods](https://cocoapods.org). To install it, simply add the following line to your Podfile:

```ruby

pod 'libtdjson'

```

or add it to your .podspec file:

```ruby

Pod::Spec.new do |s|

  s.dependency 'libtdjson'

end

```

### Use it as module (iOS, swift)

Because this pod **only** provide .dylib files (to prevent module name conflicts and keep it simplest!), if you want to use it as module (e.q. on iOS with swift), you **have to** add some necessary files:

- Download example `headers` and `module.modulemap`

```bash

curl -SLO https://github.com/up9cloud/ios-libtdjson/releases/download/v0.2.2/cocoapod_modulemap.tar.gz

mkdir include

tar xzf cocoapod_modulemap.tar.gz -C include

# Edit files to whatever you want, e.q. change the module name or remove export symbols you don't need

```

- Add include path and link lib, e.q.

```ruby

Pod::Spec.new do |s|

  s.pod_target_xcconfig = {

    'SWIFT_INCLUDE_PATHS' => '${PODS_TARGET_SRCROOT}/include',

    'OTHER_LDFLAGS' => '-ltdjson',

  }

end

```

- Use it

```swift

import libtdjson

func create() -> Int {

    return Int(bitPattern: libtdjson.td_json_client_create()!)

}

// ... (more usages at ./example/*)

```

### Carthage

TODO:

### Manually

Download prebuilt files from `Release`, then do whatever you want.

## Q&A

> An error was encountered processing the command (domain=FBSOpenApplicationServiceErrorDomain,code=1):

The app will crash if identification name of .dylib isn't correct

```bash

# check id

otool -D libtdjson.dylib

# fix id

install_name_tool -id @rpath/libtdjson.dylib libtdjson.dylib

```

## TODO

- [ ] Package static lib for App Store

- [ ] Support [Carthage](https://github.com/Carthage/Carthage/blob/master/Documentation/Artifacts.md#cartfile)

- [x] Support M1 (Apple Silicon) - migrate to XCFramework, see [PR 1620](https://github.com/tdlib/td/pull/1620)

## Dev memo

### Bump the TDLib version

- Modify the version for git checkout in `./build.sh`

- Update the `Lib versions` part in `./README.md`

- Git commit (message example: `bump td to vx.x.x`)

- Git add tag (`git tag vx.x.x`, the tag version should be the version on cocoapod)

- Push with tags (`git push && git push --tags`)

- Wait for CI task

> If the CI build failed, need manually do `pod trunk push`...

```bash

export GITHUB_REF=refs/tags/

pod trunk push --allow-warnings libtdjson.podspec

pod trunk push --allow-warnings flutter_libtdjson.podspec

```

> Find pod info

```bash

pod trunk info libtdjson

```

> what if need to revert the tag...

```bash

version=

git push --delete origin $version

git tag -d $version

git add .

git commit -m "..."

git tag $version

git push && git push --tags

```