https://github.com/ananace/factorio_mods
Ruby gem for managing Factorio and mods
https://github.com/ananace/factorio_mods
Last synced: 15 days ago
JSON representation
Ruby gem for managing Factorio and mods
- Host: GitHub
- URL: https://github.com/ananace/factorio_mods
- Owner: ananace
- License: mit
- Created: 2018-07-01T11:12:48.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2020-08-16T16:15:50.000Z (almost 6 years ago)
- Last Synced: 2025-02-24T05:12:12.629Z (over 1 year ago)
- Language: Ruby
- Homepage:
- Size: 47.9 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Factorio management gem
The main focus for this gem is for modding and management of mods, but it contains APIs for more uses than that.
## Installation
Install it with gem
$ gem install factorio_mods
## Usage
TODO: Implement thor-based CLI
```ruby
# Acquire a token
FactorioMods::Api::WebAuthentication.login 'username', 'password'
# or
FactorioMods::Api::WebAuthentication.tap do |auth|
auth.username = 'username'
auth.token = 'token'
end
install = FactorioMods::Install.new '~/.factorio'
# or
install = FactorioMods::Install.discover.first
install.mod_manager.install_mod('angelssmelting')
# You can also specify exact version requirements, with the same method as rubygems version matching
install.mod_manager.install_mod('angelssmelting', version: '~> 2.0')
```
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/ananace/factorio_mods
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).