XrayWeave

Helper for xray-core to parse URI links or construct configuration by yourself.

Table of Contents

• Introduction
• Features
• Getting Started
  • Installation
  • Usage
• Contributing

Introduction

The XrayWeave is a utility designed to assist xray-core users to create configuration for the Xray VPN using Swift. It simplifies the process of extracting from URI and manipulating configuration information.

Features

• Parsing: Quickly parse xray config URI links to extract configuration details.
• Compatibility: Designed to work seamlessly with xray-core configurations.
• Easy Integration: Simple and straightforward integration into your projects.

Getting Started

Installation

The preferred way of installing XrayWeave is via the Swift Package Manager.

/// Package.swift
/// ...
dependencies: [
    .package(url: "https://github.com/Bogdan-Belogurov/XrayWeave.git", branch: "main"),
]
/// ...

Usage

import XrayWeave

/// ...

func connect() {
    let uri = """
    vless://[email protected]:443flow=xtls-rprx-vision-udp443\
    &type=tcp&security=reality&fp=safari&sni=dl.google.com&pbk=publickey&sid=7d263c#X-ray
    """

    let inboundTag = "socketinbound"
    let newInbound = InboundProxy(
        listen: "[::1]",
        port: inboundPort,
        protocol: .socks,
        settings: .socks(SocksInboundConfigurationObject(auth: .noauth, udp: true)),
        tag: inboundTag
    )

    let config = try XrayWeave(urlString: uri)
        .getConfiguration()
        .logLevel(.debug)
        .routing(
            Route(
                domainStrategy: .asIs,
                rules: [
                    Route.Rule(
                        inboundTag: [inboundTag],
                        outboundTag: .proxy
                    )
                ]
            )
        )
        .inbound(newInbound)
        .toJSON()
        
    try xray.connect(config)
}

Contributing

Contributions are welcome! If you encounter any issues or have suggestions for improvements, please open an issue or submit a pull request.