https://github.com/uooobarry/palworld_rcon
Ruby RCON client for Palworld.
https://github.com/uooobarry/palworld_rcon
palworld rcon rcon-client
Last synced: 3 months ago
JSON representation
Ruby RCON client for Palworld.
- Host: GitHub
- URL: https://github.com/uooobarry/palworld_rcon
- Owner: UoooBarry
- License: mit
- Created: 2024-01-29T02:58:24.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-02T02:52:32.000Z (over 1 year ago)
- Last Synced: 2025-02-25T22:47:40.679Z (3 months ago)
- Topics: palworld, rcon, rcon-client
- Language: Ruby
- Homepage:
- Size: 18.6 KB
- Stars: 0
- 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
# PalworldRcon
A ruby Palworld RCON client.
## Installation
Install the gem and add to the application's Gemfile by executing:
$ bundle add palworld_rcon
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install palworld_rcon
## Usage
### Init client
```ruby
client = PalworldRcon::Client.new(host: '', port: 25575, password: '')
```
### Broadcast a message
```ruby
client.broadcast("debug")
```
## 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/[USERNAME]/palworld_rcon. 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/[USERNAME]/palworld_rcon/blob/main/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 PalworldRcon project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/palworld_rcon/blob/main/CODE_OF_CONDUCT.md).