https://github.com/elegantchaos/swiftbsa
Swift support for Bethesda's BSA format, used by Skyrim, Fallout, etc.
https://github.com/elegantchaos/swiftbsa
bsa creationkit skyrim-special-edition swift
Last synced: about 2 months ago
JSON representation
Swift support for Bethesda's BSA format, used by Skyrim, Fallout, etc.
- Host: GitHub
- URL: https://github.com/elegantchaos/swiftbsa
- Owner: elegantchaos
- Created: 2022-03-01T15:13:42.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-03-24T13:53:33.000Z (about 3 years ago)
- Last Synced: 2025-02-04T20:18:13.958Z (4 months ago)
- Topics: bsa, creationkit, skyrim-special-edition, swift
- Language: Swift
- Homepage:
- Size: 2.24 MB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[comment]: <> (Header Generated by ActionStatus 2.0.6 - 478)
[![Test results][tests shield]][actions] [![Latest release][release shield]][releases] [![swift 5.6 shield]][swift] ![Platforms: macOS][platforms shield]
[release shield]: https://img.shields.io/github/v/release/elegantchaos/SwiftBSA
[platforms shield]: https://img.shields.io/badge/platforms-macOS-lightgrey.svg?style=flat "macOS"
[tests shield]: https://github.com/elegantchaos/SwiftBSA/workflows/Tests/badge.svg
[swift 5.6 shield]: https://img.shields.io/badge/swift-5.6-F05138.svg "Swift 5.6"
[swift]: https://swift.org
[releases]: https://github.com/elegantchaos/SwiftBSA/releases
[actions]: https://github.com/elegantchaos/SwiftBSA/actions
[comment]: <> (End of ActionStatus Header)
# SwiftBSA
Swift support for Bethesda's BSA file format, as used by Skyrim, Fallout, etc.
Currently this version of the code supports version 105, as used by Skyrim SE/AE.
Support for earlier versions may be added at some later date.
## Here Be Dragons
This is an early version, and it currently only supports extracting a `.bsa` file to a directory, and packing a directory to a compressed archive.
Right now it's just a library and some tests.
The next step will be to add a command line tool target, but I envisage it mostly being used as a library, linked to by other tools.
## Why?
This is part of a [larger tools project](https://github.com/elegantchaos/SkyrimCompiler).
### Why Swift?
It's what I use for the day job, has decent cross platform support, and I needed an excuse to mess around with some binary streaming and async/await things.
### Why Cross Platform?
1. Although I play Skyrim on a PC, I do most of my coding work on a Mac.
2. OpenMW supports Windows/MacOS/Linux. At some point I'd like to extend this tool and the other things I'm working on to support OpenMW.
## Useful Info
- File Format: https://en.uesp.net/wiki/Skyrim_Mod:Archive_File_Format
- Pyffi definitions (possibly incomplete): https://github.com/niftools/pyffi/blob/develop/pyffi/formats/bsa/bsa.xml
- Some Notes: https://github.com/focustense/easymod/tree/master/Focus.Apps.EasyNpc
- Other Implementations:
- https://github.com/focustense/easymod/blob/master/Focus.Storage.Archives/README.md
- https://github.com/Guekka/libbsarch
- https://github.com/TES5Edit/TES5Edit/tree/dev/Tools/BSArchive
### Example Data
The example data in this repo is taken from [Parapets](https://www.nexusmods.com/skyrimspecialedition/users/39501725), who helpful makes all their mods available under an MIT license.