Main Page

Welcome to the official Platformer Game Engine Wiki!

Here you will find documentation, references and guides related to the Platformer Game Engine. This wiki also contains resources for the LunaLua project by Wohlstand and Kevsoft.

'''We currently have pages and  users who contribute. Feel free to help!'''

PGE Project


Main components
 * Engine
 * Editor

Additional tools
 * Playable Character Calibrator
 * LazyFix tool
 * GIFs2PNG Converter
 * PNG2GIFs Converter
 * PGE Music Player
 * PGE Maintainer

Help & Support
 * Building PGE From sources - detailed manual how to organize, complie and deploy PGE Project from source code for all supported platforms
 * Translating PGE into other languages - explanation how to translate PGE Project components into other language and contribute the translation
 * PGE Editor tutorial - [WIP] Manual of PGE Editor for newbies
 * Frequently Asked Questions
 * Ask your questions here
 * PGE Wishlist - add an idea or suggestion here!

References
 * Game Configuration Pack References - reference for configuration packages for PGE Project
 * Theme packs for the PGE editor - reference for custom theme for PGE Editor
 * Episode structure - How to organize complete playable episode
 * Level structure - How to organize a single level with custom resources

TheXTech


TheXTech - it's a platform game engine written in C++, is a full port of source code of SMBX 1.3 which was originally written in Visual Basic 6. Created by Wohlstand after one month since original SMBX source code was been released for two purposes: providing a free and open-source, cross-platform and accurate implementation of the SMBX Engine to allow playing of old levels and episodes, created for an original game, with the same behavior as the original game had; get a more convenient research model for a PGE Engine development.

Important resources
 * Official TheXTech discussion topic and release downloads
 * Official TheXTech documentation at GitHub

SDL Mixer X
SDL Mixer X - the audio library, a fork from SDL Mixer version 2.0 made by Wohlstand. Used in PGE Project, in LunaLUA, and in SMBX-38a.

SMBX2


Super Mario Bros. X2 (also known as SMBX2, SMBX 2.0) is a collaborative, open-source project to improve and expand upon the original SMBX. SMBX2 was founded by Horikawa Otane.

Official resources
 * Official site for SMBX2 and the mirror
 * SMBX2 Development Blog
 * SMBX2 Handbook (Not available in the China because of Google Docs, the alternative mirror is here).

Help & Support
 * SMBX Forums thread
 * WohlSoft Forums Troubleshooting section

LunaLua


LunaLUA - is an extension made by Kevsoft for the SMBX Game Engine which provides bug-fixes, improvements and the LUA scripting system. The extension is based on LunaDLL v8 SMBX Extension made by Kil. Now it's a core of SMBX2 project.

Help & Support Official support threads on the forums:
 * LunaLua API Page - Official LunaLua Documentation (Note: May contain an outdated information)
 * WohlSoft Forums thread
 * Talkhaus thread
 * SMBX Forums thread
 * LunaLua Wishlist - add your idea or suggestion here!

LunaDLL
 * LunaDLL
 * LunaDLL Autocode - deprecated declarative scripting language, kept for backward compatibility reasons.

SMBX38A TeaScript


TeaScript - is an embedded script language for SMBX38A game. Here you can find a documentation for it.


 * TeaScript API - A documentation for TeaScript language, made by community of SMBX38A project.

Standards and research



 * File and Features standard
 * The SMBX64 Standard is the oldest standard supported by PGE. It has strict limits, and is only partially customizable.
 * The PGE Standard is the default standard of PGE. Based on the SMBX64 standard, it boasts numerous bug fixes and enhanced flexibility over the original.


 * Research
 * SMBX Engine Research

Vanilla SMBX Engine resources
These documents contain information researched against the vanilla Super Mario Bros. X engine and are necessary in order for implementing a level interpreter that supports and is compatible with, a significant amount of existing levels and episodes.


 * SMBX Memory Map
 * Table of the hardcoded default NPC parameters
 * Storage of SMBX64 Specific information and everything