Update engine to 1.0.0

Including a lot of cleanup + bugfixes, more features, and an example program
ISSOtm · Sep 8, 2020 · 069a916 · 069a916
1 parent b5d123d
commit 069a916
Show file tree

Hide file tree

Showing 18 changed files with 2,134 additions and 836 deletions.
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "example/hardware.inc"]
+	path = example/hardware.inc
+	url = git@github.com:gbdev/hardware.inc.git
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Eldred Habert
+Copyright (c) 2018-2020 Eldred Habert
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -1,2 +1,12 @@
 # gb-vwf
-A Variable-Width Font engine for the Game Boy.
+A very powerful Variable-Width Font engine for the Game Boy & Game Boy Color.
+
+For detailed instructions, including installation and usage, please check [the wiki](https://github.com/ISSOtm/gb-vwf/wiki) out.
+
+Bugs can be checked out and reported on [the issue tracker](https://github.com/ISSOtm/gb-vwf/issues), or by bugging me on the GBDev Discord, which you can find [here](https://gbdev.io).
+
+## Licensing
+
+The VWF engine itself is licensed under the MIT license; the example program is public domain, assets included.
+
+According to US law, fonts cannot be copyrighted. You can find some [here](https://github.com/pinobatch/bitmap-fonts/tree/master/vwf).
diff --git a/example/.gitignore b/example/.gitignore
@@ -0,0 +1,10 @@
+*.vwf
+*.2bpp
+*.o
+*.gb
+*.sym
+*.map
+charmap.asm
+*.sn*
+*.sav
+*.srm
diff --git a/example/border_bottom.png b/example/border_bottom.png
diff --git a/example/border_top.png b/example/border_top.png
diff --git a/example/border_vert.png b/example/border_vert.png
diff --git a/example/build.sh b/example/build.sh
@@ -0,0 +1,17 @@
+#!/bin/bash
+
+set -e
+
+for font in fonts/*.png; do
+	python3 ../make_font.py $font ${font%.png}.vwf
+done
+rgbasm -Wall -Wextra -o vwf_config.o vwf_config.asm > charmap.asm
+
+rgbgfx -h -o button.2bpp button.png
+rgbgfx -o border_top.2bpp border_top.png
+rgbgfx -o border_vert.2bpp border_vert.png
+rgbgfx -o border_bottom.2bpp border_bottom.png
+rgbasm -Wall -Wextra -o main.o main.asm
+rgblink -d -n vwf.sym -m vwf.map -o vwf.gb vwf_config.o main.o
+rgbfix -v -p 0xff -m 0x11 vwf.gb
+rm fonts/*.vwf charmap.asm button.2bpp border_top.2bpp border_vert.2bpp border_bottom.2bpp main.o vwf_config.o
diff --git a/example/button.png b/example/button.png
diff --git a/example/fonts/BaseSeven.png b/example/fonts/BaseSeven.png
diff --git a/example/fonts/BaseSevenBold_vx8.png b/example/fonts/BaseSevenBold_vx8.png
diff --git a/example/fonts/optix.png b/example/fonts/optix.png
diff --git a/example/fonts/optixBold.png b/example/fonts/optixBold.png
diff --git a/example/hardware.inc b/example/hardware.inc