mirror of
https://github.com/cyberarm/i-mic-fps.git
synced 2025-12-15 15:42:35 +00:00
Added README, rescue from missing demo file, add .gitignore.
This commit is contained in:
15
README.md
Normal file
15
README.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# I-MIC FPS
|
||||
An endeavor to create a multiplayer first-person-shooter in pure Ruby; Using C extensions only for Rendering, Sound, and Input. ([Gosu](https://libgosu.org) and [opengl-bindings](https://github.com/vaiorabbit/ruby-opengl/))
|
||||
|
||||
## Using
|
||||
Requires a Ruby runtime that supports the gosu and opengl-bindings C-extensions (truffleruby 1.0.0-rc12 did not work when tested. Rubinus was not tested.)
|
||||
* Clone or download this repo
|
||||
* `bundle install`
|
||||
* `bundle exec ruby i-mic-fps.rb [options]`
|
||||
|
||||
### Options
|
||||
* `--native` - Launch in fullscreen using primary displays resolution
|
||||
* `--debug` - Set $debug variable to true (defaults to false)
|
||||
* `--profile` - Run ruby-prof profiler
|
||||
* `--savedemo` - Record camera movement and key events to playback later *(alpha-quality feature)*
|
||||
* `--playdemo` - Plays the previously recorded demo *(alpha-quality feature)*
|
||||
Reference in New Issue
Block a user