Project

stormlib

0.0
The project is in a healthy, maintained state
MPQ library for Ruby using the StormLib C library
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Development

 Project Readme

StormLib ๐ŸŒช๏ธ

StormLib is a Ruby gem that provides a wrapper for the StormLib C++ library, 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:

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:

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.

๐Ÿค 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.

๐Ÿ“œ License

The gem is available as open source under the terms of the MIT License.

๐Ÿ‘ฅ 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.