https://github.com/yellowcake-org/libycresources
Rust library which implements reading resources used in Fallout™.
https://github.com/yellowcake-org/libycresources
aaf acm dat fallout fon frm gam int lip map mve pal pro
Last synced: 6 months ago
JSON representation
Rust library which implements reading resources used in Fallout™.
- Host: GitHub
- URL: https://github.com/yellowcake-org/libycresources
- Owner: yellowcake-org
- License: agpl-3.0
- Archived: true
- Created: 2021-06-14T14:34:42.000Z (almost 4 years ago)
- Default Branch: develop
- Last Pushed: 2023-04-05T10:20:36.000Z (about 2 years ago)
- Last Synced: 2024-08-10T14:16:28.238Z (9 months ago)
- Topics: aaf, acm, dat, fallout, fon, frm, gam, int, lip, map, mve, pal, pro
- Language: Rust
- Homepage:
- Size: 647 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## libycresources
This repository is a part of [Yellowcake](https://github.com/yellowcake-org) project.
### What it does
The library is intended to provide instruments for working with original Fallout™ resources, such as `.map`, `.pro`, `.dat` files, and many others, which were used in classic Fallout™ games. This repository also does include example tools, provided for each file format separately, via `examples`' targets. Sometimes they just print out available info, but very often they additionaly provide extended functionality, which goes beyond simple examples, like `mapview` tool.
### Why this is useful
It is useful in obvious way for reproducing original game: providing modern, safe and stable codebase to work with original games' resources. It also may serve as a documenation for those who want to learn about original file formats. And, finally, its' example tools could be a good starting point for modders of original games. In very first release it can't do much, though, but it's already better, than original tools released by the publisher in what it actually allows to do. For instance, again, `mapview` can be used to create some arts from maps, or guides. In case of significant demand from the community, it might become something bigger, like full-featured map editor, so stay tuned.
### How to get started
Basically you just use Cargo and default Rust tooling to explore different modules and examples. Each file format is represented with different Rust module. The crate has also a couple of common modules, which provide basic data structures, needed for the game files' formats, and abstractions. Examples' targets provide a view on intended way of using the library's functions.
### Where to get help
[GitHub Discussions](https://github.com/yellowcake-org/libycresources/discussions) is the right place. GitHub Issues are disabled at the moment, but will be enabled in case of significant activity from community. As for now, I am handling all issues internally, using additional software.
### Who maintains and contributes
Currently, only [__@0xceed__](https://github.com/0xceed) is working on the library. While help from the community will be _very_ needed in the future, this early in development I need to focus on creating good example of my vision, guidelines and many, many more.