MapleShrine
/
mkxp
1
0
Fork 0
Code Issues 32 Pull Requests 11 Projects Releases Wiki Activity

Clarify a couple README points

This commit is contained in:
Jonas Kulla 2013-09-27 19:43:07 +02:00
parent 307eeb732d
commit 080f9333a9
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -5,7 +5,7 @@ mkxp is a project that seeks to provide a fully open source implementation of th
It is licensed under the GNU General Public License v2. It is licensed under the GNU General Public License v2.
## Bindings ## Bindings
Bindings provide the interpreted language environment to run game scripts in. As of right now, they are compiled directly into the executable. Currently there are three bindings: Bindings provide the glue code for an interpreted language environment to run game scripts in. As of right now, they are compiled directly into the executable (however, the scripting language itself might not be). Currently there are three bindings:
### MRI ### MRI
Website: https://www.ruby-lang.org/en/ Website: https://www.ruby-lang.org/en/
@ -48,6 +48,8 @@ To select this backend, run `qmake BINDING=BINDING_NULL`
* zlib (only ruby backends) * zlib (only ruby backends)
(If no version specified, assume latest) (If no version specified, assume latest)
To run mkxp, you should have a graphics card capable of at least **OpenGL 2.0** with an up-to-date driver installed.
### MRI binding: ### MRI binding:
Place a recent version of ruby in the project folder and build it. Place a recent version of ruby in the project folder and build it.
@ -55,8 +57,6 @@ Place a recent version of ruby in the project folder and build it.
### mruby binding: ### mruby binding:
Place a recent version of mruby in the project folder and build it. Place a recent version of mruby in the project folder and build it.
To run mkxp, you should have a graphics card capable of at least **OpenGL 2.0** with an up-to-date driver installed
## Building ## Building
mkxp employs Qt's qmake build system, so you'll need to install that beforehand. After cloning mkxp, run one of the above qmake calls, or simply `qmake` to select the default backend (currently MRI), then `make`. mkxp employs Qt's qmake build system, so you'll need to install that beforehand. After cloning mkxp, run one of the above qmake calls, or simply `qmake` to select the default backend (currently MRI), then `make`.
@ -93,7 +93,10 @@ If a requested font is not found, no error is generated. Instead, a built-in fon
* Audio formats other than ogg/wav (this might change in the future) * Audio formats other than ogg/wav (this might change in the future)
* Audio "pitch" parameter * Audio "pitch" parameter
* The Win32API ruby class (for obvious reasons) * The Win32API ruby class (for obvious reasons)
* Creating Bitmaps with sizes greater than the OpenGL texture size limit (around 8192 on modern cards) * Restarting the game with F12
* Creating Bitmaps with sizes greater than the OpenGL texture size limit (around 8192 on modern cards)*
\* There is an exception to this, called *mega surface*. When a Bitmap bigger than the texture limit is created from a file, it is not stored in VRAM, but regular RAM. It's sole purpose is to be used as a tileset bitmap. Any other operation to it (besides blitting to a regular Bitmap) will result in an error.
## Nonstandard RGSS extensions ## Nonstandard RGSS extensions