Pixel Perfect Projection Plugin
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
Keystone is a tool to help make your game look its best on any monitor! With a variety of options and settings, Keystone allows you or the player to customize the way your game renders for an ideal experience.
- Plug in the desired resolution for your game, and feel confident it will scale and look beautiful on almost any display resolution!
- Control the resolution of your game easily. Want a crunchy, retro pixel aesthetic? Or do you want everything to be as smooth as possible? Either is easy to enable with Keystone!
- With a single setting, enable a bilinear filter that smooths out imperfect scaling while retaining sharp pixel visuals. A process used in games like Sonic Mania!
- Want your game rendered perfectly? Enable the Perfect Scale setting, and your game will be rendered as large as possible on the current display while still only scaling in whole number multiples. You can even draw a custom mat graphic behind it (as seen in the above screenshot)
- If you've ever attempted something like this yourself, you may have noticed that changing where the application surface renders in your game window will break several GM features. Mouse coordinates and the GUI layer will no longer line up with your game. Keystone includes functions to correct for these issues.
- Curious what your game would look like on a 1280 x 720 display, but don't have one handy? What about a vertical display? Plug in the resolution you want to test with and run your game in borderless mode to see exactly how it would render on that display!
- When using Keystone, all gui events draw to a surface. This means you can control the actual pixel resolution more easily for crunchy retro UIs, as well as apply post processing effects like CRT shaders or the included bilinear filter (applied as necessary to the gui surface by default)
Keystone is easy to add to your project.
- Download the YYMPS
- Drag and drop it into your project
- Put an instance of obj_keystone_manager in the first room of your game.
- Customize the Keystone Settings struct in the manager's create event to fit your desired options.
- If necessary, remove any other code you had that was trying to manage your resolution stuff (like the room start event for the camera object from my old GMS2 Camera Tutorial)
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
For more examples, please refer to the Documentation
- Mobile and Web Support
- Downscaling HD Games with SSAA
- Post Processing Effect Examples
- Option to merge App Surface and Gui surface for single pass effect rendering (Such as a CRT shader)
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt for more information.
Jon Peterson (Pixelated Pope) - @pixelatedpope.bsky.social - pixelated_pope@hotmail.com
Project Link: https://github.com/PixelatedPope/Keystone
- Demo uses ImGui_GM by nomiin
- Shaders written by Mytino