Welcome to the official Game Pencil user manual
Welcome to the official documentation of the Game Pencil Engine, the simple C++ modular game engine. Here you will learn how to get started with the engine, familiarize yourself with it's design and find more detailed information on it's classes, functions, variables and the editor.
We will do our best here to get you acquainted with the engine and editor as well as the different backends involved with Game Pencil Engine. There will be coverage on all types of classes, functions, variables and structs. If you are still unable to find the exact thing you are looking for please let us know via Github or Discord, so we can best help you.
Please review the table of contents below. Please note, with the engine being modular, we will do our best to include documentation on as many modules as possible which are official module or community created modules that are stable.
- Setting up Game Pencil.
- Coding in Game Pencil
- Community groups
- Contributing code
Backend Modules(Your game requires one below)
- Raylib Modules
- SDL2 Modules
- SFML Modules
- Irrlicht Modules - Not Yet Supported
- OLC::PixelGameEngine Modules - Not Yet Supported
- Comparing backend modules
Front-end modules(These make up the bulk of what Game Pencil Engine does)
- Audio Modules - Coming Soon
- Cursor Modules - Coming Soon
- Font Modules - Coming Soon
- Input Modules - Coming Soon
- Networking Modules - Coming Soon
- Render Modules - Coming Soon
- Scripting Modules - Coming Soon
- Time Modules - Coming Soon
- Vide Playback Modules - Coming Soon
- Window Modules - Coming Soon
- The C++ language - Coming Soon
- The gpe namespace
- Engine Classes - Coming Soon
- Engine Functions - Coming Soon
- Engine Variables - Coming Soon
Creative Commons License
The Game Pencil Engine Documentation is licensed under Creative Commons.
You are free to
- Share — copy and redistribute the material in any medium or format
- Adapt — remix, transform, and build upon the material for any purpose, even commercially.
Under The Following Terms
- Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use
Reporting Issues With Documentation
If while reading this documentation you run into any outdated information, typos, errors or omissions please submit an issue request and include the page URL in your notes.