Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sebyx07/stormlib
MPQ library for ruby using stormlib
https://github.com/sebyx07/stormlib
world-of-warcraft
Last synced: 2 months ago
JSON representation
MPQ library for ruby using stormlib
- Host: GitHub
- URL: https://github.com/sebyx07/stormlib
- Owner: sebyx07
- License: mit
- Created: 2024-09-21T14:37:33.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-09-23T17:36:00.000Z (4 months ago)
- Last Synced: 2024-10-31T14:29:16.378Z (2 months ago)
- Topics: world-of-warcraft
- Language: Ruby
- Homepage:
- Size: 319 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# StormLib 🌪️
StormLib is a Ruby gem that provides a wrapper for the [StormLib C++ library](https://github.com/ladislav-zezula/StormLib), allowing you to work with MPQ (Mo'PaQ) archives in your Ruby projects for World of Warcraft and other Blizzard games.
## 📦 Installation
Add this line to your application's Gemfile:
```ruby
gem 'stormlib'
```
And then execute:
```
$ bundle install
```
Or install it yourself as:
```
$ gem install stormlib
```
## 🛠️ Dependencies
Before installing the gem, make sure you have the following dependencies installed on your system:
- zlib1g-dev
- libbz2-dev
- build-essential
- libstdc++-12-dev
You can install these on Ubuntu or Debian-based systems with:
```
$ sudo apt-get install zlib1g-dev libbz2-dev build-essential libstdc++-12-dev
```
## 🚀 Usage
Here are some examples of how to use StormLib:
```ruby
require 'stormlib'
# Open an existing MPQ archive
archive = StormLib::Archive.new('game.mpq')
# List files in the archive
files = archive.list_files
puts "Files in the archive: #{files.join(', ')}"
# Extract a file from the archive
archive.extract_file('readme.txt', 'extracted_readme.txt')
# Create a new MPQ archive
new_archive = StormLib::Archive.new('new_archive.mpq', create: true)
# Add a file to the new archive
new_archive.add_file('local_file.txt', 'archived_file.txt')
# Don't forget to close the archives when you're done
archive.close
new_archive.close
```
## DBC
you can use https://github.com/sebyx07/wow_dbc to CRUD DBC files
## 🧪 Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## 🤝 Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/sebyx07/stormlib. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/sebyx07/stormlib/blob/master/CODE_OF_CONDUCT.md).
## 📜 License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## 👥 Code of Conduct
Everyone interacting in the StormLib project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/sebyx07/stormlib/blob/master/CODE_OF_CONDUCT.md).