rubygb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3dd7fa09adc216340304dd6680d2081184b570a1
+  data.tar.gz: 8f99e04afc723055a64f76450a6901f27a757fb8
+SHA512:
+  metadata.gz: ac40dd65075a0ba6d53b7b4f674e7544caeab46e81cdc4623f12e7387c1866128cc1df2faf8da355b226e95afa3dfe1664a720654e80e682595e01249b68c7fe
+  data.tar.gz: 5191b4f9e58316e51c7b08a29c0691b96a0558e231fbe98c74bde35f6ad0e5861d0667f12f57e3b27003e9d3906fb5b6548860cb1f3a239739b1ffdcf77f21a5

data/.gitignore

@@ -0,0 +1,5 @@
+Gemfile.lock
+/pkg
+.idea/
+scrap/
+.DS_Store

data/.travis.yml

@@ -0,0 +1,20 @@
+sudo: false
+language: ruby
+
+script: bundle exec ruby spec/rubygb_spec.rb
+
+rvm:
+- 2.3
+- 2.2
+- 2.1
+- 2.0
+- ruby-head
+- rbx-2
+- jruby-head
+- jruby-9000
+
+cache:
+- bundler
+
+# matrix:
+#   fast_finish: true

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## CHANGELOG
+
+### 0.1.0
+
+* Inital release
+

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'minitest'

data/Gemfile.lock

@@ -0,0 +1,23 @@
+PATH
+  remote: .
+  specs:
+    rubygb (0.1.0)
+      thor (~> 0.19)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.8.4)
+    rake (10.5.0)
+    thor (0.19.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest
+  rake
+  rubygb!
+
+BUNDLED WITH
+   1.11.2

data/MIT-LICENSE.txt

@@ -0,0 +1,53 @@
+Copyright (c) 2016 Donald Hutchison, git@toastymofo.net
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+rgbasm and rgblink are derived from Justin Lloyd's RGBDS, which is
+released under the following license:
+
+                      DO WHATEVER PUBLIC LICENSE*
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. You can do whatever you want to with the work.
+  1. You cannot stop anybody from doing whatever they want to with the work.
+  2. You cannot revoke anybody elses DO WHATEVER PUBLIC LICENSE in the work.
+
+ This program is free software. It comes without any warranty, to
+ the extent permitted by applicable law. You can redistribute it
+ and/or modify it under the terms of the DO WHATEVER PUBLIC LICENSE
+ 
+ Software originally created by Justin Lloyd @ http://otakunozoku.com/
+
+
+rgbfix was rewritten from scratch by Anthony J. Bentley, and is released
+under the ISC license; see the source file for the text of the license.
+
+The UTF-8 decoder in src/asm/charmap.c was written by Björn Höhrmann and is
+released under the MIT license. The remainder of charmap.c was written by
+stag019, and is released under the ISC license.
+
+extern/err.c is derived from the Musl C library, http://www.musl-libc.org,
+and is released under the MIT license.
+
+extern/reallocarray.c is derived from the OpenBSD Project,
+http://www.openbsd.org, and is released under the ISC license.
+
+extern/strl.c is derived from the OpenBSD Project, http://www.openbsd.org,
+and is released under the BSD license.

data/README.md

@@ -0,0 +1,30 @@
+# rubygb [![[version]](https://badge.fury.io/rb/rubygb.svg)](http://badge.fury.io/rb/rubygb)  [![[travis]](https://travis-ci.org/rkachowski/rubygb.png)](https://travis-ci.org/rkachowski/rubygb)
+
+Bundles the [rgbds-linux](https://github.com/bentley/rgbds) compiler (for OSX) along with some helpful libs from galp to create and build gameboy roms in a quick and stupid way.
+
+
+## Setup
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'rubygb'
+```
+
+
+## Usage
+
+```ruby
+```
+
+## Awesomeness
+
+All the cool parts are from other people
+
+* [rgbds-linux](https://github.com/bentley/rgbds)
+* [gameboy assembly language primer (galp)](http://www.devrs.com/gb/docs.php) - devrs.com
+
+
+## MIT License
+
+Copyright (C) 2016 Donald Hutchison <donaldhutchison.info>. Released under the MIT license.

data/Rakefile

@@ -0,0 +1,30 @@
+# # #
+# Get gemspec info
+
+gemspec_file = Dir['*.gemspec'].first 
+gemspec = eval File.read(gemspec_file), binding, gemspec_file
+info = "#{gemspec.name} | #{gemspec.version} | " \
+       "#{gemspec.runtime_dependencies.size} dependencies | " \
+       "#{gemspec.files.size} files"
+
+
+# # #
+# Gem build and install task
+
+desc info
+task :gem do
+  puts info + "\n\n"
+  print "  "; sh "gem build #{gemspec_file}"
+  FileUtils.mkdir_p 'pkg'
+  FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", 'pkg'
+  puts; sh %{gem install --no-document pkg/#{gemspec.name}-#{gemspec.version}.gem}
+end
+
+
+# # #
+# Start an IRB session with the gem loaded
+
+desc "#{gemspec.name} | IRB"
+task :irb do
+  sh "irb -I ./lib -r #{gemspec.name.gsub '-','/'}"
+end

data/bin/rubygb

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'rubygb'
+
+Rubygb::CLI.start ARGV

data/lib/galp/C.BAT

@@ -0,0 +1,5 @@
+rgbasm -oexample.obj example.asm
+rgblink -mmap example.lnk
+rgbfix -v example
+del *.obj
+

data/lib/galp/CHANGES.TXT

@@ -0,0 +1,5 @@
+GALP History
+------------
+
+V1.0 - Original version
+

data/lib/galp/EXAMPLE.LNK

@@ -0,0 +1,7 @@
+# Linkfile for Pan Library Demo
+
+[Objects]
+example.obj
+
+[Output]
+example.gb

data/lib/galp/EXAMPLE1.TXT

@@ -0,0 +1,266 @@
+;
+; EXAMPLE1.ASM - Print "Hello World!" to the screen.
+;  by GABY
+;  Last edit: 24-Nov-98
+;
+;  The quickest way to learn something, probably,
+; is to jump in with both feet so here we go.
+; You are actually looking at the source code for
+; example #1. As you may have noticed there is a
+; semicolon at the beginning of each line. Most
+; GameBoy assemblers (and most other assembly
+; language assemblers) use a semicolon to indicate
+; that everything following it on a particular line
+; is to be ignored and be treated purely as comments
+; rather than code.
+;
+; The first thing we want to do is include the
+; 'Hardware Defines' for our program. This has
+; address location labels for all of the GameBoy
+; Hardware I/O registers. We can 'insert' this file
+; into the present EXAMPLE1.ASM file by using the
+; assembler INCLUDE command:
+
+        INCLUDE "gbhw.inc"
+
+;  Next we want to include a file that contains a font
+; macro. A macro is a portion of code or data that
+; gets 'inserted' into your program. At this point,
+; we are not actually inserting anything but a macro
+; definition into our file. Code or data isn't physically
+; inserted into a program until you invoke a macro which
+; we will do later. For now, we are just making the macro
+; name recognizable by our program.
+;
+;  This is but just one method for including a font into
+; a program. Many different methods may be used including
+; using the INCBIN command. The INCBIN command allows
+; including raw font data or any type of raw binary data
+; into a program.
+
+        INCLUDE "ibmpc1.inc"
+
+;  Next we need to include the standard GameBoy ROM header
+; information that goes at location $0100 in the ROM. (The
+; $ before a number indicates that the number is a hex value.)
+;
+;  ROM location $0100 is also the code execution starting point
+; for user written programs. The standard first two commands
+; are usually always a NOP (NO Operation) and then a JP (Jump)
+; command. This JP command should 'jump' to the start of user
+; code. It jumps over the ROM header information as well that
+; is located at $104.
+;
+;  First, we indicate that the following code & data should
+; start at address $100 by using the following SECTION assembler
+; command:
+
+        SECTION "Org $100",HOME[$100]
+
+        nop
+        jp      begin
+
+;  To include the standard ROM header information we
+; can just use the macro ROM_HEADER. We defined this macro
+; earlier when we INCLUDEd "gbhw.inc".
+;
+;  The ROM_NOMBC just suggests to the complier that we are
+; not using a Memory Bank Controller because we don't need one
+; since our ROM won't be larger than 32K bytes.
+;
+;  Next we indicate the cart ROM size and then the cart RAM size.
+; We don't need any cart RAM for this program so we set this to 0K.
+
+        ROM_HEADER      ROM_NOMBC, ROM_SIZE_32KBYTE, RAM_SIZE_0KBYTE
+
+; Next we need to include some code for doing
+; RAM copy, RAM fill, etc.
+
+        INCLUDE "memory.asm"
+
+;  Next, let's actually include font tile data into the ROM
+; that we are building. We do this by invoking the chr_IBMPC1
+; macro that was defined earlier when we INCLUDEd "ibmpc1.inc".
+;
+;  The 1 & 8 parameters define that we want to include the
+; whole IBM-PC font set and not just parts of it.
+;
+;  Right before invoking this macro we define the label
+; TileData. Whenever a label is defined with nothing following
+; it (except possibly a colon) it is given the value of the
+; current ROM location.
+;  As a result, TileData now has a memory location value that
+; is the same as the first byte of the font data that we are
+; including. We shall use the label TileData as a "handle" or
+; "reference" for locating our font data.
+
+TileData:
+        chr_IBMPC1      1,8
+
+;  The NOP and then JP located at $100 in ROM are executed
+; which causes the the following code to be executed next.
+
+begin:
+
+; First, it's a good idea to Disable Interrupts
+; using the following command. We won't be using
+; interrupts in this example so we can leave them off.
+
+        di
+
+;  Next, we should initialize our stack pointer. The
+; stack pointer holds return addresses (among other things)
+; when we use the CALL command so the stack is important to us.
+;
+;  The CALL command is similar to the GOSUB command
+; in the BASIC language and it is similar to executing
+; a procedure in the C & PASCAL languages.
+;
+; We shall set the stack to the top of high ram + 1.
+; (For more information on the Stack Pointer register
+; read the section on Registers.)
+;
+
+        ld      sp,$ffff
+
+;  Next we shall turn the Liquid Crystal Display (LCD)
+; off so that we can copy data to video RAM. We can
+; copy data to video RAM while the LCD is on but it
+; is a little more difficult to do and takes a little
+; bit longer. Video RAM is not always available for
+; reading or writing when the LCD is on so it is
+; easier to write to video RAM with the screen off.
+; ( In future examples, writing to video RAM while the
+; screen is on will be covered.)
+;
+;  To turn off the LCD we do a CALL to the StopLCD
+; subroutine at the bottom of this file. The reason
+; we use a subroutine is because it takes more than
+; just writing to a memory location to turn the
+; LCD display off. The LCD display should be in
+; Vertical Blank (or VBlank) before we turn the display
+; off. Weird effects can occur if you don't wait until
+; VBlank to do this and code written for the Super
+; GameBoy won't work sometimes you try to turn off
+; the LCD outside of VBlank.
+;
+;  The StopLCD routine is terminated by a RET command.
+; The RET command is similar to the RETURN command in
+; BASIC.
+
+        call    StopLCD
+
+;  Here we are going to setup the background tile
+; palette so that the tiles appear in the proper
+; shades of grey.
+;
+;  To do this, we need to write the value $e4 to the
+; memory location $ff47. In the 'gbhw.inc' file we
+; INCLUDEd there is a definition that rBGP=$ff47 so
+; we can use the rGBP label to do this
+;
+;  The first instruction loads the value $e4 into the
+; 8-bit register A and the second instruction writes
+; the value of register A to memory location $ff47.
+
+        ld      a,$e4
+        ld      [rBGP],a        ; Setup the default background palette
+
+;  Here we are setting the X/Y scroll registers
+; for the tile background to 0 so that we can see
+; the upper left corner of the tile background.
+;
+;  Think of the tile background RAM (which we usually call
+; the tile map RAM) as a large canvas. We draw on this
+; 'canvas' using 'paints' which consist of tiles and
+; sprites (we will cover sprites in another example.)
+;
+;  We set the scroll registers to 0 so that we can
+; view the upper left corner of the 'canvas'.
+
+        ld      a,0
+        ld      [rSCX],a
+        ld      [rSCY],a
+
+;  In order to display any text on our 'canvas'
+; we must have tiles which resemble letters that
+; we can use for 'painting'. In order to setup
+; tile memory we will need to copy our font data
+; to tile memory using the routine 'mem_CopyMono'
+; found in the 'memory.asm' library we INCLUDEd
+; earlier.
+;
+;  For the purposes of the 'mem_CopyMono' routine,
+; the 16-bit HL register is used as a source memory
+; location, DE is used as a destination memory location,
+; and BC is used as a data length indicator.
+
+        ld      hl,TileData
+        ld      de,$8000
+        ld      bc,8*256        ; length (8 bytes per tile) x (256 tiles)
+        call    mem_CopyMono    ; Copy tile data to memory
+
+; Next, we clear our 'canvas' to all white by
+; 'setting' the canvas to ascii character $20
+; which is a white space.
+
+        ld      a,$20           ; Clear tile map memory
+        ld      hl,$9800
+        ld      bc,SCRN_VX_B * SCRN_VY_B
+        call    mem_Set
+
+;  We are almost done. Now we need to paint the message
+; " Hello World !" onto our 'canvas'. We do this with
+; one final memory copy routine call.
+;
+;  The routine 'mem_Copy' is a 'true' memory copying routine.
+; The routine 'mem_CopyMono' used above served two functions:
+; One was to unpack the font tile data and the other was
+; to copy this data to tile RAM.
+
+        ld      hl,Title       ; Draw title
+        ld      de,$9800+3+(SCRN_VY_B*7)
+        ld      bc,13
+        call    mem_Copy
+
+; Now we turn on the LCD display to view the results!
+
+        ld      a,LCDCF_ON|LCDCF_BG8000|LCDCF_BG9800|LCDCF_BGON|LCDCF_OBJ16|LCDCF_OBJOFF
+        ld      [rLCDC],a       ; Turn screen on
+
+; Since we have accomplished our goal, we now have nothing
+; else to do. As a result, we just Jump to a label that
+; causes an infinite loop condition to occur.
+
+.wait:
+        jp      .wait
+
+Title:
+        DB      "Hello World !"
+
+
+; *** Turn off the LCD display ***
+
+StopLCD:
+        ld      a,[rLCDC]
+        rlca                    ; Put the high bit of LCDC into the Carry flag
+        ret     nc              ; Screen is off already. Exit.
+
+; Loop until we are in VBlank
+
+.wait:
+        ld      a,[rLY]
+        cp      145             ; Is display on scan line 145 yet?
+        jr      nz,.wait        ; no, keep waiting
+
+; Turn off the LCD
+
+        ld      a,[rLCDC]
+        res     7,a             ; Reset bit 7 of LCDC
+        ld      [rLCDC],a
+
+        ret
+
+
+;* End of File *
+