Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sinanislekdemir/blackbook
Pure Ruby 3D Engine
https://github.com/sinanislekdemir/blackbook
3d 3d-engine 3d-game-engine 3d-graphics game-development game-engine graphics opengl ruby
Last synced: 26 days ago
JSON representation
Pure Ruby 3D Engine
- Host: GitHub
- URL: https://github.com/sinanislekdemir/blackbook
- Owner: sinanislekdemir
- License: other
- Created: 2015-03-28T14:15:18.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-06-27T18:20:08.000Z (over 2 years ago)
- Last Synced: 2023-08-14T14:11:18.447Z (about 1 year ago)
- Topics: 3d, 3d-engine, 3d-game-engine, 3d-graphics, game-development, game-engine, graphics, opengl, ruby
- Language: Ruby
- Size: 20.5 MB
- Stars: 10
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Project BlackBook
===================
About the project
----------
BlackBook is a pure Ruby 3D Library that aims developers to write their 3D applications with ease of Ruby. Please keep in mind that, this project is still a **work in progress** and is **not suitable to use** I suppose. But try it for yourself. Feel free to fix it, improve it and be a contributor for the project.
### About Source Code Refactoring
Code refactor and small bug fixes. All methods and variables are still same, it's just simplified so I can continue work on it.
I am working on some minor changes, in near future I will maybe work on major ones, too.
Methods Added:
```ruby
# Shortctut for BlackBook::Registry.instance.write(arg)
# Now you can call class method Registry#setup with hash arguments:
BlackBook::Registry.setup( grid: true,
grid_count: 30,
grid_size: 1
)
# Shortcut for BlackBook::Main.new(args).engine_loop
# Now you can call class method BlackBook#loop with hash arguments:
BlackBook.loop( w: 800, h:600, t: 'My Title' )
#or
BlackBook.loop( width: 800,
height: 600,
title: 'My title'
)
```
Documents
-------------
For documentation, I am trying to write as many comments as possible and keep the code clean and meaningful with giving proper variable names and keeping a standard.
Some parts of the code is messy, as I mentioned, I did not refactor it yet.
Documentations are generated with **yardoc** and code standards can be checked with **rubocop**. I needed to flex the standards a bit. ;)
I hope you enjoy it. You can find the requirements inside Gemfile.
After all, just give it a shot!
ruby main.rb
Registry
--------------
There are some global variables that you might need to define in your application setup;
BlackBook::Registry.instance.write('grid', true) # Draw grid
BlackBook::Registry.instance.write('grid_count', 100) # Grid line count
BlackBook::Registry.instance.write('grid_size', 2) # Grid line size
BlackBook::Registry.instance.write('data_path', '../data') # Data path, especially needed for fonts.
BlackBook::Registry.instance.write('shader', 'vbo') # Set object shading to Virtual Buffer Objects
BlackBook::Registry.instance.write('shader', 'displaylist') # Set object shading to display lists
New Method is added to simplify this setup:
BlackBook::Registry.setup( grid: true,
grid_count: 100,
grid_size: 2
)
RAW Object Files
----------------
3D Raw Object files are simply exports from Blender3D as raw text format.
OBJ Object Files
----------------
Wavefront Object files are simply exports from Blender3D as Wavefront Obj format.
**Do not forget to set Front and Up axis for export!**
Syntax Control
--------------
Please use **check\_syntax.sh** for syntax control and do not change .rubocop_todo.yml
Notes about known bugs
-----------------------
Seems like, I broke the Physics Engine during my structure renewal. Sorry :) I will fix it ASAP and also fix the 8_physics.rb sample.